< Back

Remove-AzureDeployment

Wed Jan 30, 2019 5:50 pm

NAME Remove-AzureDeployment



SYNOPSIS

Deletes a deployment of a cloud service.





SYNTAX

Remove-AzureDeployment [-ServiceName] <String> [-Slot] <String> [[-DeleteVHD]] [[-Force]] [-Profile <AzureSMProfile>] [-InformationAction

<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Remove-AzureDeployment cmdlet deletes a deployment of an Azure cloud service. To delete a deployment, first suspend it.





PARAMETERS

-ServiceName <String>

Specifies the name of the service for which this cmdlet deletes a deployment.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Slot <String>

Specifies the deployment environment from which this cmdlet deletes the deployment. Valid values are: Staging and Production. The default value is

Production.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DeleteVHD [<SwitchParameter>]

Specifies that this cmdlet removes the deployment and the virtual hard disks (VHDs) from blob storage.



Required? false

Position? 2

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? 3

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

ManagementOperationContext







NOTES









-------------------------- Example 1: Remove a deployment --------------------------



PS C:\\>Remove-AzureDeployment -ServiceName "ContosoService"



This command removes the deployment of the Azure service named ContosoService. Because this command does not specify a slot, it removes the service from

the production environment.

-------------------------- Example 2: Remove a deployment and virtual hard disks --------------------------



PS C:\\>Remove-AzureDeployment -ServiceName "ContosoService" -DeleteVHD



This command removes the deployment of the service named ContosoService from the production environment. The command also removes the underlying virtual

hard disks.



RELATED LINKS

Get-AzureDeployment

Get-AzureDeploymentEvent

Remove-AzureDeployment

New-AzureDeployment

Set-AzureDeployment