次の方法で共有

Agent Pools - Get

サービス:
AKS
API バージョン:
2025-10-01

指定したマネージド クラスター エージェント プールを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2025-10-01

URI パラメーター

名前 / 必須 型 説明
agentPoolName
 path True

string

minLength: 1
maxLength: 12
pattern: ^[a-z][a-z0-9]{0,11}$

エージェント プールの名前。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前は大文字と小文字が区別されます。
resourceName
 path True

string

minLength: 1
maxLength: 63
pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

管理対象クラスター・リソースの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

AgentPool

[OK]
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザーアカウントになりすます

例

Get Agent Pool

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-10-01

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "eTag": "ebwiyfneowv",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
    "upgradeSettings": {
      "maxSurge": "33%"
    }
  }
}

定義

名前 説明
AgentPool

エージェント プール。
AgentPoolGatewayProfile

マネージド クラスター ゲートウェイ エージェント プールのプロファイル。
AgentPoolMode

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

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

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

エージェント プールの SSH アクセス方法。
AgentPoolStatus

エージェント プールに関する読み取り専用情報が含まれています。
AgentPoolType

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

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

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

クラスターが実行中か停止かを示します
CreationData

ソース リソースからターゲット リソースを作成するときに使用されるデータ。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
GPUDriver

GPU ドライバーをインストールするかどうか。 指定されていない場合、既定値は Install です。
GPUInstanceProfile

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

エージェント プールの GPU 設定。
IPTag

オブジェクトに関連付けられている IPTag を格納します。
KubeletConfig

エージェント ノードの Kubelet 構成。 詳細については、AKS カスタム ノード構成 を参照してください。
KubeletDiskType

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

Linux エージェント ノードの OS 構成。 詳細については、AKS カスタム ノード構成 を参照してください。
LocalDNSForwardDestination

localDNS から転送される DNS クエリの宛先サーバー。
LocalDNSForwardPolicy

アップストリーム DNS サーバーを選択するための転送ポリシー。 詳細については、 フォワードプラグイン を参照してください。
LocalDNSMode

localDNS の有効化モード。
LocalDNSOverride

localDNS プロファイルをオーバーライドします。
LocalDNSProfile

ノードごとのローカル DNS を VnetDNS と KubeDNS のオーバーライドを使用して構成します。 LocalDNS は、AKS クラスターでの DNS 解決のパフォーマンスと信頼性を向上させるのに役立ちます。 詳細については、「aka.ms/aks/localdns」を参照してください。
LocalDNSProtocol

TCPを強制するか、localDNSからアップストリームDNSサーバーへの接続にUDPプロトコルを優先します。
LocalDNSQueryLogging

localDNS の DNS クエリのログ レベル。
LocalDNSServeStale

古いデータを提供するためのポリシー。 詳細については、 キャッシュプラグイン を参照してください。
LocalDNSState

localDNS のシステム生成状態。
ManualScaleProfile

マシンの数に関する仕様。
OSDiskType

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

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

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

ポッド IP 割り当てモード。 エージェント プール内のポッドの IP 割り当てモード。 podSubnetId と共に使用する必要があります。 既定値は "DynamicIndividual" です。
PortRange

ポート範囲。
PowerState

クラスターの電源状態について説明します
Protocol

ポートのネットワーク プロトコル。
ScaleDownMode

VM をエージェント プールに追加またはエージェント プールから削除する方法について説明します。 「 課金状態」を参照してください。
ScaleProfile

VirtualMachines エージェント プールのスケーリング方法に関する仕様。
ScaleSetEvictionPolicy

仮想マシン スケール セットの削除ポリシー。 削除ポリシーは、VMが削除されたときにVMをどうするかを指定します。 デフォルトは [削除] です。 削除の詳細については、「スポット VM」を参照してください
ScaleSetPriority

仮想マシン スケール セットの優先順位。
SysctlConfig

Linux エージェント ノードの Sysctl 設定。
UndrainableNodeBehavior

アップグレード中の、使用できないノードの動作を定義します。 ノードを使用できない最も一般的な原因はポッド中断予算 (PDB) ですが、ポッドの終了猶予期間が残りのノードごとのドレイン タイムアウトを超えたり、ポッドがまだ実行中の状態であるなど、他の問題が原因で、セッション不可能なノードが発生する可能性もあります。
VirtualMachineNodes

同じ VM サイズのノード グループの現在の状態。
VirtualMachinesProfile

VirtualMachines エージェント プールの仕様。
WorkloadRuntime

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

AgentPool

Object

エージェント プール。

名前 型 規定値 説明
id

string

リソース ID。
name

string

リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。
properties.availabilityZones

string[]

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

string (arm-id)

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

integer (int32)

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

CreationData

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

string

エージェント プールが実行されている Kubernetes のバージョン。 orchestratorVersion が major.minor.patch<>完全に指定されたバージョンである場合、このフィールドは完全に同じになります。 orchestratorVersion が major.minor<>場合、このフィールドには、使用されている major.minor.patch< バージョン全体 >含まれます。
properties.eTag

string

オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 後続のリクエストの eTag 値を含む if-match または if-none-match ヘッダーを指定して、通常の eTag 規則に従ってオプティミスティック同時実行を有効にします。
properties.enableAutoScaling

boolean

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

boolean

ホスト ベースの OS とデータ ドライブの暗号化を有効にするかどうか。 これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。
properties.enableFIPS

boolean

FIPS 対応 OS を使用するかどうか。 詳細については、「FIPS 対応ノード プール の追加」を参照してください。
properties.enableNodePublicIP

boolean

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

boolean

UltraSSD を有効にするかどうか
properties.gatewayProfile

AgentPoolGatewayProfile

ゲートウェイ モードのマネージド エージェント プールに固有のプロファイル。 エージェント プール モードがゲートウェイでない場合は、このフィールドを設定できません。
properties.gpuInstanceProfile

GPUInstanceProfile

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

GPUProfile

エージェント プールの GPU 設定。
properties.hostGroupID

string (arm-id)

仮想マシンをプロビジョニングする専用ホスト グループの完全修飾リソース ID。作成シナリオでのみ使用され、設定後の変更は許可されません。 形式は /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}です。 詳細については、Azure 専用ホストのに関するページを参照してください。
properties.kubeletConfig

KubeletConfig

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

KubeletDiskType

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

LinuxOSConfig

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

LocalDNSProfile

ノードごとのローカル DNS を VnetDNS と KubeDNS のオーバーライドを使用して構成します。 LocalDNS は、AKS クラスターでの DNS 解決のパフォーマンスと信頼性を向上させるのに役立ちます。 詳細については、「aka.ms/aks/localdns」を参照してください。
properties.maxCount

integer (int32)

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

integer (int32)

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

string

Base64 でエンコードされた Linux ノードの日のメッセージ。 デコード後に /etc/motd に書き込まれる base64 でエンコードされた文字列。 これにより、Linux ノードに対するその日のメッセージをカスタマイズできます。 Windows ノードには指定しないでください。 静的文字列である必要があります (つまり、生で出力され、スクリプトとして実行されません)。
properties.minCount

integer (int32)

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

AgentPoolMode

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

AgentPoolNetworkProfile

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

string

ノード イメージのバージョン
properties.nodeLabels

object

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

string (arm-id)

VM ノードが IP を使用するパブリック IP プレフィックス ID。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。
properties.nodeTaints

string[]

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

string

ユーザーによって指定された Kubernetes のバージョン。 パッチ バージョン <major.minor.patch> (1.20.13 など) と <major.minor> (1.20 など) の両方がサポートされています。 major.minor<>指定すると、サポートされている最新の GA パッチ バージョンが自動的に選択されます。 クラスターの作成後に同じ <major.minor> を使用してクラスターを更新しても (例: 1.14.x -> 1.14)、新しいパッチ バージョンが使用可能な場合でも、アップグレードはトリガーされません。 ベスト プラクティスとして、AKS クラスター内のすべてのノード プールを同じ Kubernetes バージョンにアップグレードする必要があります。 ノード プールのバージョンには、コントロール プレーンと同じメジャー バージョンが必要です。 ノード プールのマイナー バージョンは、コントロール プレーン バージョンの 2 つのマイナー バージョン内にある必要があります。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳しくは、ノード・プールのアップグレード を参照してください。
properties.osDiskSizeGB

integer (int32)

minimum: 0
maximum: 2048

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

OSDiskType

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

OSSKU

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

OSType

Linux

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

PodIPAllocationMode

ポッド IP 割り当てモード。 エージェント プール内のポッドの IP 割り当てモード。 podSubnetId と共に使用する必要があります。 既定値は "DynamicIndividual" です。
properties.podSubnetID

string (arm-id)

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

PowerState

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

string

現在のデプロイまたはプロビジョニングの状態。
properties.proximityPlacementGroupID

string (arm-id)

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

ScaleDownMode

エージェント プールをスケーリングするときに使用するスケール ダウン モード。 これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合は、既定で Delete に設定されます。
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

使用する仮想マシン スケール セットの削除ポリシー。 scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。
properties.scaleSetPriority

ScaleSetPriority

Regular

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

AgentPoolSecurityProfile

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

number

-1

スポット インスタンスに対して支払う最大価格 (米ドル)。 使用できる値は、0 より大きい任意の 10 進値、または既定の価格がオンデマンドで up-to されることを示す -1 です。 指定できる値は、0 より大きい任意の 10 進値またはオンデマンド価格を支払う意欲を示す -1 です。 スポット価格の詳細については、スポット VM の価格 を参照してください。
properties.status

AgentPoolStatus

エージェント プールに関する読み取り専用情報が含まれています。
properties.tags

object

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

AgentPoolType

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

AgentPoolUpgradeSettings

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

VirtualMachineNodes[]

VirtualMachines エージェント プール内のノードの状態。
properties.virtualMachinesProfile

VirtualMachinesProfile

VirtualMachines エージェント プールの仕様。
properties.vmSize

string

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

string (arm-id)

エージェント プール ノードと必要に応じてポッドが起動時に参加するサブネットの ID。 これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
properties.windowsProfile

AgentPoolWindowsProfile

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

WorkloadRuntime

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

string

リソースの種類

AgentPoolGatewayProfile

Object

マネージド クラスター ゲートウェイ エージェント プールのプロファイル。

名前 型 規定値 説明
publicIPPrefixSize

integer (int32)

minimum: 28
maximum: 31 		31

ゲートウェイ エージェント プールは、静的エグレス ゲートウェイごとに 1 つのパブリック IPPrefix を関連付けて、パブリック エグレスを提供します。 パブリック IPPrefix のサイズは、ユーザーが選択する必要があります。 エージェント プール内の各ノードには、IPPrefix から 1 つの IP が割り当てられます。 IPPrefix サイズは、ゲートウェイ エージェント プールのサイズの上限として機能します。 Azure パブリック IPPrefix サイズの制限により、有効な値の範囲は [28, 31] です (/31 = 2 ノード/IP、/30 = 4 ノード/IP、/29 = 8 ノード/IP、/28 = 16 ノード/IP)。 既定値は 31 です。

AgentPoolMode

列挙

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

値 説明
System

システムエージェントプールは、主にCoreDNSやmetrics-serverなどの重要なシステムポッドをホストするためのものです。 システム エージェント プールの osType は Linux である必要があります。 システム エージェント プール VM SKU には、少なくとも 2vCPU と 4 GB のメモリが必要です。
User

ユーザー・エージェント・プールは、主にアプリケーション・ポッドをホストするためのものです。
Gateway

ゲートウェイ・エージェント・プールは、ポッドに静的エグレス IP を提供することに特化しています。 詳細については、 https://aka.ms/aks/static-egress-gatewayを参照してください。

AgentPoolNetworkProfile

Object

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

名前 型 説明
allowedHostPorts

PortRange[]

アクセスが許可されているポート範囲。 指定した範囲は重複できます。
applicationSecurityGroups

string[] (arm-id)

エージェント プールの作成時に関連付けるアプリケーション セキュリティ グループの ID。
nodePublicIPTags

IPTag[]

インスタンス レベルのパブリック IP の IP タグ。

AgentPoolSecurityProfile

Object

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

名前 型 説明
enableSecureBoot

boolean

セキュア ブートは、署名されたオペレーティング システムとドライバーのみが起動できるようにする、トラステッド起動の機能です。 詳細については、aka.ms/aks/trustedlaunch を参照してください。 指定しない場合、既定値は false です。
enableVTPM

boolean

vTPM は、ノード上でローカルに保持されているキーと測定用に専用のセキュリティで保護されたコンテナーを構成するための信頼できる起動機能です。 詳細については、aka.ms/aks/trustedlaunch を参照してください。 指定しない場合、既定値は false です。
sshAccess

AgentPoolSSHAccess

エージェント プールの SSH アクセス方法。

AgentPoolSSHAccess

列挙

エージェント プールの SSH アクセス方法。

値 説明
LocalUser

秘密キーを使用してローカル ユーザーとしてノードに SSH 接続できます。
Disabled

ノードで SSH サービスがオフになります。

AgentPoolStatus

Object

エージェント プールに関する読み取り専用情報が含まれています。

名前 型 説明
provisioningError

ErrorDetail

エージェント プールのエラー詳細情報。 失敗の詳細情報を保持します。 エラーがなかった場合、このフィールドは省略されます。

AgentPoolType

列挙

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

値 説明
VirtualMachineScaleSets

仮想マシン スケール セットによってサポートされるエージェント プールを作成します。
AvailabilitySet

この使用は強くお勧めしません。
VirtualMachines

単一インスタンスVMオーケストレーションモードによってサポートされるエージェントプールを作成します。

AgentPoolUpgradeSettings

Object

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

名前 型 説明
drainTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 1440

ノードのドレイン タイムアウト。 ポッドの削除とノードごとのグレースフル終了を待機する時間 (分単位)。 この削除待機時間は、ポッドの中断予算の待機を優先します。 この時間を超えると、アップグレードは失敗します。 指定されていない場合、既定値は 30 分です。
maxSurge

string

アップグレード中に急増したノードの最大数または割合。 これは、整数 (例: '5') またはパーセンテージ (例: '50%') に設定できます。 パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。 パーセンテージの場合、小数部のノードは切り上げられます。 指定しない場合、既定値は 10%です。 ベスト プラクティスを含む詳細については、以下を参照してください。 https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable

string

アップグレード中に同時に使用できないノードの最大数または割合。 これは、整数 (例: '1') またはパーセンテージ (例: '5%') に設定できます。 パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。 パーセンテージの場合、小数部のノードは切り上げられます。 指定しない場合、既定値は 0 です。 ベスト プラクティスを含む詳細については、以下を参照してください。 https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes

integer (int32)

minimum: 0
maximum: 30

ノードのソーク時間。 ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。 指定しない場合、既定値は 0 分です。
undrainableNodeBehavior

UndrainableNodeBehavior

アップグレード中の、使用できないノードの動作を定義します。 ノードを使用できない最も一般的な原因はポッド中断予算 (PDB) ですが、ポッドの終了猶予期間が残りのノードごとのドレイン タイムアウトを超えたり、ポッドがまだ実行中の状態であるなど、他の問題が原因で、セッション不可能なノードが発生する可能性もあります。

AgentPoolWindowsProfile

Object

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

名前 型 説明
disableOutboundNat

boolean

Windows ノードで OutboundNAT を無効にするかどうか。 既定値は false です。 送信 NAT を無効にできるのは、クラスターの outboundType が NAT ゲートウェイであり、Windows エージェント プールでノード パブリック IP が有効になっていない場合のみです。

code

列挙

クラスターが実行中か停止かを示します

値 説明
Running

クラスターは実行中です。
Stopped

クラスターが停止します。

CreationData

Object

ソース リソースからターゲット リソースを作成するときに使用されるデータ。

名前 型 説明
sourceResourceId

string (arm-id)

これは、ターゲット オブジェクトの作成に使用するソース オブジェクトの ARM ID です。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

GPUDriver

列挙

GPU ドライバーをインストールするかどうか。 指定されていない場合、既定値は Install です。

値 説明
Install

ドライバをインストールします。
None

ドライバーのインストールをスキップします。

GPUInstanceProfile

列挙

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

値 説明
MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

GPUProfile

Object

エージェント プールの GPU 設定。

名前 型 説明
driver

GPUDriver

GPU ドライバーをインストールするかどうか。 指定されていない場合、既定値は Install です。

IPTag

Object

オブジェクトに関連付けられている IPTag を格納します。

名前 型 説明
ipTagType

string

IP タグの種類。 例: RoutingPreference。
tag

string

パブリック IP に関連付けられている IP タグの値。 例: インターネット。

KubeletConfig

Object

エージェント ノードの Kubelet 構成。 詳細については、AKS カスタム ノード構成 を参照してください。

名前 型 説明
allowedUnsafeSysctls

string[]

安全でない sysctl または安全でない sysctl パターンの許可されたリスト ( *で終わる)。
containerLogMaxFiles

integer (int32)

minimum: 2

コンテナーに存在できるコンテナー ログ ファイルの最大数。 数値は 2 ≥する必要があります。
containerLogMaxSizeMB

integer (int32)

ローテーション前のコンテナー ログ ファイルの最大サイズ (10Mi など)。
cpuCfsQuota

boolean

CPU 制限を指定するコンテナーに対して CPU CFS クォータの適用が有効になっている場合。 既定値は true です。
cpuCfsQuotaPeriod

string

CPU CFS クォータ期間の値。 既定値は '100 ミリ秒' です。 有効な値は、省略可能な分数と単位サフィックスを持つ 10 進数のシーケンスです。 例: '300ms'、'2h45m'。 サポートされるユニットは、'ns'、'us'、'ms'、's'、'm'、および 'h' です。
cpuManagerPolicy

string

使用する CPU マネージャー ポリシー。 既定値は 'none' です。 詳細については、 Kubernetes CPU 管理ポリシーを 参照してください。 使用できる値は 'none' と 'static' です。
failSwapOn

boolean

true に設定すると、ノードでスワップが有効になっている場合、Kubelet の起動に失敗します。
imageGcHighThreshold

integer (int32)

イメージ ガベージ コレクションが常に実行された後のディスク使用率。 イメージ ガベージ コレクションを無効にするには、100 に設定します。 既定値は 85%
imageGcLowThreshold

integer (int32)

イメージ ガベージ コレクションが実行されない前のディスク使用率。 imageGcHighThreshold より高く設定することはできません。 既定値は 80%
podMaxPids

integer (int32)

ポッドあたりのプロセスの最大数。
topologyManagerPolicy

string

使用するトポロジ マネージャー ポリシー。 詳細については、「 Kubernetes Topology Manager」を参照してください。 既定値は 'none' です。 使用できる値は、'none'、'best-effort'、'restricted'、および 'single-numa-node' です。

KubeletDiskType

列挙

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

値 説明
OS

Kubeletは、そのデータにOSディスクを使用します。
Temporary

Kubelet は、そのデータに一時ディスクを使用します。

LinuxOSConfig

Object

Linux エージェント ノードの OS 構成。 詳細については、AKS カスタム ノード構成 を参照してください。

名前 型 説明
swapFileSizeMB

integer (int32)

各ノードに作成されるスワップ ファイルのサイズ (MB)。
sysctls

SysctlConfig

Linux エージェント ノードの Sysctl 設定。
transparentHugePageDefrag

string

より多くの巨大なページを使用できるように、カーネルがメモリ圧縮を積極的に使用する必要があるかどうか。 有効な値は、'always'、'defer'、'defer+madvise'、'madvise' および 'never' です。 既定値は 'madvise' です。 詳細については、「Transparent Hugepages」を参照してください。
transparentHugePageEnabled

string

透過的な hugepages が有効になっているかどうか。 有効な値は、'always'、'madvise'、および 'never' です。 既定値は "always" です。 詳細については、「Transparent Hugepages」を参照してください。

LocalDNSForwardDestination

列挙

localDNS から転送される DNS クエリの宛先サーバー。

値 説明
ClusterCoreDNS

localDNS からクラスター CoreDNS に DNS クエリを転送します。
VnetDNS

localDNS から VNET で構成された DNS サーバーに DNS クエリを転送します。 VNET には、複数の DNS サーバーを構成できます。

LocalDNSForwardPolicy

列挙

アップストリーム DNS サーバーを選択するための転送ポリシー。 詳細については、 フォワードプラグイン を参照してください。

値 説明
Sequential

アップストリーム DNS サーバーのシーケンシャル選択を実装します。 詳細については、 フォワードプラグイン を参照してください。
RoundRobin

ラウンドロビンアップストリームDNSサーバの選択を実装します。 詳細については、 フォワードプラグイン を参照してください。
Random

ランダムなアップストリーム DNS サーバーの選択を実装します。 詳細については、 フォワードプラグイン を参照してください。

LocalDNSMode

列挙

localDNS の有効化モード。

値 説明
Preferred

現在のオーケストレーター バージョンがこの機能をサポートしている場合は、localDNS を有効にすることをお勧めします。
Required

localDNS を有効にします。
Disabled

localDNS を無効にします。

LocalDNSOverride

Object

localDNS プロファイルをオーバーライドします。

名前 型 規定値 説明
cacheDurationInSeconds

integer (int32)

3600

最大TTLを秒単位でキャッシュします。 詳細については、 キャッシュプラグイン を参照してください。
forwardDestination

LocalDNSForwardDestination

ClusterCoreDNS

localDNS から転送される DNS クエリの宛先サーバー。
forwardPolicy

LocalDNSForwardPolicy

Sequential

アップストリーム DNS サーバーを選択するための転送ポリシー。 詳細については、 フォワードプラグイン を参照してください。
maxConcurrent

integer (int32)

1000

同時クエリの最大数。 詳細については、 フォワードプラグイン を参照してください。
protocol

LocalDNSProtocol

PreferUDP

TCPを強制するか、localDNSからアップストリームDNSサーバーへの接続にUDPプロトコルを優先します。
queryLogging

LocalDNSQueryLogging

Error

localDNS の DNS クエリのログ レベル。
serveStale

LocalDNSServeStale

Immediate

古いデータを提供するためのポリシー。 詳細については、 キャッシュプラグイン を参照してください。
serveStaleDurationInSeconds

integer (int32)

3600

古い時間(秒単位)を提供します。 詳細については、 キャッシュプラグイン を参照してください。

LocalDNSProfile

Object

ノードごとのローカル DNS を VnetDNS と KubeDNS のオーバーライドを使用して構成します。 LocalDNS は、AKS クラスターでの DNS 解決のパフォーマンスと信頼性を向上させるのに役立ちます。 詳細については、「aka.ms/aks/localdns」を参照してください。

名前 型 規定値 説明
kubeDNSOverrides

<string,  LocalDNSOverride>

KubeDNSのオーバーライドは、dnsPolicy:ClusterFirstを持つポッドからのDNSトラフィック(KubeDNSトラフィックと呼ばれます)に適用されます。
mode

LocalDNSMode

Preferred

localDNS の有効化モード。
state

LocalDNSState

localDNS のシステム生成状態。
vnetDNSOverrides

<string,  LocalDNSOverride>

VnetDNS オーバーライドは、dnsPolicy:default または kubelet を持つポッドからの DNS トラフィック (VnetDNS トラフィックと呼ばれます) に適用されます。

LocalDNSProtocol

列挙

TCPを強制するか、localDNSからアップストリームDNSサーバーへの接続にUDPプロトコルを優先します。

値 説明
PreferUDP

localDNS からアップストリーム DNS サーバーへの接続には UDP プロトコルを優先します。
ForceTCP

localDNS からアップストリーム DNS サーバーへの接続に TCP プロトコルを適用します。

LocalDNSQueryLogging

列挙

localDNS の DNS クエリのログ レベル。

値 説明
Error

localDNS でのエラーログを有効にします。 詳細については、 errors プラグイン を参照してください。
Log

localDNS でのクエリ ログを有効にします。 詳細については、 log plugin を参照してください。

LocalDNSServeStale

列挙

古いデータを提供するためのポリシー。 詳細については、 キャッシュプラグイン を参照してください。

値 説明
Verify

古いデータを検証で提供します。 まず、期限切れのエントリをクライアントに送信する前に、ソースからエントリがまだ使用できないことを確認します。 詳細については、 キャッシュプラグイン を参照してください。
Immediate

古いデータをすぐに提供します。 期限切れのエントリをクライアントに送信してから、エントリがソースから使用可能かどうかを確認します。 詳細については、 キャッシュプラグイン を参照してください。
Disable

古いデータの提供を無効にします。

LocalDNSState

列挙

localDNS のシステム生成状態。

値 説明
Enabled

localDNS が有効になっている場合。
Disabled

localDNS は無効です。

ManualScaleProfile

Object

マシンの数に関する仕様。

名前 型 説明
count

integer (int32)

ノードの数。
size

string

AKS が作成およびスケーリングするときに使用する VM サイズ (例: "Standard_E4s_v3"、"Standard_E16s_v3"、"Standard_D16s_v5")。

OSDiskType

列挙

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

値 説明
Managed

Azure は、仮想マシンのオペレーティング システム ディスクを Azure Storage にレプリケートして、VM を別のホストに再配置する必要がある場合のデータ損失を回避します。 コンテナーはローカル状態を保持するように設計されていないため、この動作では値が制限されますが、ノードのプロビジョニング速度の低下や読み取り/書き込みの待機時間の長さなど、いくつかの欠点があります。
Ephemeral

エフェメラル OS ディスクは、一時ディスクと同様に、ホスト マシンにのみ格納されます。 これにより、読み取り/書き込みの待機時間が短くなり、ノードのスケーリングとクラスターのアップグレードが高速化されます。

OSSKU

列挙

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

値 説明
AzureLinux

ノード イメージの OS として AzureLinux を使用します。 Azure Linux は、Microsoft によって構築されたコンテナー最適化 Linux ディストリビューションです。詳細については、https://aka.ms/azurelinux を参照してください。
AzureLinux3

ノード イメージの OS として AzureLinux3 を使用します。 Azure Linux は、Microsoft によって構築されたコンテナー最適化 Linux ディストリビューションです。詳細については、https://aka.ms/azurelinux を参照してください。 制限事項については、 https://aka.ms/aks/node-images をご覧ください。 OS 移行のガイダンスについては、「 https://aka.ms/aks/upgrade-os-version」を参照してください。
CBLMariner

非推奨の OSSKU。 新しいデプロイでは、代わりに "AzureLinux" を選択することをお勧めします。
Ubuntu

ノード イメージの OS として Ubuntu を使用します。
Ubuntu2204

ノードイメージのOSとしてUbuntu2204を使用しますが、Ubuntu 22.04がすべてのノードプールでサポートされているとは限りません。 制限事項とサポートされている Kubernetes のバージョンについては、 https://aka.ms/aks/supported-ubuntu-versions
Ubuntu2404

ノードイメージのOSとしてUbuntu2404を使用しますが、Ubuntu 24.04がすべてのノードプールでサポートされているとは限りません。 制限事項とサポートされている Kubernetes のバージョンについては、 https://aka.ms/aks/supported-ubuntu-versions
Windows2019

ノード イメージの OS として Windows2019 を使用します。 システム ノード プールではサポートされていません。 Windows2019 では、Windows2019 コンテナーのみがサポートされます。Windows 2022 コンテナーを実行することはできません。その逆も同様です。
Windows2022

ノード イメージの OS として Windows2022 を使用します。 システム ノード プールではサポートされていません。 Windows2022 では、Windows2022 コンテナーのみがサポートされます。Windows 2019 コンテナーを実行することはできません。その逆も同様です。

OSType

列挙

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

値 説明
Linux

Linux を使用します。
Windows

Windows を使用します。

PodIPAllocationMode

列挙

ポッド IP 割り当てモード。 エージェント プール内のポッドの IP 割り当てモード。 podSubnetId と共に使用する必要があります。 既定値は "DynamicIndividual" です。

値 説明
DynamicIndividual

各ノードには、ポッドに割り当て可能な IP アドレスの連続しないリストが割り当てられます。 これは、サイズ /16 以下の小規模から中規模のサブネットを最大化する場合に適しています。 動的 IP 割り当てを持つ Azure CNI クラスターは、顧客が podIPAllocationMode を明示的に指定しない場合、既定でこのモードになります
StaticBlock

各ノードには、ノードあたりの maxPods を満たすために、ブロックあたりサイズ /28 = 16 IP の CIDR ブロックが静的に割り当てられます。 >の CIDR ブロックの数 = (maxPods / 16)。 このブロックは、1 つの IP ではなく、65K の Azure Vnet プライベート IP 制限に対してカウントされます。 そのため、ブロック モードは、クラスター内の現在の制限である 65K ポッドを超える大規模なワークロードを実行するのに適しています。 このモードは、/15 以上の大きなサブネットでスケーリングする場合に適しています

PortRange

Object

ポート範囲。

名前 型 説明
portEnd

integer (int32)

minimum: 1
maximum: 65535

範囲に含まれる最大ポート。 範囲は 1 から 65535 で、portStart 以上である必要があります。
portStart

integer (int32)

minimum: 1
maximum: 65535

範囲に含まれる最小ポート。 範囲は 1 から 65535 で、portEnd 以下である必要があります。
protocol

Protocol

ポートのネットワーク プロトコル。

PowerState

Object

クラスターの電源状態について説明します

名前 型 説明
code

code

クラスターが実行中か停止かを示します

Protocol

列挙

ポートのネットワーク プロトコル。

値 説明
TCP

TCP プロトコル。
UDP

UDP プロトコル。

ScaleDownMode

列挙

VM をエージェント プールに追加またはエージェント プールから削除する方法について説明します。 「 課金状態」を参照してください。

値 説明
Delete

スケールアップ中に新しいインスタンスを作成し、スケールダウン中にインスタンスを削除します。
Deallocate

スケールアップ中に割り当て解除されたインスタンス (存在する場合) を開始し、スケールダウン中にインスタンスの割り当て解除を試みます。

ScaleProfile

Object

VirtualMachines エージェント プールのスケーリング方法に関する仕様。

名前 型 説明
manual

ManualScaleProfile[]

VirtualMachines エージェント プールを固定サイズにスケーリングする方法に関する仕様。

ScaleSetEvictionPolicy

列挙

仮想マシン スケール セットの削除ポリシー。 削除ポリシーは、VMが削除されたときにVMをどうするかを指定します。 デフォルトは [削除] です。 削除の詳細については、「スポット VM」を参照してください

値 説明
Delete

ノード プールの基になるスケール セット内のノードは、削除されると削除されます。
Deallocate

ノード プールの基になるスケール セット内のノードは、削除時に stopped-deallocation 状態に設定されます。 停止して割り当て解除された状態のノードは、コンピューティング クォータに対してカウントされ、クラスターのスケーリングまたはアップグレードに問題が発生する可能性があります。

ScaleSetPriority

列挙

仮想マシン スケール セットの優先順位。

値 説明
Spot

スポット優先度の VM が使用されます。 スポット ノードの SLA はありません。 詳細については、AKS の スポットを参照してください。
Regular

通常の VM が使用されます。

SysctlConfig

Object

Linux エージェント ノードの Sysctl 設定。

名前 型 説明
fsAioMaxNr

integer (int32)

sysctl setting fs.aio-max-nr.
fsFileMax

integer (int32)

sysctl 設定 fs.file-max.
fsInotifyMaxUserWatches

integer (int32)

sysctl setting fs.inotify.max_user_watches.
fsNrOpen

integer (int32)

Sysctl 設定fs.nr_open。
kernelThreadsMax

integer (int32)

sysctl setting kernel.threads-max.
netCoreNetdevMaxBacklog

integer (int32)

Sysctl 設定net.core.netdev_max_backlog。
netCoreOptmemMax

integer (int32)

Sysctl 設定net.core.optmem_max。
netCoreRmemDefault

integer (int32)

Sysctl 設定net.core.rmem_default。
netCoreRmemMax

integer (int32)

Sysctl 設定net.core.rmem_max。
netCoreSomaxconn

integer (int32)

sysctl setting net.core.somaxconn.
netCoreWmemDefault

integer (int32)

Sysctl 設定net.core.wmem_default。
netCoreWmemMax

integer (int32)

Sysctl 設定net.core.wmem_max。
netIpv4IpLocalPortRange

string

Sysctl 設定net.ipv4.ip_local_port_range。
netIpv4NeighDefaultGcThresh1

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh1。
netIpv4NeighDefaultGcThresh2

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh2。
netIpv4NeighDefaultGcThresh3

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh3。
netIpv4TcpFinTimeout

integer (int32)

Sysctl 設定net.ipv4.tcp_fin_timeout。
netIpv4TcpKeepaliveProbes

integer (int32)

Sysctl 設定net.ipv4.tcp_keepalive_probes。
netIpv4TcpKeepaliveTime

integer (int32)

Sysctl 設定net.ipv4.tcp_keepalive_time。
netIpv4TcpMaxSynBacklog

integer (int32)

Sysctl 設定net.ipv4.tcp_max_syn_backlog。
netIpv4TcpMaxTwBuckets

integer (int32)

Sysctl 設定net.ipv4.tcp_max_tw_buckets。
netIpv4TcpTwReuse

boolean

Sysctl 設定net.ipv4.tcp_tw_reuse。
netIpv4TcpkeepaliveIntvl

integer (int32)

minimum: 10
maximum: 90

Sysctl 設定net.ipv4.tcp_keepalive_intvl。
netNetfilterNfConntrackBuckets

integer (int32)

minimum: 65536
maximum: 524288

Sysctl 設定net.netfilter.nf_conntrack_buckets。
netNetfilterNfConntrackMax

integer (int32)

minimum: 131072
maximum: 2097152

Sysctl 設定net.netfilter.nf_conntrack_max。
vmMaxMapCount

integer (int32)

sysctl setting vm.max_map_count.
vmSwappiness

integer (int32)

sysctl setting vm.swappiness.
vmVfsCachePressure

integer (int32)

Sysctl 設定vm.vfs_cache_pressure。

UndrainableNodeBehavior

列挙

アップグレード中の、使用できないノードの動作を定義します。 ノードを使用できない最も一般的な原因はポッド中断予算 (PDB) ですが、ポッドの終了猶予期間が残りのノードごとのドレイン タイムアウトを超えたり、ポッドがまだ実行中の状態であるなど、他の問題が原因で、セッション不可能なノードが発生する可能性もあります。

値 説明
Schedule

AKS はブロックされたノードをスケジュール可能とマークしますが、ブロックされたノードはアップグレードされません。 すべてのサージ ノードを削除するためのベスト エフォート試行が行われます。 ブロックされたノードがある場合、アップグレード操作とマネージド クラスターは失敗状態になります。
Cordon

AKS は、ブロックされたノードを隔離し、アップグレード中にサージ ノードに置き換えます。 ブロックされたノードは切断され、サージ ノードに置き換えられます。 ブロックされたノードには、"kubernetes.azure.com/upgrade-status:Quarantined" というラベルが付けられます。 サージ ノードは、ブロックされたノードごとに保持されます。 他のすべてのサージ ノードを削除するためのベスト エフォート試行が行われます。 ブロックされたノードを置き換えるのに十分なサージ ノードがある場合、アップグレード操作とマネージド クラスターは失敗状態になります。 それ以外の場合、アップグレード操作とマネージド クラスターは取り消された状態になります。

VirtualMachineNodes

Object

同じ VM サイズのノード グループの現在の状態。

名前 型 説明
count

integer (int32)

ノードの数。
size

string

このノード グループをホストするために使用されるエージェントの VM サイズ。

VirtualMachinesProfile

Object

VirtualMachines エージェント プールの仕様。

名前 型 説明
scale

ScaleProfile

VirtualMachines エージェント プールのスケーリング方法に関する仕様。

WorkloadRuntime

列挙

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

値 説明
OCIContainer

ノードは Kubelet を使用して、標準の OCI コンテナー ワークロードを実行します。
WasmWasi

ノードは、WASI プロバイダー (プレビュー) を使用して WASM ワークロードを実行するために、クルースレットを使用します。
KataVmIsolation

ノードは (Kata + Cloud Hypervisor + Hyper-V) を使用して、ネストされた VM ベースのポッドを有効にすることができます。 Hyper-V を使用するため、AKS ノード OS 自体は Hyper-V の入れ子になった VM (ルート OS) です。 したがって、Dv3 シリーズなどの入れ子になった仮想化をサポートする VM シリーズでのみ使用できます。