az workload-orchestration configuration

Note

このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の workload-orchestration 拡張機能の一部です。 拡張機能は、 az workload-orchestration 構成 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

ワークロード オーケストレーション構成は、構成の管理に役立ちます。

コマンド

名前 説明 状態
az workload-orchestration configuration download

指定した階層エンティティで使用できる構成をダウンロードします。

Extension GA
az workload-orchestration configuration schema

ワークロード オーケストレーション構成は、構成の管理に役立ちます。

Extension GA
az workload-orchestration configuration schema show

構成テンプレートまたはソリューション テンプレートのスキーマ プレースホルダーを表示します。

Extension GA
az workload-orchestration configuration set

指定した階層エンティティで使用できる構成に値を設定します。

Extension GA
az workload-orchestration configuration show

指定した階層エンティティで使用可能な構成を取得します。

Extension GA

az workload-orchestration configuration download

指定した階層エンティティで使用できる構成をダウンロードします。

az workload-orchestration configuration download --hierarchy-id
                                                 --template-name
                                                 --template-rg
                                                 --version
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--template-subscription]

構成のダウンロード

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

ソリューション テンプレートの構成をダウンロードする

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

必須のパラメーター

--hierarchy-id

値をダウンロードする必要があるターゲットまたはサイトの ARM ID。

--template-name -n

ダウンロードするテンプレート (ソリューション テンプレートまたは構成テンプレート) の名前。

--template-rg -g

テンプレートのリソース グループ名。

--version -v

テンプレートのバージョン。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--solution

ソリューションをダウンロードしていることを示すフラグ。 指定されていない場合は、構成テンプレートをダウンロードします。

プロパティ
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--template-subscription

テンプレートのサブスクリプション ID。 テンプレートのサブスクリプション ID が現在のサブスクリプション ID と異なる場合にのみ必要です。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az workload-orchestration configuration set

指定した階層エンティティで使用できる構成に値を設定します。

az workload-orchestration configuration set --hierarchy-id
                                            --template-name
                                            --template-rg
                                            --version
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--file]
                                            [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--template-subscription]

エディターを使用して構成を設定する

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

ファイルを使用して構成を設定する

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0 --file /path/to/config.yaml

ソリューション テンプレートの構成を設定する

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

必須のパラメーター

--hierarchy-id

値を設定する必要があるターゲットまたはサイトの ARM ID。

--template-name -n

構成するテンプレート (ソリューション テンプレートまたは構成テンプレート) の名前。

--template-rg -g

テンプレートのリソース グループ名。

--version -v

テンプレートのバージョン。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--file -f

構成値を含むファイルへのパス。 指定した場合、エディターは開かなくなります。

--solution

ソリューションを構成していることを示すフラグ。 指定しない場合は、構成テンプレートを構成します。

プロパティ
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--template-subscription

テンプレートのサブスクリプション ID。 テンプレートのサブスクリプション ID が現在のサブスクリプション ID と異なる場合にのみ必要です。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az workload-orchestration configuration show

指定した階層エンティティで使用可能な構成を取得します。

az workload-orchestration configuration show --hierarchy-id
                                             --template-name
                                             --template-rg
                                             --version
                                             [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--template-subscription]

構成を表示する

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

ソリューション テンプレートの構成を表示する

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

必須のパラメーター

--hierarchy-id

値を表示する必要があるターゲットまたはサイトの ARM ID。

--template-name -n

表示するテンプレート (ソリューション テンプレートまたは構成テンプレート) の名前。

--template-rg -g

テンプレートのリソース グループ名。

--version -v

テンプレートのバージョン。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--solution

ソリューションを表示していることを示すフラグ。 指定されていない場合は、構成テンプレートが表示されます。

プロパティ
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--template-subscription

テンプレートのサブスクリプション ID。 テンプレートのサブスクリプション ID が現在のサブスクリプション ID と異なる場合にのみ必要です。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False