Stop-AzTenantDeployment
Cancel a running deployment at tenant scope.
Syntax
Default (Default)
Stop-AzTenantDeployment
[-Name] <string>
[-Profile <string>]
[<CommonParameters>]
Aliases
This cmdlet has no aliases.
Description
Cancels a tenant deployment whose provisioning state is Accepted or Running. Resources the
deployment already created are left in place. Azure Resource Manager rejects the request, and
the cmdlet raises an error, when the deployment is no longer running.
Examples
Cancel a running deployment
Stop-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 cancel request directly and reports the service error when the deployment is not running, instead of checking its state first. -Id, -InputObject, -PassThru, -WhatIf, -Confirm, and -Pre are not supported.