Stop-AzTenantDeployment

  • 參考
模組:
Az.Resources

在租用戶範圍取消執行中的部署

Syntax

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

Description

Stop-AzTenantDeployment Cmdlet 會取消已在目前租用戶範圍啟動但尚未完成的部署。 若要停止部署，部署必須具有不完整的布建狀態，例如布建，而不是已完成的狀態，例如已布建或失敗。

若要在租用戶範圍建立部署，請使用 New-AzTenantDeployment Cmdlet。

範例

範例 1

Stop-AzTenantDeployment -Name "deployment01"

此命令會取消目前租使用者範圍的執行中部署 「deployment01」。。

範例 2

Get-AzTenantDeployment -Name "deployment01" | Stop-AzTenantDeployment

此命令會取得目前租用戶範圍的部署 「deployment01」，並取消部署。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

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

-Id

部署的完整資源標識碼。 範例：/providers/Microsoft.Resources/deployments/{deploymentName}

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

-InputObject

部署物件。

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

-Name

部署的名稱。

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

-PassThru

{{ Fill PassThru Description }}

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

-Pre

設定時，表示 Cmdlet 在自動判斷要使用的版本時，應該使用發行前版本 API 版本。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

PSDeployment

輸出

Boolean