az deployment tenant

リファレンス

テナントスコープで Azure Resource Manager テンプレートのデプロイを管理します。

コマンド

az deployment tenant cancel	テナントスコープでのデプロイを取り消します。
az deployment tenant create	テナントスコープでデプロイを開始します。
az deployment tenant delete	テナントスコープでデプロイを削除します。
az deployment tenant export	デプロイに使用されたテンプレートをエクスポートします。
az deployment tenant list	テナントスコープでデプロイを一覧表示します。
az deployment tenant show	テナントスコープでデプロイを表示します。
az deployment tenant validate	テンプレートがテナントスコープで有効かどうかを検証します。
az deployment tenant wait	デプロイ条件が満たされるまで、CLI を待機状態にします。
az deployment tenant what-if	テナントスコープで展開What-If操作を実行します。

az deployment tenant cancel

編集

テナントスコープでのデプロイを取り消します。

az deployment tenant cancel --name

例

テナントスコープでのデプロイを取り消します。

az deployment tenant cancel -n deployment01

必須のパラメーター

--name -n

デプロイ名。

グローバルパラメーター

--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant create

編集

テナントスコープでデプロイを開始します。

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

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

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

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

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

az deployment tenant create --name rollout01 --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

展開時に複数行やコメントを含む拡張テンプレートコンテンツを処理するサポート。

--name -n

デプロイ名。

--no-prompt

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

承認された値: false, true

--no-wait

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

--parameters -p

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

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

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant delete

編集

テナントスコープでデプロイを削除します。

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

例

テナントスコープでデプロイを削除します。

az deployment tenant delete -n deployment01

必須のパラメーター

--name -n

デプロイ名。

省略可能のパラメーター

--no-wait

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

グローバルパラメーター

--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant export

編集

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

az deployment tenant export --name

例

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

az deployment tenant export --name MyDeployment

必須のパラメーター

--name -n

デプロイ名。

グローバルパラメーター

--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant list

編集

テナントスコープでデプロイを一覧表示します。

az deployment tenant list [--filter]

例

テナントスコープでデプロイを一覧表示します。

az deployment tenant 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

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant show

編集

テナントスコープでデプロイを表示します。

az deployment tenant show --name

例

テナントスコープでデプロイを表示します。

az deployment tenant show -n deployment01

必須のパラメーター

--name -n

デプロイ名。

グローバルパラメーター

--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant validate

編集

テンプレートがテナントスコープで有効かどうかを検証します。

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

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

例

テンプレートがテナントスコープで有効かどうかを検証します。

az deployment tenant validate --location WestUS --template-file {template-file}

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

az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

必須のパラメーター

--location -l

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

省略可能のパラメーター

--handle-extended-json-format -j

展開時に複数行やコメントを含む拡張テンプレートコンテンツを処理するサポート。

--name -n

デプロイ名。

--no-prompt

承認された値: false, true

--parameters -p

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

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

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant wait

編集

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

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

例

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

az deployment tenant wait --deleted --name MyDeployment

必須のパラメーター

--name -n

デプロイ名。

省略可能のパラメーター

--created

'provisioningState' を 'Succeeded' で作成するまで待ちます。

--custom

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

--deleted

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

--exists

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

--interval

ポーリング間隔 (秒)。

既定値: 30

--timeout

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

既定値: 3600

--updated

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

グローバルパラメーター

--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant what-if

編集

テナントスコープでデプロイWhat-If操作を実行します。

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

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

ResourceIdOnly 形式のテナントスコープでデプロイWhat-If操作を実行します。

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

結果を整形印刷せずに、テナントスコープでデプロイWhat-If操作を実行します。

az deployment tenant 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

--parameters -p

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

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

出力形式。

--query

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

--subscription

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

--verbose

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

az deployment tenant

コマンド

az deployment tenant cancel

例

必須のパラメーター

az deployment tenant create

例

必須のパラメーター

省略可能のパラメーター

az deployment tenant delete

例

必須のパラメーター

省略可能のパラメーター

az deployment tenant export

例

必須のパラメーター

az deployment tenant list

例

省略可能のパラメーター

az deployment tenant show

例

必須のパラメーター

az deployment tenant validate

例

必須のパラメーター

省略可能のパラメーター

az deployment tenant wait

例

必須のパラメーター

省略可能のパラメーター

az deployment tenant what-if

例

必須のパラメーター

省略可能のパラメーター

フィードバック