az aks nodepool

  • リファレンス

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。

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

コマンド

名前 説明 型 Status
az aks nodepool add

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

 コア GA
az aks nodepool add (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool delete

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

 コア GA
az aks nodepool delete (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool delete-machines

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

 拡張子 GA
az aks nodepool get-upgrades

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

 コア GA
az aks nodepool get-upgrades (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool list

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

 コア GA
az aks nodepool list (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool operation-abort

nodepool で最後に実行された操作を中止します。

 コア GA
az aks nodepool operation-abort (aks-preview 拡張機能)

nodepool で最後に実行された操作を中止します。

 拡張子 GA
az aks nodepool scale

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

 コア GA
az aks nodepool scale (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool show

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

 コア GA
az aks nodepool show (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool snapshot

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

 コアと拡張機能 GA
az aks nodepool snapshot create

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

 コア GA
az aks nodepool snapshot create (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool snapshot delete

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

 コア GA
az aks nodepool snapshot delete (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool snapshot list

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

 コア GA
az aks nodepool snapshot list (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool snapshot show

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

 コア GA
az aks nodepool snapshot show (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool snapshot update

ノードプールのスナップショットのタグを更新します。

 コア GA
az aks nodepool snapshot update (aks-preview 拡張機能)

ノードプールのスナップショットのタグを更新します。

 拡張子 GA
az aks nodepool snapshot wait

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

 コア GA
az aks nodepool start

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

 コア GA
az aks nodepool start (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool stop

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

 コア GA
az aks nodepool stop (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool update

ノード プールのプロパティを更新します。

 コア GA
az aks nodepool update (aks-preview 拡張機能)

ノード プールのプロパティを更新します。

 拡張子 GA
az aks nodepool upgrade

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

 コア GA
az aks nodepool upgrade (aks-preview 拡張機能)

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

 拡張子 GA
az aks nodepool wait

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

 コア GA

az aks nodepool add

編集

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

az aks nodepool add --cluster-name
                    --name
                    --resource-group
                    [--aks-custom-headers]
                    [--allowed-host-ports]
                    [--asg-ids]
                    [--crg-id]
                    [--drain-timeout]
                    [--enable-cluster-autoscaler]
                    [--enable-encryption-at-host]
                    [--enable-fips-image]
                    [--enable-node-public-ip]
                    [--enable-ultra-ssd]
                    [--eviction-policy {Deallocate, Delete}]
                    [--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
                    [--host-group-id]
                    [--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-public-ip-tags]
                    [--node-soak-duration]
                    [--node-taints]
                    [--node-vm-size]
                    [--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022}]
                    [--os-type]
                    [--pod-subnet-id]
                    [--ppg]
                    [--priority {Regular, Spot}]
                    [--scale-down-mode {Deallocate, Delete}]
                    [--snapshot-id]
                    [--spot-max-price]
                    [--tags]
                    [--vnet-subnet-id]
                    [--zones]

例

エフェメラル 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 を使用して nodepool クラスターを作成する

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"

ホスト グループ ID を使用して既存の AKS クラスターにノードプールを作成する

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSize

容量予約グループ (CRG) ID を持つノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--allowed-host-ports

ノード プール上のホスト ポートを公開します。 指定する場合、形式は、プロトコルを含む範囲のスペース区切りのリストである必要があります。例: 80/TCP 443/TCP 4000-5000/TCP.

--asg-ids

ノード プールのネットワーク インターフェイスが属する必要があるアプリケーション セキュリティ グループの ID。 指定する場合、書式はスペースで区切られた ID の一覧にする必要があります。

--crg-id

新しいノード プールを既存の容量予約グループ リソースに関連付けるために使用される crg ID。

--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間 (分)。

--enable-cluster-autoscaler -e

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

既定値: False
--enable-encryption-at-host

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

既定値: False
--enable-fips-image

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

既定値: False
--enable-node-public-ip

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

既定値: False
--enable-ultra-ssd

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

既定値: False
--eviction-policy

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

承認された値: Deallocate, Delete
既定値: Delete
--gpu-instance-profile

マルチ GPU Nvidia GPU をパーティション分割するための GPU インスタンス プロファイル。

承認された値: MIG1g, MIG2g, MIG3g, MIG4g, MIG7g
--host-group-id

エージェント ノード プールのプロビジョニングに使用される完全修飾専用ホスト グループ ID。

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

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

指定しない場合は、ネットワーク プラグインに基づいて既定値になります。 "azure" の場合は 30、"kubenet" の場合は 110、"none" の場合は 250。

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

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

既定値: False
--node-count -c

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

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

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

--node-osdisk-type

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

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

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

--node-public-ip-tags

ノード パブリック IP の ipTag。

--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--node-taints

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

--node-vm-size -s

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

--os-sku

エージェント ノード プールの OS SKU。 Ubuntu または CBLMariner for Linux。 Windows2019 または Windows 2022 for Windows。

承認された値: AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022
--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

エージェント ノードが配置される可用性ゾーン。 また、エージェント ノードを複数のゾーンにインストールするには、空白で区切られたゾーン番号を渡す必要があります。 たとえば、3 つのゾーンをすべて設定するには、次のように入力 --zones 1 2 3する必要があります。

グローバル パラメーター
--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 aks nodepool add (aks-preview 拡張機能)

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

az aks nodepool add --cluster-name
                    --name
                    --resource-group
                    [--aks-custom-headers]
                    [--allowed-host-ports]
                    [--asg-ids]
                    [--crg-id]
                    [--disable-windows-outbound-nat]
                    [--drain-timeout]
                    [--enable-artifact-streaming]
                    [--enable-cluster-autoscaler]
                    [--enable-custom-ca-trust]
                    [--enable-encryption-at-host]
                    [--enable-fips-image]
                    [--enable-node-public-ip]
                    [--enable-secure-boot]
                    [--enable-ultra-ssd]
                    [--enable-vtpm]
                    [--eviction-policy {Deallocate, Delete}]
                    [--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
                    [--host-group-id]
                    [--kubelet-config]
                    [--kubernetes-version]
                    [--labels]
                    [--linux-os-config]
                    [--max-count]
                    [--max-pods]
                    [--max-surge]
                    [--message-of-the-day]
                    [--min-count]
                    [--mode {System, User}]
                    [--no-wait]
                    [--node-count]
                    [--node-osdisk-size]
                    [--node-osdisk-type {Ephemeral, Managed}]
                    [--node-public-ip-prefix-id]
                    [--node-public-ip-tags]
                    [--node-soak-duration]
                    [--node-taints]
                    [--node-vm-size]
                    [--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022}]
                    [--os-type]
                    [--pod-ip-allocation-mode {DynamicIndividual, StaticBlock}]
                    [--pod-subnet-id]
                    [--ppg]
                    [--priority {Regular, Spot}]
                    [--scale-down-mode {Deallocate, Delete}]
                    [--skip-gpu-driver-install]
                    [--snapshot-id]
                    [--spot-max-price]
                    [--ssh-access {disabled, localuser}]
                    [--tags]
                    [--vm-set-type]
                    [--vnet-subnet-id]
                    [--workload-runtime {KataCcIsolation, KataMshvVmIsolation, OCIContainer, WasmWasi}]
                    [--zones]

例

エフェメラル 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

特定の os-sku を使用してノードプールを作成する

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

wasm ワークロードを実行できるノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster  --workload-runtime WasmWasi

スナップショット 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"

容量予約グループ (CRG) ID を持つノードプールを作成します。

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"

ホスト グループ ID を使用して既存の AKS クラスターにノードプールを作成する

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSize

IP 割り当てモードが "StaticBlock" に設定され、ポッド サブネット ID を使用してノードプールを作成する

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster  --os-sku Ubuntu --pod-subnet-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MySubnet --pod-ip-allocation-mode StaticBlock

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--allowed-host-ports
プレビュー

ノード プール上のホスト ポートを公開します。 指定する場合、形式は、プロトコルを含む範囲のコンマ区切りのリストである必要があります。例:80/TCP,443/TCP,4000-5000/TCP。 VMSS エージェント プールの種類を使用する必要があります。

--asg-ids
プレビュー

ノード プールのネットワーク インターフェイスが属する必要があるアプリケーション セキュリティ グループの ID。 指定する場合、形式は ID のコンマ区切りのリストである必要があります。 VMSS エージェント プールの種類を使用する必要があります。

--crg-id
プレビュー

新しいノード プールを既存の容量予約グループ リソースに関連付けるために使用される crg-id。 VMSS エージェント プールの種類を使用する必要があります。

--disable-windows-outbound-nat

Windows エージェント ノード プールで Windows OutboundNAT を無効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間 (分)。

--enable-artifact-streaming
プレビュー

ノード プールによって管理される VirtualMachineScaleSets のアーティファクト ストリーミングを有効にして、オンデマンドのイメージ読み込みを通じてノード上のコンテナーのコールド スタートを高速化します。 この機能を使用するには、コンテナー イメージで ACR でのアーティファクト ストリーミングも有効にする必要があります。 指定しない場合、既定値は false です。

既定値: False
--enable-cluster-autoscaler -e

クラスター オートスケーラーを有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-custom-ca-trust

エージェント ノード プールでカスタム CA 信頼を有効にします。

既定値: False
--enable-encryption-at-host

エージェント ノード プールで EncryptionAtHost を有効にします。

既定値: False
--enable-fips-image

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

既定値: False
--enable-node-public-ip

VMSS ノードのパブリック IP を有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-secure-boot
プレビュー

エージェント ノード プールでセキュア ブートを有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-ultra-ssd

エージェント ノード プールで UltraSSD を有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-vtpm
プレビュー

エージェント ノード プールで vTPM を有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--eviction-policy

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

承認された値: Deallocate, Delete
既定値: Delete
--gpu-instance-profile

マルチ GPU Nvidia GPU をパーティション分割するための GPU インスタンス プロファイル。

承認された値: MIG1g, MIG2g, MIG3g, MIG4g, MIG7g
--host-group-id

(プレビュー)エージェント ノード プールのプロビジョニングに使用される完全修飾専用ホスト グループ ID。 VMSS エージェント プールの種類を使用する必要があります。

--kubelet-config

エージェント ノードの Kubelet 構成。

--kubernetes-version -k

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

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

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

--linux-os-config

Linux エージェント ノードの OS 構成。

--max-count

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

--max-pods -m

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

指定しない場合は、ネットワーク プラグインに基づいて既定値になります。 "azure" の場合は 30、"kubenet" の場合は 110、"none" の場合は 250。

既定値: 0
--max-surge

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

--message-of-the-day

その日の目的のメッセージを含むファイルへのパス。 Linux ノードでのみ有効です。 /etc/motd に書き込まれます。

--min-count

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

--mode

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

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

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

既定値: False
--node-count -c

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

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

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

既定値: 0
--node-osdisk-type

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

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

パブリック IP を VMSS ノードに割り当てるために使用されるパブリック IP プレフィックス ID。 VMSS エージェント プールの種類を使用する必要があります。

--node-public-ip-tags

ノード パブリック IP の ipTag。 VMSS エージェント プールの種類を使用する必要があります。

--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--node-taints

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

--node-vm-size -s

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

--os-sku

エージェント ノード プールの os-sku。 os-type が Linux の場合は Ubuntu または CBLMariner、設定されていない場合は既定値は Ubuntu です。os-type が Windows の場合、Windows2019 または Windows2022。現在の既定値は Windows2019 (設定されていない場合) であり、Windows2019 が非推奨になった後、既定値は Windows2022 に変更されます。

承認された値: AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022
--os-type

OS の種類。 Linux または Windows。 "VirtualMachines" VM セットの種類では、Windows はまだサポートされていません。

--pod-ip-allocation-mode

Azure ポッド サブネットからのポッド IP を AKS クラスター内のノードに割り当てる方法の IP 割り当てモードを設定します。 選択は、個々の IP の動的バッチか、CIDR ブロックのセットの静的割り当てのどちらかです。 指定できる値は、"DynamicIndividual" または "StaticBlock" です。

"azure" ネットワーク プラグインと共に使用されます。 --pod-subnet-id が必要です。

承認された値: DynamicIndividual, StaticBlock
--pod-subnet-id

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

--ppg

PPG の ID。 VMSS エージェント プールの種類を使用する必要があります。

--priority

ノード プールの優先順位。

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

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

承認された値: Deallocate, Delete
既定値: Delete
--skip-gpu-driver-install
プレビュー

お客様が独自に GPU ドライバーのインストールを管理する場合は、GPU VM サイズを使用してノードプールに AKS による GPU ドライバーの自動インストールをスキップします。 指定しない場合、既定値は false です。

既定値: False
--snapshot-id

このノードプールの作成に使用されるソース スナップショット ID。 VMSS エージェント プールの種類を使用する必要があります。

--spot-max-price

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

既定値: nan
--ssh-access
プレビュー

ノード プールの SSH 設定を構成します。 SSH アクセスを無効にするには "disabled" を使用し、秘密キーを使用して SSH アクセスを有効にするには "localuser" を使用します。

承認された値: disabled, localuser
既定値: localuser
--tags

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

--vm-set-type

エージェント プール VM セットの種類。 VirtualMachineScaleSets、AvailabilitySet、または VirtualMachines(プレビュー)。

--vnet-subnet-id

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

--workload-runtime

ノードが実行できるワークロードの種類を決定します。 既定値は OCIContainer です。

承認された値: KataCcIsolation, KataMshvVmIsolation, OCIContainer, WasmWasi
既定値: OCIContainer
--zones -z

エージェント ノードが配置される可用性ゾーンのスペース区切りの一覧。 VMSS エージェント プールの種類を使用する必要があります。

グローバル パラメーター
--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 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

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

既定値: 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 aks nodepool delete (aks-preview 拡張機能)

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

az aks nodepool delete --cluster-name
                       --name
                       --resource-group
                       [--ignore-pod-disruption-budget]
                       [--no-wait]

例

ignore-pod-disruption-budget を使用してエージェント プールを削除する

az aks nodepool delete --resource-group MyResourceGroup --cluster-name MyManagedCluster --name nodepool1 --ignore-pod-disruption-budget=true

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--ignore-pod-disruption-budget -i
プレビュー

(プレビュー) ignore-pod-disruption-budget は、ポッド中断予算を考慮せずに既存のノードプールを削除します。

--no-wait

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

既定値: 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 aks nodepool delete-machines

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

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

例

エージェント プール内の特定のマシンを削除する

az aks nodepool delete-machines -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster --machine-names machine1

必須のパラメーター

--cluster-name

クラスター名。

--machine-names

削除するエージェント プールからのマシン名のスペース区切りの一覧。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

既定値: 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 aks nodepool get-upgrades

編集

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

グローバル パラメーター
--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 aks nodepool get-upgrades (aks-preview 拡張機能)

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

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

グローバル パラメーター
--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 aks nodepool list (aks-preview 拡張機能)

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

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

必須のパラメーター

--cluster-name

クラスター名。

--resource-group -g

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

グローバル パラメーター
--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 aks nodepool operation-abort

編集

nodepool で最後に実行された操作を中止します。

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

例

エージェント プールでの中止操作

az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

既定値: 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 aks nodepool operation-abort (aks-preview 拡張機能)

nodepool で最後に実行された操作を中止します。

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

例

エージェント プールでの中止操作

az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: 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 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

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

既定値: False
--node-count -c

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

既定値: 3
グローバル パラメーター
--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 aks nodepool scale (aks-preview 拡張機能)

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: False
--node-count -c

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

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

グローバル パラメーター
--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 aks nodepool show (aks-preview 拡張機能)

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

グローバル パラメーター
--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 aks nodepool start

編集

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: 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 aks nodepool start (aks-preview 拡張機能)

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: 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 aks nodepool stop

編集

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: 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 aks nodepool stop (aks-preview 拡張機能)

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--no-wait

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

既定値: 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 aks nodepool update

編集

ノード プールのプロパティを更新します。

クラスター オートスケーラーを有効または無効にするか、最小数または最大カウントを変更するようにノード プールを更新します。 省略可能な引数なしで呼び出されると、現在のノード プール構成を変更せずに、ノード プールを目標状態に移動しようとします。 これは、成功していない状態から移動するために使用できます。

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

例

nodepool を現在の状態に戻します。

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

ノード数の範囲内でクラスター オートスケーラーを有効にする [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

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

--allowed-host-ports

ノード プール上のホスト ポートを公開します。 指定する場合、形式は、プロトコルを含む範囲のスペース区切りのリストである必要があります。例: 80/TCP 443/TCP 4000-5000/TCP.

--asg-ids

ノード プールのネットワーク インターフェイスが属する必要があるアプリケーション セキュリティ グループの ID。 指定する場合、書式はスペースで区切られた ID の一覧にする必要があります。

--disable-cluster-autoscaler -d

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

既定値: False
--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間 (分)。

--enable-cluster-autoscaler -e

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

既定値: False
--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

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

既定値: False
--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--node-taints

ノード プールのノード テイント。 ノード プールの既存のノード テイントを更新するか、ノード プールの新しいノード テイントを作成できます。 空の文字列 "" を渡して、すべてのテイントを削除します。

--scale-down-mode

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

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

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

--update-cluster-autoscaler -u

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

既定値: 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 aks nodepool update (aks-preview 拡張機能)

ノード プールのプロパティを更新します。

クラスター オートスケーラーを有効または無効にするか、最小数または最大カウントを変更するようにノード プールを更新します。 省略可能な引数なしで呼び出されると、現在のノード プール構成を変更せずに、ノード プールを目標状態に移動しようとします。 これは、成功していない状態から移動するために使用できます。

az aks nodepool update --cluster-name
                       --name
                       --resource-group
                       [--aks-custom-headers]
                       [--allowed-host-ports]
                       [--asg-ids]
                       [--dcat]
                       [--disable-cluster-autoscaler]
                       [--disable-secure-boot]
                       [--disable-vtpm]
                       [--drain-timeout]
                       [--enable-artifact-streaming]
                       [--enable-cluster-autoscaler]
                       [--enable-custom-ca-trust]
                       [--enable-secure-boot]
                       [--enable-vtpm]
                       [--labels]
                       [--max-count]
                       [--max-surge]
                       [--min-count]
                       [--mode {System, User}]
                       [--no-wait]
                       [--node-soak-duration]
                       [--node-taints]
                       [--os-sku {AzureLinux, Ubuntu}]
                       [--scale-down-mode {Deallocate, Delete}]
                       [--ssh-access {disabled, localuser}]
                       [--tags]
                       [--update-cluster-autoscaler]
                       [--yes]

例

nodepool を現在の状態に戻します。

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

ノード数の範囲内でクラスター オートスケーラーを有効にする [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

ノード プールをシステム モードに変更する

az aks nodepool update --mode System -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--allowed-host-ports
プレビュー

ノード プール上のホスト ポートを公開します。 指定する場合、形式は、プロトコルを含む範囲のコンマ区切りのリストである必要があります。例:80/TCP,443/TCP,4000-5000/TCP。 VMSS エージェント プールの種類を使用する必要があります。

--asg-ids
プレビュー

ノード プールのネットワーク インターフェイスが属する必要があるアプリケーション セキュリティ グループの ID。 指定する場合、形式は ID のコンマ区切りのリストである必要があります。 VMSS エージェント プールの種類を使用する必要があります。

--dcat --disable-custom-ca-trust

エージェント ノード プールでカスタム CA 信頼を無効にします。

既定値: False
--disable-cluster-autoscaler -d

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

既定値: False
--disable-secure-boot
プレビュー

既存のトラステッド起動が有効なエージェント ノード プールでセキュア ブートを無効にします。

既定値: False
--disable-vtpm
プレビュー

既存の信頼された起動が有効なエージェント ノード プールで vTPM を無効にします。

既定値: False
--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間 (分)。

--enable-artifact-streaming
プレビュー

ノード プールによって管理される VirtualMachineScaleSets のアーティファクト ストリーミングを有効にして、オンデマンドのイメージ読み込みを通じてノード上のコンテナーのコールド スタートを高速化します。 この機能を使用するには、コンテナー イメージで ACR でのアーティファクト ストリーミングも有効にする必要があります。 指定しない場合、既定値は false です。

既定値: False
--enable-cluster-autoscaler -e

クラスター オートスケーラーを有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-custom-ca-trust

エージェント ノード プールでカスタム CA 信頼を有効にします。

既定値: False
--enable-secure-boot
プレビュー

既存のトラステッド起動が有効なエージェント ノード プールでセキュア ブートを有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--enable-vtpm
プレビュー

既存の信頼された起動が有効なエージェント ノード プールで vTPM を有効にします。 VMSS エージェント プールの種類を使用する必要があります。

既定値: False
--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

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

既定値: False
--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--node-taints

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

--os-sku

エージェント ノード プールの os-sku。

承認された値: AzureLinux, Ubuntu
--scale-down-mode

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

承認された値: Deallocate, Delete
--ssh-access
プレビュー

ノード プールの SSH 設定を更新します。 SSH アクセスを無効にするには "disabled" を使用し、秘密キーを使用して SSH アクセスを有効にするには "localuser" を使用します。

承認された値: disabled, localuser
--tags

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

--update-cluster-autoscaler -u

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

既定値: False
--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 aks nodepool upgrade

編集

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間。

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

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

既定値: False
--node-image-only

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

既定値: False
--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--snapshot-id

このノード プールのアップグレードに使用されるソース スナップショット 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 aks nodepool upgrade (aks-preview 拡張機能)

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--aks-custom-headers

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

--drain-timeout

ノードがドレインされている場合、すべてのポッドが削除されるまで待機する時間 (分)。

--kubernetes-version -k

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

--max-surge

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

--no-wait

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

既定値: False
--node-image-only

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

既定値: False
--node-soak-duration

ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。

--snapshot-id

このノード プールのアップグレードに使用されるソース スナップショット ID。 VMSS エージェント プールの種類を使用する必要があります。

--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 aks nodepool wait

編集

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

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

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

例

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

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

必須のパラメーター

--cluster-name

クラスター名。

--name --nodepool-name -n

ノード プール名。

--resource-group -g

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

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--interval

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

既定値: 30
--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 を使います。