Stop-AzureRmResourceGroupDeployment
リソース グループのデプロイを取り消します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Stop-AzureRmResourceGroupDeployment
[-ResourceGroupName] <String>
[-Name] <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-AzureRmResourceGroupDeployment
-Id <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Stop-AzureRmResourceGroupDeployment コマンドレットは、開始されたが完了していない Azure リソース グループのデプロイを取り消します。 デプロイを停止するには、プロビジョニングなどの不完全なプロビジョニング状態があり、プロビジョニング済みや失敗などの完了状態ではない必要があります。 Azure リソースは、Web サイト、データベース、データベース サーバーなどのユーザー管理エンティティです。 リソース グループは、ユニットとしてデプロイされるリソースのコレクションです。 リソース グループをデプロイするには、New-AzureRmResourceGroupDeployment コマンドレットを使用します。 New-AzureRmResource コマンドレットは新しいリソースを作成しますが、このコマンドレットが停止できるリソース グループのデプロイ操作はトリガーされません。 このコマンドレットは、実行中のデプロイを 1 つだけ停止します。 Name パラメーターを使用して、特定のデプロイを停止します。 Name パラメーターを省略すると、Stop-AzureRmResourceGroupDeployment は実行中のデプロイを検索して停止します。 コマンドレットで複数の実行中のデプロイが見つかると、コマンドは失敗します。
例
例 1: リソース グループのデプロイの開始と停止
PS C:\> New-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azuredeploy.json -TemplateParameterFile .\storage-account-create-azuredeploy.parameters.json -AsJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Long Running... AzureLongRun... Running True localhost New-AzureRmResourceGro...
PS C:\> Stop-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg
True
PS C:\> Get-Job 1
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Long Running... AzureLongRun... Failed True localhost New-AzureRmResourceGro...
パラメーター
-ApiVersion
リソース プロバイダーでサポートされている API バージョンを指定します。 既定のバージョンとは異なるバージョンを指定できます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
停止するリソース グループデプロイの ID を指定します。
型: | String |
Aliases: | DeploymentId, ResourceId |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
停止するリソース グループのデプロイの名前を指定します。 このパラメーターを指定しない場合、このコマンドレットはリソース グループ内の実行中のデプロイを検索して停止します。 実行中のデプロイが複数見つかると、コマンドは失敗します。 デプロイ名を取得するには、Get-AzureRmResourceGroupDeployment コマンドレットを使用します。
型: | String |
Aliases: | DeploymentName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループの名前を指定します。 このコマンドレットは、このパラメーターが指定するリソース グループのデプロイを停止します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None