Stop-AzDeployment
構文
StopByDeploymentName (既定)
Stop-AzDeployment
[-Name] <String>
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
StopByDeploymentId
Stop-AzDeployment
-Id <String>
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-AzDeployment
-InputObject <PSDeployment>
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Stop-AzDeployment コマンドレットは、開始されたが完了していないサブスクリプション スコープでのデプロイを取り消します。
デプロイを停止するには、プロビジョニングなどの不完全なプロビジョニング状態があり、プロビジョニング済みや失敗などの完了状態ではない必要があります。
サブスクリプション スコープでデプロイを作成するには、New-AzDeployment コマンドレットを使用します。
このコマンドレットは、実行中のデプロイを 1 つだけ停止します。
Name パラメーターを使用して、特定のデプロイを停止します。
例
例 1
Stop-AzDeployment -Name "deployment01"
このコマンドは、現在のサブスクリプション スコープで実行中のデプロイ "deployment01" を取り消します。
例 2
Get-AzDeployment -Name "deployment01" | Stop-AzDeployment
このコマンドは、現在のサブスクリプション スコープでデプロイ "deployment01" を取得し、取り消します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
デプロイの完全修飾リソース ID。
例: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName}
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | DeploymentId, リソースID |
パラメーター セット
StopByDeploymentId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
デプロイ オブジェクト。
StopByInputObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
デプロイの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | デプロイメント名 |
パラメーター セット
StopByDeploymentName
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
{{Fill PassThru Description}}
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Pre
設定すると、使用するバージョンを自動的に決定するときに、コマンドレットでプレリリース API バージョンを使用する必要があることを示します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
