az stack-hci arc-setting

Note

このリファレンスは、Azure CLI (バージョン 2.54.0 以降) の stack-hci 拡張機能の一部です。 拡張機能は、az stack-hci arc-setting コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

スタック hci を使用して円弧の設定を管理します。

コマンド

名前	説明	型	Status
az stack-hci arc-setting consent-and-install-default-extension	既定の拡張機能の同意時間を追加し、拡張機能のインストールを開始します。	拡張子	GA
az stack-hci arc-setting create	HCI クラスターの円弧設定を作成します。	拡張子	GA
az stack-hci arc-setting create-identity	円弧設定の AAD ID を作成します。	拡張子	GA
az stack-hci arc-setting delete	HCI クラスターの arc 設定リソースの詳細を削除します。	拡張子	GA
az stack-hci arc-setting generate-password	アーク設定のパスワードを生成します。	拡張子	GA
az stack-hci arc-setting initialize-disable-proces	クラスターで ARC 無効化プロセスを初期化します。	拡張子	GA
az stack-hci arc-setting list	HCI クラスターのアーク設定リソースを一覧表示します。	拡張子	GA
az stack-hci arc-setting show	HCI クラスターの Arc 設定リソースの詳細を取得します。	拡張子	GA
az stack-hci arc-setting update	HCI クラスターのアーク設定を更新します。	拡張子	GA
az stack-hci arc-setting wait	条件が満たされるまで CLI を待機状態にします。	拡張子	GA

az stack-hci arc-setting consent-and-install-default-extension

既定の拡張機能の同意時間を追加し、拡張機能のインストールを開始します。

az stack-hci arc-setting consent-and-install-default-extension [--arc-setting-name]
                                                               [--cluster-name]
                                                               [--ids]
                                                               [--resource-group]
                                                               [--subscription]

例

同意して既定の拡張機能をインストールする

az stack-hci arc-setting consent-and-install-default-extension -g rg --arc-setting-name default --cluster-name name

省略可能のパラメーター

--arc-setting-name

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting create

HCI クラスターの円弧設定を作成します。

az stack-hci arc-setting create --arc-setting-name
                                --cluster-name
                                --resource-group
                                [--arc-application-client-id]
                                [--arc-application-object-id]
                                [--arc-application-tenant-id]
                                [--arc-instance-rg]
                                [--arc-service-principal-object-id]
                                [--connectivity-properties]

例

円弧の設定を作成する

az stack-hci arc-setting create --name "default" --cluster-name "myCluster" --resource-group "test-rg"

必須のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--arc-application-client-id

Arc AAD ID のアプリ ID。

--arc-application-object-id

Arc AAD ID のオブジェクト ID。

--arc-application-tenant-id

Arc AAD ID のテナント ID。

--arc-instance-rg

Arc エージェントをホストするリソース グループ。つまり、 ハイブリッド コンピューティング マシン リソース。

--arc-service-principal-object-id

Arc AAD サービス プリンシパルのオブジェクト ID。

--connectivity-properties

ARC リソースの接続関連の構成が含まれています。短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--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 stack-hci arc-setting create-identity

円弧設定の AAD ID を作成します。

az stack-hci arc-setting create-identity [--arc-setting-name]
                                         [--cluster-name]
                                         [--ids]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]

例

円弧 ID を作成する

az stack-hci arc-setting create-identity --name "default" --cluster-name "myCluster" --resource-group "test-rg"

省略可能のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting delete

HCI クラスターの arc 設定リソースの詳細を削除します。

az stack-hci arc-setting delete [--arc-setting-name]
                                [--cluster-name]
                                [--ids]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]
                                [--yes]

例

円弧の設定を削除する

az stack-hci arc-setting delete --name "default" --cluster-name "myCluster" --resource-group "test-rg"

省略可能のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

--yes -y

確認のダイアログを表示しません。

既定値: 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 stack-hci arc-setting generate-password

アーク設定のパスワードを生成します。

az stack-hci arc-setting generate-password [--arc-setting-name]
                                           [--cluster-name]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]

例

パスワードを生成する

az stack-hci arc-setting generate-password --name "default" --cluster-name "myCluster" --resource-group "test-rg"

省略可能のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting initialize-disable-proces

クラスターで ARC 無効化プロセスを初期化します。

az stack-hci arc-setting initialize-disable-proces [--arc-setting-name]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]

例

disable proces を初期化する

az stack-hci arc-setting initialize-disable-proces -g rg --arc-setting-name default --cluster-name name

省略可能のパラメーター

--arc-setting-name

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting list

HCI クラスターのアーク設定リソースを一覧表示します。

az stack-hci arc-setting list --cluster-name
                              --resource-group
                              [--max-items]
                              [--next-token]

例

HCI クラスター別のアーク設定リソースを一覧表示する

az stack-hci arc-setting list --cluster-name "myCluster" --resource-group "test-rg"

必須のパラメーター

--cluster-name

クラスターの名前です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター

--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 stack-hci arc-setting show

HCI クラスターの Arc 設定リソースの詳細を取得します。

az stack-hci arc-setting show [--arc-setting-name]
                              [--cluster-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

例

円弧の設定を取得する

az stack-hci arc-setting show --name "default" --cluster-name "myCluster" --resource-group "test-rg"

省略可能のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting update

HCI クラスターのアーク設定を更新します。

az stack-hci arc-setting update [--add]
                                [--arc-setting-name]
                                [--cluster-name]
                                [--connectivity-properties]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]

例

円弧の設定を更新する

az stack-hci arc-setting update --resource-group "test-rg" --cluster-name "myCluster" --name "default" --tags "{tag:tag}"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--connectivity-properties

ARC リソースの接続関連の構成が含まれています。短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--subscription

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

グローバル パラメーター

--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 stack-hci arc-setting wait

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

az stack-hci arc-setting wait [--arc-setting-name]
                              [--cluster-name]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--resource-group]
                              [--subscription]
                              [--timeout]
                              [--updated]

省略可能のパラメーター

--arc-setting-name --name -n

HCI ArcSetting 情報の詳細を保持するプロキシ リソースの名前。

--cluster-name

クラスターの名前です。

--created

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

既定値: False

--custom

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

--deleted

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

既定値: False

--exists

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

既定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

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

既定値: 30

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

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