Agent Pools - List

サービス:: AKS

API バージョン:: 2025-04-01

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

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

URI パラメーター

名前	/	必須	型	説明
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	AgentPoolListResult	[OK]
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List Agent Pools by Managed Cluster

要求のサンプル

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


/**
 * Samples for AgentPools List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/
     * AgentPoolsList.json
     */
    /**
     * Sample code: List Agent Pools by Managed Cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAgentPoolsByManagedCluster(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getAgentPools().list("rg1", "clustername1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python agent_pools_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.agent_pools.list(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/AgentPoolsList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/87bd051c295d94fffa28a4fa6b18f8b4b71c50ec/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/AgentPoolsList.json
func ExampleAgentPoolsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAgentPoolsClient().NewListPager("rg1", "clustername1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AgentPoolListResult = armcontainerservice.AgentPoolListResult{
		// 	Value: []*armcontainerservice.AgentPool{
		// 		{
		// 			Name: to.Ptr("agentpool1"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1"),
		// 			Properties: &armcontainerservice.ManagedClusterAgentPoolProfileProperties{
		// 				Count: to.Ptr[int32](3),
		// 				CurrentOrchestratorVersion: to.Ptr("1.9.6"),
		// 				ETag: to.Ptr("ewnfuib"),
		// 				MaxPods: to.Ptr[int32](110),
		// 				NodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
		// 				OrchestratorVersion: to.Ptr("1.9.6"),
		// 				OSType: to.Ptr(armcontainerservice.OSTypeLinux),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				VMSize: to.Ptr("Standard_DS1_v2"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a list of agent pools in the specified managed cluster.
 *
 * @summary Gets a list of agent pools in the specified managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/AgentPoolsList.json
 */
async function listAgentPoolsByManagedCluster() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.agentPools.list(resourceGroupName, resourceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "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",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6",
        "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
        "eTag": "ewnfuib"
      }
    }
  ]
}

定義

名前	説明
AgentPool	エージェントプール。
AgentPoolGatewayProfile	マネージドクラスターゲートウェイエージェントプールのプロファイル。
AgentPoolListResult	エージェントプールの一覧表示操作からの応答。
AgentPoolMode	エージェントプールのモード。
AgentPoolNetworkProfile	エージェントプールのネットワーク設定。
AgentPoolSecurityProfile	エージェントプールのセキュリティ設定。
AgentPoolStatus	エージェントプールに関する読み取り専用情報が含まれています。
AgentPoolType	エージェントプールの種類。
AgentPoolUpgradeSettings	エージェントプールをアップグレードするための設定
AgentPoolWindowsProfile	Windows エージェントプールの特定のプロファイル。
CloudError	コンテナーサービスからのエラー応答。
CloudErrorBody	コンテナーサービスからのエラー応答。
code	クラスターが実行中か停止かを示します
CreationData	ソースリソースからターゲットリソースを作成するときに使用されるデータ。
GPUDriver	GPU ドライバーをインストールするかどうか。指定されていない場合、既定値は Install です。
GPUInstanceProfile	サポートされている GPU VM SKU の GPU MIG インスタンスプロファイルを指定するために使用される GPUInstanceProfile。
GPUProfile	エージェントプールの GPU 設定。
IPTag	オブジェクトに関連付けられている IPTag を格納します。
KubeletConfig	エージェントノードの Kubelet 構成。
KubeletDiskType	emptyDir ボリューム、コンテナーランタイムデータルート、および Kubelet エフェメラルストレージの配置を決定します。
LinuxOSConfig	Linux エージェントノードの OS 構成。
ManualScaleProfile	マシンの数に関する仕様。
OSDiskType	エージェントプール内のマシンに使用する OS ディスクの種類。
OSSKU	エージェントプールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 OSType が Windows の場合、Kubernetes <= 1.24 の場合は Windows 2019、Kubernetes >= 1.25 の場合は Windows2022 が既定値です。
OSType	オペレーティングシステムの種類。既定値は Linux です。
PodIPAllocationMode	ポッド IP 割り当てモード
PortRange	ポート範囲。
PowerState	クラスターの電源状態について説明します
Protocol	ポートのネットワークプロトコル。
ScaleDownMode	VM をエージェントプールに追加またはエージェントプールから削除する方法について説明します。課金状態を参照してください。
ScaleProfile	VirtualMachines エージェントプールのスケーリング方法に関する仕様。
ScaleSetEvictionPolicy	仮想マシンスケールセットの削除ポリシー。
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)		仮想マシンの予約グループから仮想マシンを提供する容量予約グループの完全修飾リソース 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 規則に従ってオプティミスティックコンカレンシーを有効にするには、後続の要求の eTag 値を持つ if-match ヘッダーまたは if-none-match ヘッダーを指定します。
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 構成。エージェントプールノード上の Kubelet 構成。
properties.kubeletDiskType	KubeletDiskType		emptyDir ボリューム、コンテナーランタイムデータルート、および Kubelet エフェメラルストレージの配置を決定します。
properties.linuxOSConfig	LinuxOSConfig		Linux エージェントノードの OS 構成。 Linux エージェントノードの OS 構成。
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 です。 OSType が Windows の場合、Kubernetes <= 1.24 の場合は Windows 2019、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 です。

AgentPoolListResult

Object

エージェントプールの一覧表示操作からの応答。

名前	型	説明
nextLink	string	エージェントプールの次の結果セットを取得する URL。
value	AgentPool[]	エージェントプールの一覧。

AgentPoolMode

列挙

エージェントプールのモード。

値	説明
Gateway	ゲートウェイエージェントプールは、ポッドに静的エグレス IP を提供する専用です。詳細については、「https://aka.ms/aks/static-egress-gateway」を参照してください。
System	システムエージェントプールは、主に CoreDNS や metrics-server などの重要なシステムポッドをホストするためのものです。システムエージェントプールの osType は Linux である必要があります。システムエージェントプール VM SKU には、少なくとも 2vCPU と 4 GB のメモリが必要です。
User	ユーザーエージェントプールは、主にアプリケーションポッドをホストするためのものです。

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 です。

AgentPoolStatus

Object

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

名前	型	説明
provisioningError	CloudErrorBody	エージェントプールのエラー詳細情報。エラーの詳細情報を保持します。エラーが発生しなかった場合、このフィールドは省略されます。

AgentPoolType

列挙

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

値	説明
AvailabilitySet	これを使用することは強くお勧めします。
VirtualMachineScaleSets	仮想マシンスケールセットによってサポートされるエージェントプールを作成します。
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 が有効になっていない場合のみです。

CloudError

Object

コンテナーサービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラーの詳細。

CloudErrorBody

Object

コンテナーサービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

code

列挙

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

値	説明
Running	クラスターが実行されています。
Stopped	クラスターが停止しています。

CreationData

Object

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

名前	型	説明
sourceResourceId	string (arm-id)	これは、ターゲットオブジェクトの作成に使用するソースオブジェクトの ARM ID です。

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 構成。

名前	型	説明
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 構成。

名前	型	説明
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」を参照してください。

ManualScaleProfile

Object

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

名前	型	説明
count	integer (int32)	ノードの数。
size	string	AKS が作成およびスケーリングするときに使用する VM サイズ (例: "Standard_E4s_v3"、"Standard_E16s_v3"、"Standard_D16s_v5")。

OSDiskType

列挙

エージェントプール内のマシンに使用する OS ディスクの種類。

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

値

説明

Ephemeral

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

Managed

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

OSSKU

列挙

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

値	説明
AzureLinux	ノードイメージの OS として AzureLinux を使用します。 Azure Linux は、Microsoft によって構築されたコンテナー最適化 Linux ディストリビューションです。詳細については、https://aka.ms/azurelinux を参照してください。
CBLMariner	非推奨の OSSKU。新しいデプロイでは、代わりに "AzureLinux" を選択することをお勧めします。
Ubuntu	ノードイメージの OS として Ubuntu を使用します。
Ubuntu2204	ノードイメージのOSとしてUbuntu2204を使用しますが、Ubuntu 22.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 割り当てモード

値	説明
DynamicIndividual	各ノードには、ポッドに割り当てることができる IP アドレスの非連続リストが割り当てられます。これは、サイズ /16 以下の小規模から中規模のサブネットを最大化する場合に適しています。動的 IP 割り当てがある Azure CNI クラスターは、お客様が podIPAllocationMode を明示的に指定しない場合、既定でこのモードになります。
StaticBlock	各ノードには、ノードあたりの maxPods を満たすために、サイズ /28 = ブロックあたり 16 IP の CIDR ブロックが静的に割り当てられます。 >の CIDR ブロックの数 = (maxPods / 16)。このブロックは、1 つの IP ではなく、65K の Azure Vnet プライベート IP 制限に対してカウントされます。そのため、ブロックモードは、クラスター内の現在の制限である 65K ポッドを超える大規模なワークロードを実行するのに適しています。このモードは、/15 以上の大きなサブネットでスケーリングする場合に適しています

値

説明

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 をエージェントプールに追加またはエージェントプールから削除する方法について説明します。課金状態を参照してください。

値	説明
Deallocate	スケールアップ中に割り当て解除されたインスタンス (存在する場合) を開始し、スケールダウン中にインスタンスの割り当てを解除します。
Delete	スケールアップ中に新しいインスタンスを作成し、スケールダウン中にインスタンスを削除します。

ScaleProfile

Object

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

名前	型	説明
manual	ManualScaleProfile[]	VirtualMachines エージェントプールを固定サイズにスケーリングする方法に関する仕様。

ScaleSetEvictionPolicy

列挙

仮想マシンスケールセットの削除ポリシー。

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

値

説明

Deallocate

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

Delete

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

ScaleSetPriority

列挙

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

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

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) ですが、ポッドの終了猶予期間が残りのノードごとのドレインタイムアウトを超えたり、ポッドがまだ実行中の状態であるなど、他の問題が原因で、セッション不可能なノードが発生する可能性もあります。

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

値

説明

Cordon

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

Schedule

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

VirtualMachineNodes

Object

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

名前	型	説明
count	integer (int32)	ノードの数。
size	string	このノードグループをホストするために使用されるエージェントの VM サイズ。

VirtualMachinesProfile

Object

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

名前	型	説明
scale	ScaleProfile	VirtualMachines エージェントプールのスケーリング方法に関する仕様。

WorkloadRuntime

列挙

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

値	説明
OCIContainer	ノードは Kubelet を使用して、標準の OCI コンテナーワークロードを実行します。
WasmWasi	ノードは、WASI プロバイダー (プレビュー) を使用して WASM ワークロードを実行するために、クルースレットを使用します。

次の方法で共有

Agent Pools - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

List Agent Pools by Managed Cluster

要求のサンプル

応答のサンプル

定義

AgentPool

AgentPoolGatewayProfile

AgentPoolListResult

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolStatus

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUDriver

GPUInstanceProfile

GPUProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

ManualScaleProfile

OSDiskType

OSSKU

OSType

PodIPAllocationMode

PortRange

PowerState

Protocol

ScaleDownMode

ScaleProfile

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

UndrainableNodeBehavior

VirtualMachineNodes

VirtualMachinesProfile

WorkloadRuntime