ManagedClusterAgentPoolProfile interface
コンテナー サービス エージェント プールのプロファイル。
- Extends
プロパティ
name | Windows エージェント プール名は 6 文字以下にする必要があります。 |
継承されたプロパティ
availability |
ノードに使用する可用性ゾーンの一覧。 これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。 |
capacity |
AKS は、指定されたエージェント プールを容量予約グループに関連付けます。 |
count | Docker コンテナーをホストするエージェント (VM) の数。 使用できる値は、ユーザー プールの場合は 0 から 1000 (含む) の範囲、システム プールの場合は 1 から 1000 (含む) の範囲である必要があります。 既定値は 1 です。 |
creation |
ノード プールを作成またはアップグレードする場合にソース スナップショット ID を指定するために使用する CreationData スナップショット。 |
current |
orchestratorVersion が完全に指定されたバージョン <の major.minor.patch> の場合、このフィールドは完全に同じになります。 orchestratorVersion が major.minor> の<場合、このフィールドには、使用されている完全な <major.minor.patch> バージョンが含まれます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
enable |
自動スケーラーを有効にするかどうか |
enable |
これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。 |
enable |
詳細については 、「FIPS 対応ノード プールの追加 」を参照してください。 |
enable |
シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受け取る必要がある場合があります。 一般的なシナリオとしては、ゲームのワークロードがあります。この場合、ホップを最小限に抑えるために、コンソールをクラウド仮想マシンに直接接続する必要があります。 詳細については、「 ノードごとにパブリック IP を割り当てる」を参照してください。 既定値は false です。 |
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 |
ノードで実行できるポッドの最大数。 |
min |
自動スケーリング用のノードの最小数 |
mode | クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、次を参照してください。 https://docs.microsoft.com/azure/aks/use-system-pools |
network |
エージェント プールのネットワーク関連の設定。 |
node |
ノード イメージのバージョン注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
node |
エージェント プール内のすべてのノードにわたって永続化されるノード ラベル。 |
node |
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。 |
node |
ノード プールの作成とスケーリング中に新しいノードに追加されたテイント。 たとえば、key=value:NoSchedule です。 |
orchestrator |
パッチ バージョン <major.minor.patch> (例: 1.20.13) と <major.minor> (例: 1.20) の両方がサポートされています。 major.minor> を指定すると<、サポートされている最新の GA パッチ バージョンが自動的に選択されます。 作成後に同じ <major.minor> (例: 1.14.x -> 1.14) でクラスターを更新しても、新しいパッチ バージョンが使用可能な場合でも、アップグレードはトリガーされません。 AKS クラスター内のノード プールは、すべて同じ Kubernetes のバージョンにアップグレードするのがベスト プラクティスです。 ノード プールのバージョンは、コントロール プレーンと同じメジャー バージョンである必要があります。 ノード プールの "マイナー" バージョンは、コントロール プレーンのバージョンの 2 つ以内の "マイナー" バージョンでなければなりません。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳細については、 ノード プールのアップグレードに関するページを参照してください。 |
os |
マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定された vmSize に従って既定の osDisk サイズが適用されます。 |
os |
VM でサポートされ、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後は変更できない場合があります。 詳細については、「 エフェメラル OS」を参照してください。 |
osSKU | エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 OSType が Windows の場合、Kubernetes <= 1.24 の場合は Windows2019、Kubernetes >= 1.25 の場合は Windows2022 が既定値です。 |
os |
オペレーティング システムの種類。 既定値は Linux です。 |
pod |
省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、「vnetSubnetID」を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。 |
power |
エージェント プールが最初に作成されたとき、最初は実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールを停止できるのは、エージェント プールが実行中で、プロビジョニング状態が [成功] の場合のみです |
provisioning |
現在のデプロイまたはプロビジョニングの状態。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
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} の形式です。 |
windows |
Windows エージェント プールの特定のプロファイル。 |
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
プロパティ値
ManagedClusterAgentPoolProfileProperties.creationDataから継承されます
currentOrchestratorVersion
orchestratorVersion が完全に指定されたバージョン <の major.minor.patch> の場合、このフィールドは完全に同じになります。 orchestratorVersion が major.minor> の<場合、このフィールドには、使用されている完全な <major.minor.patch> バージョンが含まれます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
currentOrchestratorVersion?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersionから継承されます
enableAutoScaling
自動スケーラーを有効にするかどうか
enableAutoScaling?: boolean
プロパティ値
boolean
ManagedClusterAgentPoolProfileProperties.enableAutoScalingから継承されます
enableEncryptionAtHost
これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。
enableEncryptionAtHost?: boolean
プロパティ値
boolean
ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHostから継承されます
enableFips
enableNodePublicIP
シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受け取る必要がある場合があります。 一般的なシナリオとしては、ゲームのワークロードがあります。この場合、ホップを最小限に抑えるために、コンソールをクラウド仮想マシンに直接接続する必要があります。 詳細については、「 ノードごとにパブリック IP を割り当てる」を参照してください。 既定値は false です。
enableNodePublicIP?: boolean
プロパティ値
boolean
ManagedClusterAgentPoolProfileProperties.enableNodePublicIPから継承
enableUltraSSD
UltraSSD を有効にするかどうか
enableUltraSSD?: boolean
プロパティ値
boolean
ManagedClusterAgentPoolProfileProperties.enableUltraSSDから継承されます
gpuInstanceProfile
サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用する GPUInstanceProfile。
gpuInstanceProfile?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.gpuInstanceProfileから継承されます
hostGroupID
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName} の形式です。 詳細については、「 Azure 専用ホスト」を参照してください。
hostGroupID?: string
プロパティ値
string
kubeletConfig
エージェント プール ノードの Kubelet 構成。
kubeletConfig?: KubeletConfig
プロパティ値
ManagedClusterAgentPoolProfileProperties.kubeletConfigから継承されます
kubeletDiskType
emptyDir ボリューム、コンテナー ランタイム データ ルート、および Kubelet エフェメラル ストレージの配置を決定します。
kubeletDiskType?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.kubeletDiskTypeから継承されます
linuxOSConfig
Linux エージェント ノードの OS 構成。
linuxOSConfig?: LinuxOSConfig
プロパティ値
ManagedClusterAgentPoolProfileProperties.linuxOSConfigから継承されます
maxCount
自動スケーリングのノードの最大数
maxCount?: number
プロパティ値
number
maxPods
ノードで実行できるポッドの最大数。
maxPods?: number
プロパティ値
number
minCount
自動スケーリング用のノードの最小数
minCount?: number
プロパティ値
number
mode
クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、次を参照してください。 https://docs.microsoft.com/azure/aks/use-system-pools
mode?: string
プロパティ値
string
networkProfile
エージェント プールのネットワーク関連の設定。
networkProfile?: AgentPoolNetworkProfile
プロパティ値
ManagedClusterAgentPoolProfileProperties.networkProfileから継承されます
nodeImageVersion
ノード イメージのバージョン注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
nodeImageVersion?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.nodeImageVersionから継承されます
nodeLabels
エージェント プール内のすべてのノードにわたって永続化されるノード ラベル。
nodeLabels?: {[propertyName: string]: string}
プロパティ値
{[propertyName: 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> (例: 1.20.13) と <major.minor> (例: 1.20) の両方がサポートされています。 major.minor> を指定すると<、サポートされている最新の GA パッチ バージョンが自動的に選択されます。 作成後に同じ <major.minor> (例: 1.14.x -> 1.14) でクラスターを更新しても、新しいパッチ バージョンが使用可能な場合でも、アップグレードはトリガーされません。 AKS クラスター内のノード プールは、すべて同じ Kubernetes のバージョンにアップグレードするのがベスト プラクティスです。 ノード プールのバージョンは、コントロール プレーンと同じメジャー バージョンである必要があります。 ノード プールの "マイナー" バージョンは、コントロール プレーンのバージョンの 2 つ以内の "マイナー" バージョンでなければなりません。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳細については、 ノード プールのアップグレードに関するページを参照してください。
orchestratorVersion?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.orchestratorVersionから継承されます
osDiskSizeGB
マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定された vmSize に従って既定の osDisk サイズが適用されます。
osDiskSizeGB?: number
プロパティ値
number
ManagedClusterAgentPoolProfileProperties.osDiskSizeGBから継承されます
osDiskType
VM でサポートされ、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後は変更できない場合があります。 詳細については、「 エフェメラル OS」を参照してください。
osDiskType?: string
プロパティ値
string
osSKU
エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 OSType が Windows の場合、Kubernetes <= 1.24 の場合は Windows2019、Kubernetes >= 1.25 の場合は Windows2022 が既定値です。
osSKU?: string
プロパティ値
string
osType
オペレーティング システムの種類。 既定値は Linux です。
osType?: string
プロパティ値
string
podSubnetID
省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、「vnetSubnetID」を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
podSubnetID?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.podSubnetIDから継承されます
powerState
エージェント プールが最初に作成されたとき、最初は実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールを停止できるのは、エージェント プールが実行中で、プロビジョニング状態が [成功] の場合のみです
powerState?: PowerState
プロパティ値
provisioningState
現在のデプロイまたはプロビジョニングの状態。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.provisioningStateから継承されます
proximityPlacementGroupID
近接配置グループの ID。
proximityPlacementGroupID?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupIDから継承されます
scaleDownMode
これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合、既定では Delete になります。
scaleDownMode?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.scaleDownModeから継承されます
scaleSetEvictionPolicy
scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。
scaleSetEvictionPolicy?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicyから継承されます
scaleSetPriority
仮想マシン スケール セットの優先度。 指定しない場合、既定値は 'Regular' です。
scaleSetPriority?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.scaleSetPriorityから継承されます
spotMaxPrice
使用できる値は、0 より大きい 10 進値または -1 です。これは、オンデマンド価格を支払う意欲を示します。 スポット価格の詳細については、「スポット VM の価格」を参照してください。
spotMaxPrice?: number
プロパティ値
number
ManagedClusterAgentPoolProfileProperties.spotMaxPriceから継承されます
tags
エージェント プール仮想マシン スケール セットに永続化するタグ。
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
type
upgradeSettings
エージェント プールをアップグレードするための設定
upgradeSettings?: AgentPoolUpgradeSettings
プロパティ値
ManagedClusterAgentPoolProfileProperties.upgradeSettingsから継承
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
ManagedClusterAgentPoolProfileProperties.vnetSubnetIDから継承されます
windowsProfile
Windows エージェント プールの特定のプロファイル。
windowsProfile?: AgentPoolWindowsProfile
プロパティ値
ManagedClusterAgentPoolProfileProperties.windowsProfileから継承されます
workloadRuntime
ノードが実行できるワークロードの種類を決定します。
workloadRuntime?: string
プロパティ値
string
ManagedClusterAgentPoolProfileProperties.workloadRuntimeから継承されます