Remove-AzDeployment
Removes a deployment and any associated operations
Syntax
RemoveByDeploymentName (Default)
Remove-AzDeployment
[-Name] <String>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RemoveByDeploymentId
Remove-AzDeployment
-Id <String>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzDeployment
-InputObject <PSDeployment>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzDeployment cmdlet removes an Azure deployment at subscription scope and any associated operations.
Examples
Example 1: Remove a deployment with a given name
Remove-AzDeployment -Name "RolesDeployment"
This command removes the deployment "RolesDeployment" at the current subscription scope.
Example 2: Get a deployment and remove it
Get-AzDeployment -Name "RolesDeployment" | Remove-AzDeployment
This command gets the deployment "RolesDeployment" at the current subscription scope and removes it.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Id
The fully qualified resource Id of the deployment.
example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: DeploymentId, ResourceId
Parameter sets
RemoveByDeploymentId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The deployment object.
Type: PSDeployment
Default value: None Supports wildcards: False DontShow: False
RemoveByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the deployment.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: DeploymentName
Parameter sets
RemoveByDeploymentName
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
{{Fill PassThru Description}}
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Pre
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
