次の方法で共有


az networkcloud cluster baremetalmachinekeyset

Note

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

クラスターのベア メタル マシン キー セットを管理します。

コマンド

名前 説明 状態
az networkcloud cluster baremetalmachinekeyset create

新しいベア メタル マシン キー セットを作成するか、指定されたクラスターの既存のキー セットを更新します。

Extension GA
az networkcloud cluster baremetalmachinekeyset delete

指定されたクラスターのベア メタル マシン キー セットを削除します。

Extension GA
az networkcloud cluster baremetalmachinekeyset list

クラスターのベア メタル マシン キー セットを一覧表示します。

Extension GA
az networkcloud cluster baremetalmachinekeyset show

指定されたクラスターのベア メタル マシン キー セットを取得します。

Extension GA
az networkcloud cluster baremetalmachinekeyset update

指定されたクラスターのベア メタル マシン キー セットのプロパティを更新するか、それに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。

Extension GA
az networkcloud cluster baremetalmachinekeyset wait

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

Extension GA

az networkcloud cluster baremetalmachinekeyset create

新しいベア メタル マシン キー セットを作成するか、指定されたクラスターの既存のキー セットを更新します。

az networkcloud cluster baremetalmachinekeyset create --azure-group-id
                                                      --bare-metal-machine-key-set-name --name
                                                      --cluster-name
                                                      --expiration
                                                      --extended-___location
                                                      --jump-hosts-allowed
                                                      --privilege-level {Standard, Superuser}
                                                      --resource-group
                                                      --user-list
                                                      [--if-match]
                                                      [--if-none-match]
                                                      [--___location]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--os-group-name]
                                                      [--tags]

クラスターのベア メタル マシン キー セットを作成または更新する

az networkcloud cluster baremetalmachinekeyset create --name "bareMetalMachineKeySetName" --extended-___location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --___location "___location" --azure-group-id "MicrosoftEntraGroupObjectId" --expiration "2022-12-31T23:59:59.008Z" --jump-hosts-allowed "192.0.2.1" "192.0.2.5" --os-group-name "standardAccessGroup" --privilege-level "Standard" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19UmovAJiIVUbT6YaYc/t5SjWU=admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName

必須のパラメーター

--azure-group-id

アクセスを許可するには、リスト内のすべてのユーザーが存在する必要がある Azure Active Directory グループのオブジェクト ID。 グループに含まれていないユーザーはアクセスできません。

プロパティ
Parameter group: Properties Arguments
--bare-metal-machine-key-set-name --name -n

ベア メタル マシン キー セットの名前。

--cluster-name

クラスターの名前です。

--expiration

このキー セットのユーザーがベア メタル マシンから削除される日時。

プロパティ
Parameter group: Properties Arguments
--extended-___location

リソースに関連付けられているクラスターの拡張された場所。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: BareMetalMachineKeySetParameters Arguments
--jump-hosts-allowed

ユーザーのログインが許可される管理ネットワーク アクセスを持つジャンプ ホストの IP アドレスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: Properties Arguments
--privilege-level

このキー セット内のユーザーに許可されるアクセス レベル。

プロパティ
Parameter group: Properties Arguments
指定可能な値: Standard, Superuser
--resource-group -g

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

--user-list

許可されているユーザーの一意の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: Properties Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--___location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

プロパティ
Parameter group: BareMetalMachineKeySetParameters Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

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

コンピューターのオペレーティング システムでユーザーが割り当てられるグループの名前。

プロパティ
Parameter group: Properties Arguments
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: BareMetalMachineKeySetParameters Arguments
グローバル パラメーター
--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 networkcloud cluster baremetalmachinekeyset delete

指定されたクラスターのベア メタル マシン キー セットを削除します。

az networkcloud cluster baremetalmachinekeyset delete [--bare-metal-machine-key-set-name --name]
                                                      [--cluster-name]
                                                      [--ids]
                                                      [--if-match]
                                                      [--if-none-match]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--yes]

クラスターのベア メタル マシン キー セットを削除する

az networkcloud cluster baremetalmachinekeyset delete --name "bareMetalMachineKeySetName" --cluster-name "clusterName" --resource-group "resourceGroupName

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-key-set-name --name -n

ベア メタル マシン キー セットの名前。

プロパティ
Parameter group: Resource Id Arguments
--cluster-name

クラスターの名前です。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

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

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ
規定値: False
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

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

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

--verbose

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

プロパティ
規定値: False

az networkcloud cluster baremetalmachinekeyset list

クラスターのベア メタル マシン キー セットを一覧表示します。

az networkcloud cluster baremetalmachinekeyset list --cluster-name
                                                    --resource-group
                                                    [--max-items]
                                                    [--next-token]

クラスターのベア メタル マシン キー セットを一覧表示する

az networkcloud cluster baremetalmachinekeyset list --cluster-name "clusterName" --resource-group "resourceGroupName"

必須のパラメーター

--cluster-name

クラスターの名前です。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

プロパティ
Parameter group: Pagination Arguments
--next-token

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

プロパティ
Parameter group: Pagination Arguments
グローバル パラメーター
--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 networkcloud cluster baremetalmachinekeyset show

指定されたクラスターのベア メタル マシン キー セットを取得します。

az networkcloud cluster baremetalmachinekeyset show [--bare-metal-machine-key-set-name --name]
                                                    [--cluster-name]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

クラスターのベア メタル マシン キー セットを取得する

az networkcloud cluster baremetalmachinekeyset show --name "bareMetalMachineKeySetName" --cluster-name "clusterName" --resource-group "resourceGroupName

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-key-set-name --name -n

ベア メタル マシン キー セットの名前。

プロパティ
Parameter group: Resource Id Arguments
--cluster-name

クラスターの名前です。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

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

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

--verbose

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

プロパティ
規定値: False

az networkcloud cluster baremetalmachinekeyset update

指定されたクラスターのベア メタル マシン キー セットのプロパティを更新するか、それに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。

az networkcloud cluster baremetalmachinekeyset update [--bare-metal-machine-key-set-name --name]
                                                      [--cluster-name]
                                                      [--expiration]
                                                      [--ids]
                                                      [--if-match]
                                                      [--if-none-match]
                                                      [--jump-hosts-allowed]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--tags]
                                                      [--user-list]

クラスターのベア メタル マシン キー セットにパッチを適用する

az networkcloud cluster baremetalmachinekeyset update --name "bareMetalMachineKeySetName" --expiration "2022-12-31T23:59:59.008Z" --jump-hosts-allowed "192.0.2.1" "192.0.2.5" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+/ojNZfpB3af/YDzwQCZzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-key-set-name --name -n

ベア メタル マシン キー セットの名前。

プロパティ
Parameter group: Resource Id Arguments
--cluster-name

クラスターの名前です。

プロパティ
Parameter group: Resource Id Arguments
--expiration

このキー セットのユーザーがベア メタル マシンから削除される日時。

プロパティ
Parameter group: Properties Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--jump-hosts-allowed

ユーザーのログインが許可される管理ネットワーク アクセスを持つジャンプ ホストの IP アドレスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

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

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--tags

既存のものを置き換える Azure リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: BareMetalMachineKeySetUpdateParameters Arguments
--user-list

許可されているユーザーの一意の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
Parameter group: Properties Arguments
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

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

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

--verbose

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

プロパティ
規定値: False

az networkcloud cluster baremetalmachinekeyset wait

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

az networkcloud cluster baremetalmachinekeyset wait [--bare-metal-machine-key-set-name --name]
                                                    [--cluster-name]
                                                    [--created]
                                                    [--custom]
                                                    [--deleted]
                                                    [--exists]
                                                    [--ids]
                                                    [--interval]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--timeout]
                                                    [--updated]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--bare-metal-machine-key-set-name --name -n

ベア メタル マシン キー セットの名前。

プロパティ
Parameter group: Resource Id Arguments
--cluster-name

クラスターの名前です。

プロパティ
Parameter group: Resource Id Arguments
--created

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--custom

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

プロパティ
Parameter group: Wait Condition Arguments
--deleted

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--exists

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--interval

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 30
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--timeout

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

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

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

--verbose

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

プロパティ
規定値: False