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

デプロイ名。

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

az deployment tenant delete

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

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

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

az deployment tenant delete -n deployment01

必須のパラメーター

--name -n

デプロイ名。

省略可能のパラメーター

--no-wait

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

az deployment tenant export

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

az deployment tenant export --name

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

az deployment tenant export --name MyDeployment

必須のパラメーター

--name -n

デプロイ名。

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ください。

az deployment tenant show

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

az deployment tenant show --name

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

az deployment tenant show -n deployment01

必須のパラメーター

--name -n

デプロイ名。

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

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

承認された値: false, true
--parameters -p

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

--query-string -q

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

--template-file -f

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

--template-spec -s

テンプレート 仕様のリソース ID。

--template-uri -u

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

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' で更新されるまで待ちます。

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。