az deployment

サブスクリプション スコープで Azure Resource Manager テンプレートのデプロイを管理します。

コマンド

名前	説明	型	状態
az deployment cancel	サブスクリプション スコープでデプロイを取り消します。	コア	非推奨
az deployment create	サブスクリプション スコープでデプロイを開始します。	コア	非推奨
az deployment delete	サブスクリプション スコープでデプロイを削除します。	コア	非推奨
az deployment export	デプロイに使用されたテンプレートをエクスポートします。	コア	非推奨
az deployment group	リソース グループで Azure Resource Manager テンプレートのデプロイを管理します。	コア	GA
az deployment group cancel	リソース グループでのデプロイを取り消します。	コア	GA
az deployment group create	リソース グループでデプロイを開始します。	コア	GA
az deployment group delete	リソース グループでデプロイを削除します。	コア	GA
az deployment group export	デプロイに使用されたテンプレートをエクスポートします。	コア	GA
az deployment group list	リソース グループでのデプロイを一覧表示します。	コア	GA
az deployment group show	リソース グループでのデプロイを表示します。	コア	GA
az deployment group validate	リソース グループでテンプレートが有効かどうかを検証します。	コア	GA
az deployment group wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	GA
az deployment group what-if	リソース グループ スコープでデプロイの What-If 操作を実行します。	コア	GA
az deployment list	サブスクリプション スコープでデプロイを一覧表示します。	コア	非推奨
az deployment mg	管理グループで Azure Resource Manager テンプレートのデプロイを管理します。	コア	GA
az deployment mg cancel	管理グループでのデプロイを取り消します。	コア	GA
az deployment mg create	管理グループでデプロイを開始します。	コア	GA
az deployment mg delete	管理グループでのデプロイを削除します。	コア	GA
az deployment mg export	デプロイに使用されたテンプレートをエクスポートします。	コア	GA
az deployment mg list	管理グループでのデプロイを一覧表示します。	コア	GA
az deployment mg show	管理グループでのデプロイを表示します。	コア	GA
az deployment mg validate	テンプレートが管理グループで有効かどうかを検証します。	コア	GA
az deployment mg wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	GA
az deployment mg what-if	管理グループ スコープでデプロイの What-If 操作を実行します。	コア	GA
az deployment operation	サブスクリプション スコープでデプロイ操作を管理します。	コア	GA
az deployment operation group	リソース グループでのデプロイ操作を管理します。	コア	GA
az deployment operation group list	リソース グループでのデプロイ操作を一覧表示します。	コア	GA
az deployment operation group show	リソース グループでデプロイ操作を表示します。	コア	GA
az deployment operation list	サブスクリプション スコープでのデプロイ操作を一覧表示します。	コア	非推奨
az deployment operation mg	管理グループで展開操作を管理します。	コア	GA
az deployment operation mg list	管理グループでの展開操作を一覧表示します。	コア	GA
az deployment operation mg show	管理グループでの展開操作を表示します。	コア	GA
az deployment operation show	サブスクリプション スコープでデプロイ操作を表示します。	コア	非推奨
az deployment operation sub	サブスクリプション スコープでデプロイ操作を管理します。	コア	GA
az deployment operation sub list	サブスクリプション スコープでのデプロイ操作を一覧表示します。	コア	GA
az deployment operation sub show	サブスクリプション スコープでデプロイ操作を表示します。	コア	GA
az deployment operation tenant	テナント スコープでデプロイ操作を管理します。	コア	GA
az deployment operation tenant list	テナント スコープでのデプロイ操作を一覧表示します。	コア	GA
az deployment operation tenant show	テナント スコープでデプロイ操作を表示します。	コア	GA
az deployment show	サブスクリプション スコープでデプロイを表示します。	コア	非推奨
az deployment sub	サブスクリプション スコープで Azure Resource Manager テンプレートのデプロイを管理します。	コア	GA
az deployment sub cancel	サブスクリプション スコープでデプロイを取り消します。	コア	GA
az deployment sub create	サブスクリプション スコープでデプロイを開始します。	コア	GA
az deployment sub delete	サブスクリプション スコープでデプロイを削除します。	コア	GA
az deployment sub export	デプロイに使用されたテンプレートをエクスポートします。	コア	GA
az deployment sub list	サブスクリプション スコープでデプロイを一覧表示します。	コア	GA
az deployment sub show	サブスクリプション スコープでデプロイを表示します。	コア	GA
az deployment sub validate	テンプレートがサブスクリプション スコープで有効かどうかを検証します。	コア	GA
az deployment sub wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	GA
az deployment sub what-if	サブスクリプション スコープでデプロイの What-If 操作を実行します。	コア	GA
az deployment tenant	テナント スコープで Azure Resource Manager テンプレートのデプロイを管理します。	コア	GA
az deployment tenant cancel	テナント スコープでデプロイを取り消します。	コア	GA
az deployment tenant create	テナント スコープでデプロイを開始します。	コア	GA
az deployment tenant delete	テナント スコープでデプロイを削除します。	コア	GA
az deployment tenant export	デプロイに使用されたテンプレートをエクスポートします。	コア	GA
az deployment tenant list	テナント スコープでデプロイを一覧表示します。	コア	GA
az deployment tenant show	テナント スコープでデプロイを表示します。	コア	GA
az deployment tenant validate	テンプレートがテナント スコープで有効かどうかを検証します。	コア	GA
az deployment tenant wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	GA
az deployment tenant what-if	テナント スコープでデプロイの What-If 操作を実行します。	コア	GA
az deployment validate	テンプレートがサブスクリプション スコープで有効かどうかを検証します。	コア	非推奨
az deployment wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	非推奨

az deployment cancel

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub cancel' を使用してください。

サブスクリプション スコープでデプロイを取り消します。

az deployment cancel --name

例

サブスクリプション スコープでデプロイを取り消します。

az deployment cancel -n deployment01

必須のパラメーター

--name -n

デプロイ名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment create

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub create' を使用してください。

サブスクリプション スコープでデプロイを開始します。

--template-file FILE の 1 つだけを指定してください |--template-uri URI |--template-spec を使用して ARM テンプレートを入力します。

az deployment create --location
                     [--confirm-with-what-if]
                     [--handle-extended-json-format]
                     [--name]
                     [--no-prompt {false, true}]
                     [--no-wait]
                     [--parameters]
                     [--proceed-if-no-change]
                     [--query-string]
                     [--template-file]
                     [--template-spec]
                     [--template-uri]
                     [--what-if]
                     [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                     [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

例

ローカル JSON ファイルのパラメーターを使用して、リモート テンプレート ファイルからサブスクリプション スコープでデプロイを作成します。

az deployment create --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

JSON 文字列のパラメーターを使用して、ローカル テンプレート ファイルからサブスクリプション スコープでデプロイを作成します。

az deployment create --location WestUS --template-file azuredeploy.json  \
    --parameters "{ \"policyName\": { \"value\": \"policy2\" }}"

パラメーター ファイル、リモート パラメーター ファイル、およびキーと値のペアを選択的にオーバーライドして、ローカル テンプレートからサブスクリプション スコープでデプロイを作成します。

az deployment create --location WestUS --template-file azuredeploy.json  \
    --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

テンプレート スペックからサブスクリプション スコープでデプロイを作成する

az deployment create --location WestUS --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

必須のパラメーター

--location -l

デプロイ メタデータを格納する場所。

省略可能のパラメーター

--confirm-with-what-if -c

デプロイを実行する前に、デプロイ What-If を実行するようにコマンドに指示します。 続ける前に、リソースの変更を確認するように求められます。

--handle-extended-json-format -j

非推奨

オプション '--handle-extended-json-format/-j' は非推奨となり、今後のリリースで削除される予定です。

デプロイでの複数行やコメントを含む拡張テンプレート コンテンツの処理をサポートします。

--name -n

デプロイ名。

--no-prompt

ARM テンプレートの不足しているパラメーターのプロンプトを無効にするオプション。 値が true の場合、不足しているパラメーターを指定するようユーザーに求めるプロンプトは無視されます。 既定値は false です。

指定可能な値: false, true

規定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--parameters -p

デプロイ パラメーターの値を指定します。

パラメーターは、構文、JSON 文字列、または KEY=VALUE> のペアとして<、ファイル@{path}から指定できます。 パラメーターは順番に評価されるため、値が 2 回割り当てられると、後者の値が使用されます。 最初にパラメーター ファイルを指定してから、KEY=VALUE 構文を使用して選択的にオーバーライドすることをお勧めします。

--proceed-if-no-change

What-If の結果にリソースの変更が含まれている場合は、デプロイを実行するようにコマンドに指示します。 --confirm-with-what-if が設定されている場合に適用されます。

--query-string -q

リンクされたテンプレートの場合に template-uri と共に使用されるクエリ文字列 (SAS トークン)。

--template-file -f

テンプレート ファイルまたは Bicep ファイルへのパス。

--template-spec -s

テンプレート スペックのリソース ID。

--template-uri -u

テンプレート ファイルへの URI。

--what-if -w

デプロイ What-If を実行するようにコマンドに指示します。

--what-if-exclude-change-types -x

What-If の結果から除外するリソース変更の種類のスペース区切りの一覧。 --confirm-with-what-if が設定されている場合に適用されます。

指定可能な値: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported

--what-if-result-format -r

What-If の結果の形式。 設定されている場合 --confirm-with-what-if に適用されます。

指定可能な値: FullResourcePayloads, ResourceIdOnly

規定値: FullResourcePayloads

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment delete

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub delete' を使用してください。

サブスクリプション スコープでデプロイを削除します。

az deployment delete --name
                     [--no-wait]

例

サブスクリプション スコープでデプロイを削除します。

az deployment delete -n deployment01

必須のパラメーター

--name -n

デプロイ名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment export

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub export' を使用してください。

デプロイに使用されたテンプレートをエクスポートします。

az deployment export --name

例

サブスクリプション スコープでのデプロイに使用されるテンプレートをエクスポートします。

az deployment export --name MyDeployment

必須のパラメーター

--name -n

デプロイ名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment list

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub list' を使用してください。

サブスクリプション スコープでデプロイを一覧表示します。

az deployment list [--filter]

例

サブスクリプション スコープでデプロイを一覧表示します。

az deployment list

省略可能のパラメーター

--filter

プレビュー

OData 表記を使用して式をフィルター処理します。 --filter "provisioningState eq '{state}'" を使用して provisioningState をフィルター処理できます。 詳細については、以下をご覧 https://docs.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parametersください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment show

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub show' を使用してください。

サブスクリプション スコープでデプロイを表示します。

az deployment show --name

例

サブスクリプション スコープでデプロイを表示します。

az deployment show -n deployment01

必須のパラメーター

--name -n

デプロイ名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment validate

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub validate' を使用してください。

テンプレートがサブスクリプション スコープで有効かどうかを検証します。

--template-file FILE の 1 つだけを指定してください |--template-uri URI |--template-spec を使用して ARM テンプレートを入力します。

az deployment validate --location
                       [--handle-extended-json-format]
                       [--name]
                       [--no-prompt {false, true}]
                       [--parameters]
                       [--query-string]
                       [--template-file]
                       [--template-spec]
                       [--template-uri]

例

テンプレートがサブスクリプション スコープで有効かどうかを検証します。

az deployment validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json

必須のパラメーター

--location -l

デプロイ メタデータを格納する場所。

省略可能のパラメーター

--handle-extended-json-format -j

非推奨

オプション '--handle-extended-json-format/-j' は非推奨となり、今後のリリースで削除される予定です。

デプロイでの複数行やコメントを含む拡張テンプレート コンテンツの処理をサポートします。

--name -n

デプロイ名。

--no-prompt

ARM テンプレートの不足しているパラメーターのプロンプトを無効にするオプション。 値が true の場合、不足しているパラメーターを指定するようユーザーに求めるプロンプトは無視されます。 既定値は false です。

指定可能な値: false, true

規定値: False

--parameters -p

デプロイ パラメーターの値を指定します。

パラメーターは、構文、JSON 文字列、または KEY=VALUE> のペアとして<、ファイル@{path}から指定できます。 パラメーターは順番に評価されるため、値が 2 回割り当てられると、後者の値が使用されます。 最初にパラメーター ファイルを指定してから、KEY=VALUE 構文を使用して選択的にオーバーライドすることをお勧めします。

--query-string -q

リンクされたテンプレートの場合に template-uri と共に使用されるクエリ文字列 (SAS トークン)。

--template-file -f

テンプレート ファイルまたは Bicep ファイルへのパス。

--template-spec -s

テンプレート スペックのリソース ID。

--template-uri -u

テンプレート ファイルへの URI。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az deployment wait

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'deployment sub wait' を使用してください。

デプロイ条件が満たされるまで、CLI を待機状態にします。

az deployment wait --name
                   [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--interval]
                   [--timeout]
                   [--updated]

例

デプロイ条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az deployment wait --deleted --name MyDeployment --subscription MySubscription

必須のパラメーター

--name -n

デプロイ名。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。