az networkcloud cluster bmckeyset

Note

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

クラスターのベースボード管理コントローラー キー セットを管理します。

コマンド

名前	説明	型	状態
az networkcloud cluster bmckeyset create	新しいベースボード管理コントローラー キー セットを作成するか、指定されたクラスターの既存のキー セットを更新します。	Extension	Preview
az networkcloud cluster bmckeyset delete	指定されたクラスターのベースボード管理コントローラー キー セットを削除します。	Extension	Preview
az networkcloud cluster bmckeyset list	クラスターのベースボード管理コントローラーのキー セットを一覧表示します。	Extension	Preview
az networkcloud cluster bmckeyset show	指定されたクラスターのベースボード管理コントローラー キー セットを取得します。	Extension	Preview
az networkcloud cluster bmckeyset update	指定されたクラスターのベースボード管理コントローラー キー セットのプロパティを更新するか、関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。	Extension	Preview
az networkcloud cluster bmckeyset wait	条件が満たされるまで CLI を待機状態にします。	Extension	GA

az networkcloud cluster bmckeyset create

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

新しいベースボード管理コントローラー キー セットを作成するか、指定されたクラスターの既存のキー セットを更新します。

az networkcloud cluster bmckeyset create --azure-group-id
                                         --bmc-key-set-name --name
                                         --cluster-name
                                         --expiration
                                         --extended-location
                                         --privilege-level {Administrator, ReadOnly}
                                         --resource-group
                                         --user-list
                                         [--if-match]
                                         [--if-none-match]
                                         [--location]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]

例

クラスターのベースボード管理コントローラー キー セットを作成または更新する

az networkcloud cluster bmckeyset create --name "bmcKeySetName" --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" --privilege-level "Administrator" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19HU/G8EdEnbTlkl8Kkb5xv6nm+ttTb9FrW/dc9RQvai24VEFJmG4Fmi6Ow/yjxq+jTDuWOSs+Lo= admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName"

必須のパラメーター

--azure-group-id

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

プロパティ	値
パラメーター グループ:	Properties Arguments

--bmc-key-set-name --name -n

ベースボード管理コントローラー キー セットの名前。

--cluster-name

クラスターの名前です。

--expiration

このキー セット内のユーザーがベースボード管理コントローラーから削除される日時。

プロパティ	値
パラメーター グループ:	Properties Arguments

--extended-location

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

プロパティ	値
パラメーター グループ:	BmcKeySetParameters Arguments

--privilege-level

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

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	Administrator, ReadOnly

--resource-group -g

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

--user-list

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

プロパティ	値
パラメーター グループ:	Properties Arguments

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

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

--if-match

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

--if-none-match

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

--location -l

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

プロパティ	値
パラメーター グループ:	BmcKeySetParameters Arguments

--no-wait

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

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

--tags

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

プロパティ	値
パラメーター グループ:	BmcKeySetParameters 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 bmckeyset delete

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

指定されたクラスターのベースボード管理コントローラー キー セットを削除します。

az networkcloud cluster bmckeyset delete [--bmc-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 bmckeyset delete --name "bmcKeySetName" --cluster-name "clusterName" --resource-group "resourceGroupName"

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

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

--bmc-key-set-name --name -n

ベースボード管理コントローラー キー セットの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--cluster-name

クラスターの名前です。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ids

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

プロパティ	値
パラメーター グループ:	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>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	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 bmckeyset list

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クラスターのベースボード管理コントローラーのキー セットを一覧表示します。

az networkcloud cluster bmckeyset list --cluster-name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]
                                       [--skip-token]
                                       [--top]

例

クラスターのベースボード管理コントローラーのキー セットを一覧表示する

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

必須のパラメーター

--cluster-name

クラスターの名前です。

--resource-group -g

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

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

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

--max-items

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

プロパティ	値
パラメーター グループ:	Pagination Arguments

--next-token

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

プロパティ	値
パラメーター グループ:	Pagination Arguments

--skip-token

サーバーが返す不透明なトークンは、リソースのリストを続行する場所を示します。 これは、大きな結果セットをページングするために使用されます。

--top

操作から返されるリソースの最大数。 例: '$top=10'。

グローバル パラメーター

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

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

指定されたクラスターのベースボード管理コントローラー キー セットを取得します。

az networkcloud cluster bmckeyset show [--bmc-key-set-name --name]
                                       [--cluster-name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]

例

クラスターのベースボード管理コントローラー キー セットを取得する

az networkcloud cluster bmckeyset show --name "bmcKeySetName" --cluster-name "clusterName" --resource-group "resourceGroupName"

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

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

--bmc-key-set-name --name -n

ベースボード管理コントローラー キー セットの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--cluster-name

クラスターの名前です。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ids

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	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 bmckeyset update

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

az networkcloud cluster bmckeyset update [--bmc-key-set-name --name]
                                         [--cluster-name]
                                         [--expiration]
                                         [--ids]
                                         [--if-match]
                                         [--if-none-match]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--tags]
                                         [--user-list]

例

クラスターのベースボード管理コントローラー キー セットにパッチを適用する

az networkcloud cluster bmckeyset update --name "bmcKeySetName" --expiration "2022-12-31T23:59:59.008Z" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19HU/G8EdEnbTlkl8Kkb5xv6nm+ttTb9FrW/dc9RQvai24VEFJmG4Fmi6Ow/yjxq+jTDuWOSs+LovQpOKm9D8p05JcIOpdCPGA5S+dWIVL+a9jsQmzBbWYx= admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName"

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

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

--bmc-key-set-name --name -n

ベースボード管理コントローラー キー セットの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--cluster-name

クラスターの名前です。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--expiration

このキー セット内のユーザーがベースボード管理コントローラーから削除される日時。

プロパティ	値
パラメーター グループ:	Properties Arguments

--ids

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

プロパティ	値
パラメーター グループ:	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>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--tags

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

プロパティ	値
パラメーター グループ:	BmcKeySetUpdateParameters Arguments

--user-list

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

プロパティ	値
パラメーター グループ:	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 bmckeyset wait

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

az networkcloud cluster bmckeyset wait [--bmc-key-set-name --name]
                                       [--cluster-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

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

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

--bmc-key-set-name --name -n

ベースボード管理コントローラー キー セットの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--cluster-name

クラスターの名前です。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--created

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--custom

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments

--deleted

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--exists

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--ids

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--interval

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	30

--resource-group -g

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--timeout

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

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	3600

--updated

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

プロパティ	値
パラメーター グループ:	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