Stop-AzureRmResourceGroupDeployment

リファレンス

モジュール:: AzureRM.Resources

リソースグループのデプロイを取り消します。

警告

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 バージョンを指定します。既定のバージョンとは異なるバージョンを指定できます。

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

-Confirm

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

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

-DefaultProfile

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

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

-Id

停止するリソースグループデプロイの ID を指定します。

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

-Name

停止するリソースグループのデプロイの名前を指定します。このパラメーターを指定しない場合、このコマンドレットはリソースグループ内の実行中のデプロイを検索して停止します。実行中のデプロイが複数見つかると、コマンドは失敗します。デプロイ名を取得するには、Get-AzureRmResourceGroupDeployment コマンドレットを使用します。

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

-Pre

このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。

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

-ResourceGroupName

リソースグループの名前を指定します。このコマンドレットは、このパラメーターが指定するリソースグループのデプロイを停止します。

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

-WhatIf

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

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

入力

None

出力

Boolean