Remove-AzureRmDeployment

Removes a deployment and any associated operations

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Remove-AzureRmDeployment
      [-Name] <String>
      [-AsJob]
      [-PassThru]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmDeployment
      -Id <String>
      [-AsJob]
      [-PassThru]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmDeployment
      -InputObject <PSDeployment>
      [-AsJob]
      [-PassThru]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureRmDeployment cmdlet removes an Azure deployment at subscription scope and any associated operations.

Examples

Example 1: Remove a deployment with a given name

PS C:\>Remove-AzureRmDeployment -Name "RolesDeployment"

This command removes the deployment "RolesDeployment" at the current subscription scope.

Example 2: Get a deployment and remove it

PS C:\>Get-AzureRmDeployment -Name "RolesDeployment" | Remove-AzureRmDeployment

This command gets the deployment "RolesDeployment" at the current subscription scope and removes it.

Parameters

-ApiVersion

When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Id

The fully qualified resource Id of the deployment. example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName}

Type:String
Aliases:DeploymentId, ResourceId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

The deployment object.

Type:PSDeployment
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

The name of the deployment.

Type:String
Aliases:DeploymentName
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

{{Fill PassThru Description}}

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Pre

When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

Boolean