Stop-AzureRmDeployment

  • リファレンス
モジュール:
AzureRM.Resources

実行中のデプロイを Cancal する

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Stop-AzureRmDeployment
    [-Name] <String>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureRmDeployment
    -Id <String>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureRmDeployment
    -InputObject <PSDeployment>
    [-PassThru]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Stop-AzureRmDeployment コマンドレットは、開始されたが完了していないサブスクリプション スコープでのデプロイを取り消します。 デプロイを停止するには、プロビジョニングなどの不完全なプロビジョニング状態があり、プロビジョニング済みや失敗などの完了状態ではない必要があります。

サブスクリプション スコープでデプロイを作成するには、New-AzureRmDeployment コマンドレットを使用します。

このコマンドレットは、実行中のデプロイを 1 つだけ停止します。 Name パラメーターを使用して、特定のデプロイを停止します。

例

例 1

PS C:\>Stop-AzureRmDeployment -Name "deployment01"

このコマンドは、現在のサブスクリプション スコープで実行中のデプロイ "deployment01" を取り消します。

例 2

PS C:\>Get-AzureRmDeployment -Name "deployment01" | Stop-AzureRmDeployment

このコマンドは、現在のサブスクリプション スコープでデプロイ "deployment01" を取得し、取り消します。

パラメーター

-ApiVersion

設定すると、使用するリソース プロバイダー API のバージョンを示します。 指定しない場合、API のバージョンは、使用可能な最新のバージョンとして自動的に決定されます。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Id

デプロイの完全修飾リソース ID。 例: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName}

型:String
Aliases:DeploymentId, ResourceId
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

デプロイ オブジェクト。

型:PSDeployment
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

展開の名前。

型:String
Aliases:DeploymentName
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PassThru

{{Fill PassThru Description}}

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Pre

設定すると、使用するバージョンを自動的に決定するときに、コマンドレットでプレリリース API バージョンを使用する必要があることを示します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

出力

Boolean