az aks nodepool

Kubernetes kubernetes クラスター内のノード プールを管理するためのコマンド。

コマンド

az aks nodepool add

マネージド Kubernetes クラスターにノード プールを追加します。

az aks nodepool delete

マネージド Kubernetes クラスター内のエージェント プールを削除します。

az aks nodepool get-upgrades

マネージド Kubernetes クラスターのエージェント プールに使用可能なアップグレード バージョンを取得します。

az aks nodepool list

マネージド Kubernetes クラスター内のノード プールを一覧表示します。 クラスター kubectl get nodes 実行コマンドでノードの一覧を取得します。

az aks nodepool scale

マネージド Kubernetes クラスターでノード プールをスケーリングします。

az aks nodepool show

マネージド Kubernetes クラスターのノード プールの詳細を表示します。

az aks nodepool snapshot

nodepool スナップショットを管理するコマンド。

az aks nodepool snapshot create

nodepool スナップショットを作成します。

az aks nodepool snapshot delete

nodepool スナップショットを削除します。

az aks nodepool snapshot list

nodepool スナップショットを一覧表示します。

az aks nodepool snapshot show

nodepool スナップショットの詳細を表示します。

az aks nodepool snapshot wait

nodepool スナップショットが目的の状態になるまで待ちます。

az aks nodepool start

マネージド Kubernetes クラスターで停止したエージェント プールを開始します。

az aks nodepool stop

マネージド Kubernetes クラスターでエージェント プールの実行を停止します。

az aks nodepool update

クラスター オートスケーラーを有効または無効にするか、最小カウントまたは max-count を変更するようにノード プールを更新します。

az aks nodepool upgrade

マネージド Kubernetes クラスターでノード プールをアップグレードします。

az aks nodepool wait

ノード プールが目的の状態になるまで待ちます。

az aks nodepool add

マネージド Kubernetes クラスターにノード プールを追加します。

az aks nodepool add --cluster-name
                    --name
                    --resource-group
                    [--aks-custom-headers]
                    [--enable-cluster-autoscaler]
                    [--enable-encryption-at-host]
                    [--enable-fips-image]
                    [--enable-node-public-ip]
                    [--enable-ultra-ssd]
                    [--eviction-policy {Deallocate, Delete}]
                    [--kubelet-config]
                    [--kubernetes-version]
                    [--labels]
                    [--linux-os-config]
                    [--max-count]
                    [--max-pods]
                    [--max-surge]
                    [--min-count]
                    [--mode {System, User}]
                    [--no-wait]
                    [--node-count]
                    [--node-osdisk-size]
                    [--node-osdisk-type {Ephemeral, Managed}]
                    [--node-public-ip-prefix-id]
                    [--node-taints]
                    [--node-vm-size]
                    [--os-sku {CBLMariner, Ubuntu}]
                    [--os-type]
                    [--pod-subnet-id]
                    [--ppg]
                    [--priority {Regular, Spot}]
                    [--scale-down-mode {Deallocate, Delete}]
                    [--snapshot-id]
                    [--spot-max-price]
                    [--tags]
                    [--vnet-subnet-id]
                    [--zones {1, 2, 3}]

エフェメラル os が有効になっている既存の AKS クラスターにノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48

EncryptionAtHost を有効にしてノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-encryption-at-host

UltraSSD が有効になっているノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-ultra-ssd

特定の OS SKU を使用してノードプール クラスターを作成する

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --os-sku Ubuntu

FIPS 対応 OS を使用してノードプールを作成する

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-fips-image

スナップショット ID を使用して kubernetes クラスターを作成します。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

カスタム ヘッダーを指定するコンマ区切りのキーと値のペア。

--enable-cluster-autoscaler -e

クラスターオートスケーラーを有効にします。

--enable-encryption-at-host

EncryptionAtHost を有効にします。既定値は false です。

--enable-fips-image

エージェント ノードで FIPS 対応 OS を使用します。

--enable-node-public-ip

VMSS ノードのパブリック IP を有効にします。

--enable-ultra-ssd

UltraSSD を有効にします。既定値は false です。

--eviction-policy

スポット ノード プールの削除ポリシー。 これは、--priority が Spot の場合にのみ設定できます。

承認された値: Deallocate, Delete
既定値: Delete
--kubelet-config

エージェント ノードの Kubelet 構成を含む JSON ファイルへのパス。 https://aka.ms/aks/custom-node-config.

--kubernetes-version -k

クラスターの作成に使用する Kubernetes のバージョン ("1.16.9" など)。

開始値: `az aks get-versions`
--labels

ノード プールのノード ラベル。 ラベルの構文を参照してください https://aka.ms/node-labels

--linux-os-config

Linux エージェント ノードの OS 構成を含む JSON ファイルへのパス。 https://aka.ms/aks/custom-node-config.

--max-count

"--enable-cluster-autoscaler" が指定されている場合に自動スケーラーに使用される最大ノード数。 ユーザー ノードプールの場合は [0,1000]、システム ノードプールの場合は [1,1000] の範囲で値を指定してください。

--max-pods -m

ノードに展開できるポッドの最大数。

--max-surge

アップグレードを高速化するために使用される追加のノード。 指定した場合、使用された数またはパーセントを表します。例: 5 または 33%

--min-count

"--enable-cluster-autoscaler" が指定されている場合、自動スケーラーに使用される最小ノード数。 ユーザー ノードプールの場合は [0,1000]、システム ノードプールの場合は [1,1000] の範囲で値を指定してください。

--mode

ノード プールのプライマリ関数を定義するノード プールのモード。 "System" に設定されている場合、AKS では、モード System付きのノード プールに対してシステム ポッドのスケジュール設定が優先されます。 詳細については、https://aka.ms/aks/nodepool/mode をご覧ください。

承認された値: System, User
既定値: User
--no-wait

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

--node-count -c

Kubernetes エージェント プール内のノードの数。 クラスターを作成した後で、そのノード プール az aks scaleのサイズを変更できます。

既定値: 3
--node-osdisk-size

エージェント プール内の各ノードの OS ディスクのサイズ (GB 単位)。 最小 30 GB。

--node-osdisk-type

特定のエージェント プール内のマシンに使用する OS ディスクの種類。 VM サイズと OS ディスク サイズと組み合わせて、可能な場合は既定値は "エフェメラル" です。 このプールは、作成後に変更することはできません。 ('Ephemeral' または 'Managed')。

承認された値: Ephemeral, Managed
--node-public-ip-prefix-id

VMSS ノードにパブリック IP を割り当てるために使用されるパブリック IP プレフィックス ID。

--node-taints

ノード プールのノード テイント。

--node-vm-size -s

Kubernetes ノードとして作成する仮想マシンのサイズ。

--os-sku

エージェント ノード プールの OS SKU。 Ubuntu または CBLMariner。

承認された値: CBLMariner, Ubuntu
--os-type

OS の種類。 Linux または Windows。

--pod-subnet-id

クラスター内のポッドを割り当てる既存の VNet 内のサブネットの ID (Azure ネットワーク プラグインが必要)。

--ppg

PPG の ID。

--priority

ノード プールの優先度。

承認された値: Regular, Spot
既定値: Regular
--scale-down-mode

ノードプールに VM を追加またはノードプールから削除する方法について説明します。

承認された値: Deallocate, Delete
既定値: Delete
--snapshot-id

このノード プールの作成に使用されるソース スナップショット ID。

--spot-max-price

これは、--priority が Spot の場合にのみ設定できます。 米国ドルで支払う最大価格を指定します。 使用できる値は、既定の価格がオンデマンドであることを示す 0 または -1 より大きい任意の 10 進値です。 小数点以下 5 桁までしか含めないでください。

既定値: nan
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--vnet-subnet-id

クラスターを展開する既存の VNet 内のサブネット ID。

--zones -z

エージェント ノードが配置される可用性ゾーン。

承認された値: 1, 2, 3

az aks nodepool delete

マネージド Kubernetes クラスター内のエージェント プールを削除します。

az aks nodepool delete --cluster-name
                       --name
                       --resource-group
                       [--no-wait]

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

az aks nodepool get-upgrades

マネージド Kubernetes クラスターのエージェント プールに使用可能なアップグレード バージョンを取得します。

az aks nodepool get-upgrades --cluster-name
                             --nodepool-name
                             --resource-group

マネージド Kubernetes クラスターのエージェント プールに使用可能なアップグレード バージョンを取得します。

az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePool

必須のパラメーター

--cluster-name

クラスター名。

--nodepool-name

ノード プールの名前。

--resource-group -g

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

az aks nodepool list

マネージド Kubernetes クラスター内のノード プールを一覧表示します。 クラスター kubectl get nodes 実行コマンドでノードの一覧を取得します。

az aks nodepool list --cluster-name
                     --resource-group

必須のパラメーター

--cluster-name

クラスター名。

--resource-group -g

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

az aks nodepool scale

マネージド Kubernetes クラスターでノード プールをスケーリングします。

az aks nodepool scale --cluster-name
                      --name
                      --resource-group
                      [--no-wait]
                      [--node-count]

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

--node-count -c

Kubernetes ノード プール内のノードの数。

既定値: 3

az aks nodepool show

マネージド Kubernetes クラスターのノード プールの詳細を表示します。

az aks nodepool show --cluster-name
                     --name
                     --resource-group

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

az aks nodepool start

マネージド Kubernetes クラスターで停止したエージェント プールを開始します。

az aks nodepool start --cluster-name
                      --nodepool-name
                      --resource-group
                      [--aks-custom-headers]
                      [--no-wait]

マネージド クラスターでエージェント プールを開始する

az aks nodepool start --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必須のパラメーター

--cluster-name

クラスター名。

--nodepool-name

エージェント プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

カスタム ヘッダーを送信します。 指定する場合、形式は Key1=Value1,Key2=Value2 にする必要があります。

--no-wait

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

az aks nodepool stop

マネージド Kubernetes クラスターでエージェント プールの実行を停止します。

az aks nodepool stop --cluster-name
                     --nodepool-name
                     --resource-group
                     [--aks-custom-headers]
                     [--no-wait]

マネージド クラスター内のエージェント プールを停止する

az aks nodepool stop --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必須のパラメーター

--cluster-name

クラスター名。

--nodepool-name

エージェント プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

カスタム ヘッダーを送信します。 指定する場合、形式は Key1=Value1,Key2=Value2 にする必要があります。

--no-wait

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

az aks nodepool update

クラスター オートスケーラーを有効または無効にするか、最小カウントまたは max-count を変更するようにノード プールを更新します。

az aks nodepool update --cluster-name
                       --name
                       --resource-group
                       [--aks-custom-headers]
                       [--disable-cluster-autoscaler]
                       [--enable-cluster-autoscaler]
                       [--labels]
                       [--max-count]
                       [--max-surge]
                       [--min-count]
                       [--mode {System, User}]
                       [--no-wait]
                       [--node-taints]
                       [--scale-down-mode {Deallocate, Delete}]
                       [--tags]
                       [--update-cluster-autoscaler]

ノード数の範囲内でクラスター オートスケーラーを有効にする [1,5]

az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

既存のクラスターのクラスター 自動スケーラーを無効にする

az aks nodepool update --disable-cluster-autoscaler -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

クラスター オートスケーラーの最小数または最大カウントを更新します。

az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

カスタム ヘッダーを指定するコンマ区切りのキーと値のペア。

--disable-cluster-autoscaler -d

クラスター オートスケーラーを無効にします。

--enable-cluster-autoscaler -e

クラスター オートスケーラーを有効にします。

--labels

ノード プールのノード ラベル。 ラベルの構文を参照してください https://aka.ms/node-labels

--max-count

"--enable-cluster-autoscaler" が指定されている場合に、自動スケーラーに使用される最大ノード数。 ユーザー ノードプールの場合は [0, 1000] の範囲で、システム ノードプールの場合は [1,1000] の範囲で値を指定してください。

--max-surge

アップグレードを高速化するために使用される追加のノード。 指定した場合、使用された数またはパーセントを表します。例: 5 または 33% です。

--min-count

"--enable-cluster-autoscaler" が指定されている場合に、自動スケーラーに使用される最小ノード数。 ユーザー ノードプールの場合は [0, 1000] の範囲で、システム ノードプールの場合は [1,1000] の範囲で値を指定してください。

--mode

ノード プールのプライマリ関数を定義するノード プールのモード。 "System" に設定されている場合、AKS では、モード Systemのノード プールよりもシステム ポッドのスケジュール設定が優先されます。 詳細については、https://aka.ms/aks/nodepool/mode をご覧ください。

承認された値: System, User
--no-wait

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

--node-taints

ノード プールのノード テイント。

--scale-down-mode

ノードプールに対して VM を追加または削除する方法について説明します。

承認された値: Deallocate, Delete
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--update-cluster-autoscaler -u

クラスター オートスケーラーの最小数または最大カウントを更新します。

az aks nodepool upgrade

マネージド Kubernetes クラスターでノード プールをアップグレードします。

az aks nodepool upgrade --cluster-name
                        --name
                        --resource-group
                        [--aks-custom-headers]
                        [--kubernetes-version]
                        [--max-surge]
                        [--no-wait]
                        [--node-image-only]
                        [--snapshot-id]

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

カスタム ヘッダーを指定するコンマ区切りのキーと値のペア。

--kubernetes-version -k

ノード プールをアップグレードする Kubernetes のバージョン ("1.16.9" など)。

--max-surge

アップグレードを高速化するために使用される追加のノード。 指定した場合、使用された数またはパーセントを表します。例: 5 または 33% ("--node-image-only" と相互に排他的です)。 "--node-image-only" でアップグレードする前に最大サージを更新するには、「az aks nodepool update --max-surge」を参照してください)。

--no-wait

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

--node-image-only

エージェント プールのノード イメージのみをアップグレードします。

--snapshot-id

この nodepool のアップグレードに使用されるソース スナップショット ID。

az aks nodepool wait

ノード プールが目的の状態になるまで待ちます。

ノード プールの操作が中断されたか、または開始 --no-waitされた場合は、このコマンドを使用して、ノード プールが完了するまで待機します。

az aks nodepool wait --agent-pool-name
                     --name
                     --resource-group
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

ノード プールが目的の状態になるまで待機し、1 分ごとに最大 30 分間ポーリングします。

az aks nodepool wait --created --interval 60 --name MyManagedCluster --resource-group MyResourceGroup --nodepool-name MyNodePool --timeout 1800

必須のパラメーター

--agent-pool-name --nodepool-name

ノード プール名。

--name -n

マネージド クラスターの名前。

--resource-group -g

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

省略可能のパラメーター

--created

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

--custom

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

--deleted

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

--exists

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

--interval

ポーリング間隔 (秒)。

既定値: 30
--timeout

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

既定値: 3600
--updated

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