Stop-AzTenantDeployment

Cancel a running deployment at tenant scope

Syntax

Stop-AzTenantDeployment
    [-Name] <String>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzTenantDeployment
    -Id <String>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzTenantDeployment
    -InputObject <PSDeployment>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzTenantDeployment cmdlet cancels a deployment that has started but not completed at the current tenant scope. To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed.

To create a deployment at tenant scope, use the New-AzTenantDeployment cmdlet.

Examples

Example 1

PS C:\>Stop-AzTenantDeployment -Name "deployment01"

This command cancels a running deployment "deployment01" at the current tenant scope.

Example 2

PS C:\>Get-AzTenantDeployment -Name "deployment01" | Stop-AzTenantDeployment

This command gets the deployment "deployment01" at the current tenant scope and cancels 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
-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:AzContext, 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: /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

Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment

Outputs

Boolean