az networkcloud kubernetescluster agentpool

注

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

Kubernetes クラスターのエージェント プールを管理します。

コマンド

名前	説明	型	状態
az networkcloud kubernetescluster agentpool create	新しい Kubernetes クラスター エージェント プールを作成するか、既存の Kubernetes クラスター エージェント プールのプロパティを更新します。	拡張	GA
az networkcloud kubernetescluster agentpool delete	指定された Kubernetes クラスター エージェント プールを削除します。	拡張	GA
az networkcloud kubernetescluster agentpool list	指定された Kubernetes クラスターのエージェント プールを一覧表示します。	拡張	GA
az networkcloud kubernetescluster agentpool show	指定された Kubernetes クラスター エージェント プールのプロパティを取得します。	拡張	GA
az networkcloud kubernetescluster agentpool update	指定された Kubernetes クラスター エージェント プールのプロパティを更新するか、Kubernetes クラスター エージェント プールに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。	拡張	GA
az networkcloud kubernetescluster agentpool wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az networkcloud kubernetescluster agentpool create

新しい Kubernetes クラスター エージェント プールを作成するか、既存の Kubernetes クラスター エージェント プールのプロパティを更新します。

az networkcloud kubernetescluster agentpool create --agent-pool-name
                                                   --count
                                                   --kc-name
                                                   --mode {NotApplicable, System, User}
                                                   --resource-group
                                                   --vm-sku-name
                                                   [--admin-username]
                                                   [--agent-options]
                                                   [--attached-network-configuration]
                                                   [--availability-zones]
                                                   [--extended-location]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--if-match]
                                                   [--if-none-match]
                                                   [--labels]
                                                   [--location]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--tags]
                                                   [--taints]
                                                   [--upgrade-settings]

例

Kubernetes クラスターのエージェント プールを作成または更新する

az networkcloud kubernetescluster agentpool create --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --admin-username "azureuser" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm' --count 3 --mode "System" --vm-sku-name "NC-XXXXX" --agent-options hugepages-count=96 hugepages-size="1G" --attached-network-configuration l2-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName',pluginType:'DPDK'}]" l3-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName,pluginType:'SRIOV',ipamEnabled:'False'}]" trunked-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName',pluginType:'MACVLAN'}]" --labels="[{key:'kubernetes.label',value:'true'}]" --taints="[{key:'kubernetes.taint',value:'true'}]" --upgrade-settings max-surge="1" --availability-zones="['zone1','zone2']"

必須のパラメーター

--agent-pool-name --name -n

Kubernetes クラスター エージェント プールの名前。

--count

この構成を使用する仮想マシンの数。

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

--mode

このエージェント プールをシステム プールまたはユーザー プールとして使用する方法の選択。 システム プールは Kubernetes クラスターの機能と重要なサービスを実行しますが、ユーザー プールはユーザー ワークロード専用です。 すべての Kubernetes クラスターには、少なくとも 1 つのノードを含む少なくとも 1 つのシステム ノード プールが含まれている必要があります。

指定可能な値: NotApplicable, System, User

--resource-group -g

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

--vm-sku-name

ノード VM に割り当てられたリソースのサイズを決定する VM SKU の名前。

省略可能のパラメーター

--admin-username

Kubernetes ノードを実行するオペレーティング システムに適用される管理者のユーザー名。 指定しない場合は、サービスによってユーザー名が選択されます。

--agent-options

このエージェント プール内の各エージェントに適用される構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--attached-network-configuration

この Kubernetes クラスターで実行されるワークロードで使用するためにエージェント プールに接続されているネットワークの構成。 これらのネットワークは、Kubernetes クラスターに接続されているネットワーク構成に追加されます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--availability-zones

このエージェント プール内のノードのプロビジョニングに使用されるネットワーク クラウド クラスターの可用性ゾーンの一覧。 指定しない場合は、すべての可用性ゾーンが使用されます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--extended-location

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

--generate-ssh-keys

SSH 公開キー ファイルおよび SSH 秘密キー ファイルがない場合は生成します。 キーは '~/.ssh' の下に格納されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--if-match

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

--if-none-match

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

--labels

このエージェント プール内のノードに適用されるラベル。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ssh-dest-key-path

ssh 公開キーへのスペース区切りパスの一覧。 ファイル パスは、指定することも、ディレクトリにすることもできます。 ディレクトリが指定されている場合は、見つかったすべての公開キー (.pub) の読み込みが試行されます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--ssh-key-values

スペース区切りの SSH 公開キーの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--tags

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

--taints

このエージェント プール内のノードに適用されるテイント。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--upgrade-settings

エージェント プールの構成。 短縮構文、json-file、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 networkcloud kubernetescluster agentpool delete

指定された Kubernetes クラスター エージェント プールを削除します。

az networkcloud kubernetescluster agentpool delete [--agent-pool-name]
                                                   [--ids]
                                                   [--if-match]
                                                   [--if-none-match]
                                                   [--kc-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--yes]

例

Kubernetes クラスターのエージェント プールを削除する

az networkcloud kubernetescluster agentpool delete --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

省略可能のパラメーター

--agent-pool-name --name -n

Kubernetes クラスター エージェント プールの名前。

--ids

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

--if-match

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

--if-none-match

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

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

--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 networkcloud kubernetescluster agentpool list

指定された Kubernetes クラスターのエージェント プールを一覧表示します。

az networkcloud kubernetescluster agentpool list --kc-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

例

Kubernetes クラスターのエージェント プールを一覧表示する

az networkcloud kubernetescluster agentpool list --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

必須のパラメーター

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

--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 networkcloud kubernetescluster agentpool show

指定された Kubernetes クラスター エージェント プールのプロパティを取得します。

az networkcloud kubernetescluster agentpool show [--agent-pool-name]
                                                 [--ids]
                                                 [--kc-name]
                                                 [--resource-group]
                                                 [--subscription]

例

Kubernetes クラスターのエージェント プールを取得する

az networkcloud kubernetescluster agentpool show --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

省略可能のパラメーター

--agent-pool-name --name -n

Kubernetes クラスター エージェント プールの名前。

--ids

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

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

--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 networkcloud kubernetescluster agentpool update

指定された Kubernetes クラスター エージェント プールのプロパティを更新するか、Kubernetes クラスター エージェント プールに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。

az networkcloud kubernetescluster agentpool update [--agent-pool-name]
                                                   [--count]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ids]
                                                   [--if-match]
                                                   [--if-none-match]
                                                   [--kc-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--subscription]
                                                   [--tags]
                                                   [--upgrade-settings]

例

Kubernetes クラスターのパッチ エージェント プール

az networkcloud kubernetescluster agentpool update --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --count 3 --upgrade-settings max-surge="1"

エージェント プール管理者の資格情報を更新する

az networkcloud kubernetescluster agentpool update --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm'

省略可能のパラメーター

--agent-pool-name --name -n

Kubernetes クラスター エージェント プールの名前。

--count

この構成を使用する仮想マシンの数。

--generate-ssh-keys

SSH 公開キー ファイルおよび SSH 秘密キー ファイルがない場合は生成します。 キーは '~/.ssh' の下に格納されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--if-match

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

--if-none-match

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

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--ssh-dest-key-path

ssh 公開キーへのスペース区切りパスの一覧。 ファイル パスは、指定することも、ディレクトリにすることもできます。 ディレクトリが指定されている場合は、見つかったすべての公開キー (.pub) の読み込みが試行されます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--ssh-key-values

スペース区切りの SSH 公開キーの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--subscription

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

--tags

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

--upgrade-settings

エージェント プールの構成。 短縮構文、json-file、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 networkcloud kubernetescluster agentpool wait

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

az networkcloud kubernetescluster agentpool wait [--agent-pool-name]
                                                 [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--ids]
                                                 [--interval]
                                                 [--kc-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

省略可能のパラメーター

--agent-pool-name --name -n

Kubernetes クラスター エージェント プールの名前。

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

--kc-name --kubernetes-cluster-name

Kubernetes クラスターの名前。

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