Stop-AzResourceGroupDeployment
構文
StopByResourceGroupDeploymentName (既定)
Stop-AzResourceGroupDeployment
[-ResourceGroupName] <String>
[-Name] <String>
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
StopByResourceGroupDeploymentId
Stop-AzResourceGroupDeployment
-Id <String>
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Stop-AzResourceGroupDeployment コマンドレットは、開始されたが完了していない Azure リソース グループのデプロイを取り消します。
デプロイを停止するには、プロビジョニングなどの不完全なプロビジョニング状態があり、プロビジョニング済みや失敗などの完了状態ではない必要があります。
Azure リソースは、Web サイト、データベース、データベース サーバーなどのユーザー管理エンティティです。
リソース グループは、ユニットとしてデプロイされるリソースのコレクションです。
リソース グループをデプロイするには、New-AzResourceGroupDeployment コマンドレットを使用します。
New-AzResource コマンドレットは新しいリソースを作成しますが、このコマンドレットが停止できるリソース グループのデプロイ操作はトリガーされません。
このコマンドレットは、実行中のデプロイを 1 つだけ停止します。
Name パラメーターを使用して、特定のデプロイを停止します。
Name パラメーターを省略すると、Stop-AzResourceGroupDeployment は実行中のデプロイを検索して停止します。
コマンドレットで複数の実行中のデプロイが見つかると、コマンドは失敗します。
例
例 1: リソース グループのデプロイの開始と停止
New-AzResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azdeploy.json -TemplateParameterFile .\storage-account-create-azdeploy.parameters.json -AsJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Long Running... AzureLongRun... Running True localhost New-AzResourceGro...
Stop-AzResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg
True
Get-Job 1
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Long Running... AzureLongRun... Failed True localhost New-AzResourceGro...
パラメーター
-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 を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | DeploymentId, リソースID |
パラメーター セット
StopByResourceGroupDeploymentId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
停止するリソース グループのデプロイの名前を指定します。
このパラメーターを指定しない場合、このコマンドレットはリソース グループ内の実行中のデプロイを検索して停止します。
実行中のデプロイが複数見つかると、コマンドは失敗します。
デプロイ名を取得するには、Get-AzResourceGroupDeployment コマンドレットを使用します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | デプロイメント名 |
パラメーター セット
StopByResourceGroupDeploymentName
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前を指定します。
このコマンドレットは、このパラメーターが指定するリソース グループのデプロイを停止します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
StopByResourceGroupDeploymentName
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | 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を参照してください。
出力
