Edit

Remove-AzTenantDeployment

Delete a deployment from the tenant deployment history.

Syntax

Default (Default)

Remove-AzTenantDeployment
    [-Name] <string>
    [-Profile <string>]
    [<CommonParameters>]

Aliases

This cmdlet has no aliases.

Description

Deletes a deployment and its deployment operations from the tenant deployment history and waits for the deletion to finish. Resources the deployment created are not deleted. A deployment that is still running cannot be deleted.

Examples

Delete a deployment

Remove-AzTenantDeployment -Name tenant-infra

Parameters

-Name

The name of the deployment.

Parameter properties

Type:String
Supports wildcards:False
DontShow:False
Aliases:DeploymentName

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Name of a saved profile to use for this call instead of the currently-active one. Manage profiles with Set-AzProfile / Get-AzProfile.

Parameter properties

Type:String
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

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.

Inputs

None

This cmdlet does not accept pipeline input.

Outputs

Void

This cmdlet produces no output.

Notes

Differences from Az.Resources: the cmdlet sends the delete request directly instead of checking first that the deployment exists. -Id, -InputObject, -PassThru, -AsJob, -WhatIf, -Confirm, and -Pre are not supported.