次の方法で共有


az deployment sub

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

コマンド

名前 説明 状態
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 sub cancel

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

az deployment sub cancel --name

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

az deployment sub 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 sub create

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

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

az deployment sub 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 sub create --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

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

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

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

必須のパラメーター

--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 sub delete

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

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

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

az deployment sub 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 sub export

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

az deployment sub export --name

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

az deployment sub 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 sub list

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

az deployment sub list [--filter]

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

az deployment sub 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 sub show

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

az deployment sub show --name

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

az deployment sub 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 sub validate

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

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

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

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

az deployment sub validate --location westus2 --template-file {template-file}

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

az deployment sub 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 sub wait

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

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

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

az deployment sub wait --created --name MyDeployment

必須のパラメーター

--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 を使います。

az deployment sub what-if

サブスクリプション スコープでデプロイの What-If 操作を実行します。

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

az deployment sub what-if --location
                          [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                          [--name]
                          [--no-pretty-print]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--query-string]
                          [--result-format {FullResourcePayloads, ResourceIdOnly}]
                          [--template-file]
                          [--template-spec]
                          [--template-uri]

サブスクリプションでデプロイの What-If 操作を実行します。

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

ResourceIdOnly 形式のサブスクリプションでデプロイ What-If 操作を実行します。

az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

結果を整形印刷せずに、サブスクリプションでデプロイの What-If 操作を実行します。

az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

必須のパラメーター

--location -l

デプロイの What-If 操作メタデータを格納する場所。

省略可能のパラメーター

--exclude-change-types -x

What-If の結果から除外するリソース変更の種類のスペース区切りの一覧。

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

デプロイ名。

--no-pretty-print

What-If の結果に対してプリプリントを無効にします。 設定すると、出力形式の種類が使用されます。

--no-prompt

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

指定可能な値: false, true
規定値: False
--parameters -p

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

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

--query-string -q

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

--result-format -r

What-If の結果の形式。

指定可能な値: FullResourcePayloads, ResourceIdOnly
規定値: FullResourcePayloads
--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 を使います。