AgentPool interface

ノードに使用する可用性ゾーンの一覧。 これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。

availabilityZones?: string[]

プロパティ値

AKS は、指定されたエージェント プールを容量予約グループに関連付けます。

capacityReservationGroupID?: string

プロパティ値

Docker コンテナーをホストするエージェント (VM) の数。 使用できる値は、ユーザー プールの場合は 0 から 1000 (含む) の範囲、システム プールの場合は 1 から 1000 (含む) の範囲である必要があります。 既定値は 1 です。

count?: number

プロパティ値

スナップショットを使用してノード プールを作成またはアップグレードする場合に、ソース スナップショット ID を指定するために使用する CreationData。

creationData?: CreationData

プロパティ値

orchestratorVersion が major.minor.patch><完全に指定されたバージョンである場合、このフィールドは完全に同じになります。 orchestratorVersion が major.minor><場合、このフィールドには、使用されている major.minor.patch> バージョン全体 <含まれます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentOrchestratorVersion?: string

プロパティ値

自動スケーラーを有効にするかどうか

enableAutoScaling?: boolean

プロパティ値

これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。

enableEncryptionAtHost?: boolean

プロパティ値

詳細については、「FIPS 対応ノード プール の追加」を参照してください。

enableFips?: boolean

プロパティ値

シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受け取る必要がある場合があります。 一般的なシナリオは、ホップを最小限に抑えるために、コンソールがクラウド仮想マシンに直接接続する必要があるゲーム ワークロードです。 詳細については、ノードごとにパブリック IP を割り当てる を参照してください。 既定値は false です。

enableNodePublicIP?: boolean

プロパティ値

UltraSSD を有効にするかどうか

enableUltraSSD?: boolean

プロパティ値

オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 通常の etag 規則に従ってオプティミスティック コンカレンシーを有効にするには、後続の要求の eTag 値を持つ if-match ヘッダーまたは if-none-match ヘッダーを指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

eTag?: string

プロパティ値

サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用される GPUInstanceProfile。

gpuInstanceProfile?: string

プロパティ値

形式は /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}です。 詳細については、Azure 専用ホストのに関するページを参照してください。

hostGroupID?: string

プロパティ値

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

kubeletConfig?: KubeletConfig

プロパティ値

emptyDir ボリューム、コンテナー ランタイム データ ルート、および Kubelet エフェメラル ストレージの配置を決定します。

kubeletDiskType?: string

プロパティ値

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

linuxOSConfig?: LinuxOSConfig

プロパティ値

自動スケーリングのノードの最大数

maxCount?: number

プロパティ値

ノードで実行できるポッドの最大数。

maxPods?: number

プロパティ値

自動スケーリング用のノードの最小数

minCount?: number

プロパティ値

クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、「https://docs.microsoft.com/azure/aks/use-system-pools」を参照してください。

mode?: string

プロパティ値

エージェント プールのネットワーク関連の設定。

networkProfile?: AgentPoolNetworkProfile

プロパティ値

ノード イメージのバージョン注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

nodeImageVersion?: string

プロパティ値

エージェント プール内のすべてのノードにわたって保持されるノード ラベル。

nodeLabels?: {[propertyName: string]: string}

プロパティ値

これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。

nodePublicIPPrefixID?: string

プロパティ値

ノード プールの作成とスケーリング中に新しいノードに追加されたテイント。 たとえば、key=value:NoSchedule です。

nodeTaints?: string[]

プロパティ値

パッチ バージョン <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

プロパティ値

マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定された vmSize に従って既定の osDisk サイズが適用されます。

osDiskSizeGB?: number

プロパティ値

VM でサポートされていて、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後に変更できない場合があります。 詳細については、「エフェメラル OSを参照してください。

osDiskType?: string

プロパティ値

エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 既定値は、Kubernetes <= 1.24 の場合は Windows 2019、OSType が Windows の場合は Kubernetes >= 1.25 の場合は Windows2022 です。

osSKU?: string

プロパティ値

オペレーティング システムの種類。 既定値は Linux です。

osType?: string

プロパティ値

省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、vnetSubnetID を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。

podSubnetID?: string

プロパティ値

エージェント プールが最初に作成されるときは、最初に実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールは、実行中でプロビジョニング状態が成功した場合にのみ停止できます

powerState?: PowerState

プロパティ値

現在のデプロイまたはプロビジョニングの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

近接通信配置グループの ID。

proximityPlacementGroupID?: string

プロパティ値

これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合は、既定で Delete に設定されます。

scaleDownMode?: string

プロパティ値

scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。

scaleSetEvictionPolicy?: string

プロパティ値

仮想マシン スケール セットの優先順位。 指定しない場合、既定値は 'Regular' です。

scaleSetPriority?: string

プロパティ値

エージェント プールのセキュリティ設定。

securityProfile?: AgentPoolSecurityProfile

プロパティ値

指定できる値は、0 より大きい任意の 10 進値またはオンデマンド価格を支払う意欲を示す -1 です。 スポット価格の詳細については、スポット VM の価格 を参照してください。

spotMaxPrice?: number

プロパティ値

エージェント プールの仮想マシン スケール セットに保持されるタグ。

tags?: {[propertyName: string]: string}

プロパティ値

エージェント プールの種類。

typePropertiesType?: string

プロパティ値

エージェント プールをアップグレードするための設定

upgradeSettings?: AgentPoolUpgradeSettings

プロパティ値

VM サイズの可用性はリージョンによって異なります。 ノードに十分なコンピューティング リソース (メモリ、cpu など) が含まれている場合、ポッドが正常に実行されない可能性があります。 制限付き VM サイズの詳細については、「https://docs.microsoft.com/azure/aks/quotas-skus-regions」を参照してください。

vmSize?: string

プロパティ値

これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。

vnetSubnetID?: string

プロパティ値

Windows エージェント プールの特定のプロファイル。

windowsProfile?: AgentPoolWindowsProfile

プロパティ値

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

workloadRuntime?: string

プロパティ値

リソース ID。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

SubResource.id から継承された

リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

SubResource.name から継承された

リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

SubResource.type から継承