ManagedClusterAgentPoolProfile interface
コンテナー サービス エージェント プールのプロファイル。
プロパティ
| name | Windows エージェント プール名は 6 文字以下にする必要があります。 |
継承されたプロパティ
| availability |
ノードに使用する可用性ゾーンの一覧。 これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。 |
| capacity |
AKS は、指定されたエージェント プールを容量予約グループに関連付けます。 |
| count | Docker コンテナーをホストするエージェント (VM) の数。 使用できる値は、ユーザー プールの場合は 0 から 1000 (含む) の範囲、システム プールの場合は 1 から 1000 (含む) の範囲である必要があります。 既定値は 1 です。 |
| creation |
スナップショットを使用してノード プールを作成またはアップグレードする場合に、ソース スナップショット ID を指定するために使用する CreationData。 |
| enable |
自動スケーラーを有効にするかどうか |
| enable |
true に設定すると、AKS はデーモンセットとホスト サービスをデプロイして、ユーザー指定の構成マップからノード信頼ストアにカスタム証明機関を同期します。 既定値は false です。 |
| enable |
これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。 |
| enableFIPS | 詳細については、「FIPS 対応ノード プール の追加」を参照してください。 |
| enable |
シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受け取る必要がある場合があります。 一般的なシナリオは、ホップを最小限に抑えるために、コンソールがクラウド仮想マシンに直接接続する必要があるゲーム ワークロードです。 詳細については、ノードごとにパブリック IP を割り当てる |
| enable |
UltraSSD を有効にするかどうか |
| gpu |
サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用される GPUInstanceProfile。 |
| host |
形式は /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}です。 詳細については、Azure 専用ホストの |
| kubelet |
エージェント プール ノード上の Kubelet 構成。 |
| kubelet |
emptyDir ボリューム、コンテナー ランタイム データ ルート、および Kubelet エフェメラル ストレージの配置を決定します。 |
| linux |
Linux エージェント ノードの OS 構成。 |
| max |
自動スケーリングのノードの最大数 |
| max |
ノードで実行できるポッドの最大数。 |
| message |
デコード後に /etc/motd に書き込まれる base64 でエンコードされた文字列。 これにより、Linux ノードに対するその日のメッセージをカスタマイズできます。 Windows ノードには指定しないでください。 静的文字列である必要があります (つまり、生で出力され、スクリプトとして実行されません)。 |
| min |
自動スケーリング用のノードの最小数 |
| mode | クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、「https://docs.microsoft.com/azure/aks/use-system-pools」を参照してください。 |
| node |
エージェント プール内のすべてのノードにわたって保持されるノード ラベル。 |
| node |
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。 |
| node |
ノード プールの作成とスケーリング中に新しいノードに追加されたテイント。 たとえば、key=value:NoSchedule です。 |
| orchestrator |
パッチ バージョン <major.minor.patch> と <major.minor> の両方がサポートされています。
<major.minor>を指定すると、サポートされている最新のパッチ バージョンが自動的に選択されます。 エージェント プールを同じ <major.minor> を作成した後に更新しても、新しいパッチ バージョンが使用可能な場合でもアップグレードはトリガーされません。 ベスト プラクティスとして、AKS クラスター内のすべてのノード プールを同じ Kubernetes バージョンにアップグレードする必要があります。 ノード プールのバージョンには、コントロール プレーンと同じメジャー バージョンが必要です。 ノード プールのマイナー バージョンは、コントロール プレーン バージョンの 2 つのマイナー バージョン内にある必要があります。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳しくは、ノード・プールのアップグレード |
| os |
マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定された vmSize に従って既定の osDisk サイズが適用されます。 |
| os |
VM でサポートされていて、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後に変更できない場合があります。 詳細については、「エフェメラル OS |
| osSKU | エージェント プールで使用される OS SKU を指定します。 指定しない場合、既定値は OSType=Linux の場合は Ubuntu、OSType=Windows の場合は Windows2019 です。 また、Windows 2019 が非推奨になった後、既定の Windows OSSKU が Windows2022 に変更されます。 |
| os |
オペレーティング システムの種類。 既定値は Linux です。 |
| pod |
省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、vnetSubnetID を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。 |
| power |
エージェント プールが最初に作成されるときは、最初に実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールは、実行中でプロビジョニング状態が成功した場合にのみ停止できます |
| proximity |
近接通信配置グループの ID。 |
| scale |
これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合は、既定で Delete に設定されます。 |
| scale |
scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。 |
| scale |
仮想マシン スケール セットの優先順位。 指定しない場合、既定値は 'Regular' です。 |
| spot |
指定できる値は、0 より大きい任意の 10 進値またはオンデマンド価格を支払う意欲を示す -1 です。 スポット価格の詳細については、スポット VM の価格 を参照してください。 |
| tags | エージェント プールの仮想マシン スケール セットに保持されるタグ。 |
| type | エージェント プールの種類。 |
| upgrade |
エージェント プールをアップグレードするための設定 |
| vm |
VM サイズの可用性はリージョンによって異なります。 ノードに十分なコンピューティング リソース (メモリ、cpu など) が含まれている場合、ポッドが正常に実行されない可能性があります。 制限付き VM サイズの詳細については、「https://docs.microsoft.com/azure/aks/quotas-skus-regions」を参照してください。 |
| vnet |
これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。 |
| workload |
ノードが実行できるワークロードの種類を決定します。 |
プロパティの詳細
name
Windows エージェント プール名は 6 文字以下にする必要があります。
name: stringプロパティ値
string
継承されたプロパティの詳細
availabilityZones
ノードに使用する可用性ゾーンの一覧。 これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。
availabilityZones?: string[]プロパティ値
string[]
継承元ManagedClusterAgentPoolProfileProperties.availabilityZones
capacityReservationGroupID
AKS は、指定されたエージェント プールを容量予約グループに関連付けます。
capacityReservationGroupID?: stringプロパティ値
string
継承元:ManagedClusterAgentPoolProfileProperties.capacityReservationGroupID
count
Docker コンテナーをホストするエージェント (VM) の数。 使用できる値は、ユーザー プールの場合は 0 から 1000 (含む) の範囲、システム プールの場合は 1 から 1000 (含む) の範囲である必要があります。 既定値は 1 です。
count?: numberプロパティ値
number
creationData
スナップショットを使用してノード プールを作成またはアップグレードする場合に、ソース スナップショット ID を指定するために使用する CreationData。
creationData?: CreationDataプロパティ値
enableAutoScaling
自動スケーラーを有効にするかどうか
enableAutoScaling?: booleanプロパティ値
boolean
継承元ManagedClusterAgentPoolProfileProperties.enableAutoScaling
enableCustomCATrust
true に設定すると、AKS はデーモンセットとホスト サービスをデプロイして、ユーザー指定の構成マップからノード信頼ストアにカスタム証明機関を同期します。 既定値は false です。
enableCustomCATrust?: booleanプロパティ値
boolean
継承元ManagedClusterAgentPoolProfileProperties.enableCustomCATrust
enableEncryptionAtHost
これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。
enableEncryptionAtHost?: booleanプロパティ値
boolean
継承元ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost
enableFIPS
enableNodePublicIP
シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受け取る必要がある場合があります。 一般的なシナリオは、ホップを最小限に抑えるために、コンソールがクラウド仮想マシンに直接接続する必要があるゲーム ワークロードです。 詳細については、ノードごとにパブリック IP を割り当てる
enableNodePublicIP?: booleanプロパティ値
boolean
継承元ManagedClusterAgentPoolProfileProperties.enableNodePublicIP
enableUltraSSD
UltraSSD を有効にするかどうか
enableUltraSSD?: booleanプロパティ値
boolean
gpuInstanceProfile
サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用される GPUInstanceProfile。
gpuInstanceProfile?: "MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"プロパティ値
"MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"
継承元ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile
hostGroupID
形式は /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}です。 詳細については、Azure 専用ホストの
hostGroupID?: stringプロパティ値
string
kubeletConfig
エージェント プール ノード上の Kubelet 構成。
kubeletConfig?: KubeletConfigプロパティ値
kubeletDiskType
emptyDir ボリューム、コンテナー ランタイム データ ルート、および Kubelet エフェメラル ストレージの配置を決定します。
kubeletDiskType?: "OS" | "Temporary"プロパティ値
"OS" | "Temporary"
linuxOSConfig
Linux エージェント ノードの OS 構成。
linuxOSConfig?: LinuxOSConfigプロパティ値
maxCount
自動スケーリングのノードの最大数
maxCount?: numberプロパティ値
number
maxPods
ノードで実行できるポッドの最大数。
maxPods?: numberプロパティ値
number
messageOfTheDay
デコード後に /etc/motd に書き込まれる base64 でエンコードされた文字列。 これにより、Linux ノードに対するその日のメッセージをカスタマイズできます。 Windows ノードには指定しないでください。 静的文字列である必要があります (つまり、生で出力され、スクリプトとして実行されません)。
messageOfTheDay?: stringプロパティ値
string
minCount
自動スケーリング用のノードの最小数
minCount?: numberプロパティ値
number
mode
クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、「https://docs.microsoft.com/azure/aks/use-system-pools」を参照してください。
mode?: "System" | "User"プロパティ値
"System" | "User"
nodeLabels
エージェント プール内のすべてのノードにわたって保持されるノード ラベル。
nodeLabels?: Record<string, string>プロパティ値
Record<string, string>
nodePublicIPPrefixID
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。
nodePublicIPPrefixID?: stringプロパティ値
string
継承元ManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID
nodeTaints
ノード プールの作成とスケーリング中に新しいノードに追加されたテイント。 たとえば、key=value:NoSchedule です。
nodeTaints?: string[]プロパティ値
string[]
orchestratorVersion
パッチ バージョン <major.minor.patch> と <major.minor> の両方がサポートされています。
<major.minor>を指定すると、サポートされている最新のパッチ バージョンが自動的に選択されます。 エージェント プールを同じ <major.minor> を作成した後に更新しても、新しいパッチ バージョンが使用可能な場合でもアップグレードはトリガーされません。 ベスト プラクティスとして、AKS クラスター内のすべてのノード プールを同じ Kubernetes バージョンにアップグレードする必要があります。 ノード プールのバージョンには、コントロール プレーンと同じメジャー バージョンが必要です。 ノード プールのマイナー バージョンは、コントロール プレーン バージョンの 2 つのマイナー バージョン内にある必要があります。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳しくは、ノード・プールのアップグレード
orchestratorVersion?: stringプロパティ値
string
継承元ManagedClusterAgentPoolProfileProperties.orchestratorVersion
osDiskSizeGB
マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定された vmSize に従って既定の osDisk サイズが適用されます。
osDiskSizeGB?: numberプロパティ値
number
osDiskType
VM でサポートされていて、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後に変更できない場合があります。 詳細については、「エフェメラル OS
osDiskType?: "Managed" | "Ephemeral"プロパティ値
"Managed" | "Ephemeral"
osSKU
エージェント プールで使用される OS SKU を指定します。 指定しない場合、既定値は OSType=Linux の場合は Ubuntu、OSType=Windows の場合は Windows2019 です。 また、Windows 2019 が非推奨になった後、既定の Windows OSSKU が Windows2022 に変更されます。
osSKU?: "Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"プロパティ値
"Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"
osType
オペレーティング システムの種類。 既定値は Linux です。
osType?: "Linux" | "Windows"プロパティ値
"Linux" | "Windows"
podSubnetID
省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、vnetSubnetID を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
podSubnetID?: stringプロパティ値
string
powerState
エージェント プールが最初に作成されるときは、最初に実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールは、実行中でプロビジョニング状態が成功した場合にのみ停止できます
powerState?: PowerStateプロパティ値
proximityPlacementGroupID
近接通信配置グループの ID。
proximityPlacementGroupID?: stringプロパティ値
string
継承元ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID
scaleDownMode
これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合は、既定で Delete に設定されます。
scaleDownMode?: "Delete" | "Deallocate"プロパティ値
"Delete" | "Deallocate"
scaleSetEvictionPolicy
scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。
scaleSetEvictionPolicy?: "Delete" | "Deallocate"プロパティ値
"Delete" | "Deallocate"
継承元ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy
scaleSetPriority
仮想マシン スケール セットの優先順位。 指定しない場合、既定値は 'Regular' です。
scaleSetPriority?: "Spot" | "Regular"プロパティ値
"Spot" | "Regular"
継承元ManagedClusterAgentPoolProfileProperties.scaleSetPriority
spotMaxPrice
tags
エージェント プールの仮想マシン スケール セットに保持されるタグ。
tags?: Record<string, string>プロパティ値
Record<string, string>
type
エージェント プールの種類。
type?: "VirtualMachineScaleSets" | "AvailabilitySet"プロパティ値
"VirtualMachineScaleSets" | "AvailabilitySet"
upgradeSettings
エージェント プールをアップグレードするための設定
upgradeSettings?: AgentPoolUpgradeSettingsプロパティ値
vmSize
VM サイズの可用性はリージョンによって異なります。 ノードに十分なコンピューティング リソース (メモリ、cpu など) が含まれている場合、ポッドが正常に実行されない可能性があります。 制限付き VM サイズの詳細については、「https://docs.microsoft.com/azure/aks/quotas-skus-regions」を参照してください。
vmSize?: stringプロパティ値
string
vnetSubnetID
これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
vnetSubnetID?: stringプロパティ値
string
workloadRuntime
ノードが実行できるワークロードの種類を決定します。
workloadRuntime?: "OCIContainer" | "WasmWasi"プロパティ値
"OCIContainer" | "WasmWasi"
