Stop-AzResourceGroupDeployment

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

構文

Stop-AzResourceGroupDeployment
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
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

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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, 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-AzResourceGroupDeployment コマンドレットを使用します。

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

入力

String

出力

Boolean