Stop-AzTenantDeployment

モジュール:

Az.Resources

テナント スコープで実行中のデプロイを取り消す

構文

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>]

説明

Stop-AzTenantDeployment コマンドレットは、現在のテナント スコープで開始されたが完了していないデプロイを取り消します。 デプロイを停止するには、プロビジョニングなどの不完全なプロビジョニング状態があり、プロビジョニング済みや失敗などの完了状態ではない必要があります。

テナント スコープでデプロイを作成するには、New-AzTenantDeployment コマンドレットを使用します。

例

例 1

Stop-AzTenantDeployment -Name "deployment01"

このコマンドは、現在のテナント スコープで実行中のデプロイ "deployment01" を取り消します。

例 2

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

このコマンドは、現在のテナント スコープでデプロイ "deployment01" を取得し、取り消します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Id

デプロイの完全修飾リソース ID。 例: /providers/Microsoft.Resources/deployments/{deploymentName}

型:	String
Aliases:	DeploymentId, ResourceId
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

デプロイ オブジェクト。

型:	PSDeployment
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

展開の名前。

型:	String
Aliases:	DeploymentName
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

{{ Fill PassThru Description }}

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Pre

設定すると、使用するバージョンを自動的に決定するときに、コマンドレットでプレリリース API バージョンを使用する必要があることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSDeployment

出力

Boolean