Agent Pools - Create Or Update

リファレンス

サービス:: AKS

API バージョン:: 2024-09-01

指定したマネージドクラスター内のエージェントプールを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
agentPoolName	path	True	string	エージェントプールの名前。正規表現パターン: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	リソースグループの名前。名前では大文字と小文字が区別されません。
resourceName	path	True	string	マネージドクラスターリソースの名前。正規表現パターン: `^[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	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	要求は、エンティティがこの文字列と一致する場合にのみ続行する必要があります。
If-None-Match		string	要求は、この文字列に一致するエンティティがない場合にのみ続行する必要があります。

要求本文

名前	型	説明
properties.availabilityZones	string[]	ノードに使用する可用性ゾーンの一覧。これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。
properties.capacityReservationGroupID	string	仮想マシンの予約グループから仮想マシンを提供する容量予約グループの完全修飾リソース ID。 AKS は、指定されたエージェントプールを容量予約グループに関連付けます。
properties.count	integer	Docker コンテナーをホストするエージェント (VM) の数。使用できる値は、ユーザープールの場合は 0 から 1000 (含む) の範囲、システムプールの場合は 1 から 1000 (含む) の範囲である必要があります。既定値は 1 です。
properties.creationData	CreationData	スナップショットを使用してノードプールを作成またはアップグレードする場合に、ソーススナップショット ID を指定するために使用する CreationData。
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.gpuInstanceProfile	GPUInstanceProfile	サポートされている GPU VM SKU の GPU MIG インスタンスプロファイルを指定するために使用される GPUInstanceProfile。
properties.hostGroupID	string	仮想マシンをプロビジョニングする専用ホストグループの完全修飾リソース 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	自動スケーリングのノードの最大数
properties.maxPods	integer	ノードで実行できるポッドの最大数。
properties.minCount	integer	自動スケーリング用のノードの最小数
properties.mode	AgentPoolMode	エージェントプールのモード。クラスターには、常に少なくとも 1 つの "システム" エージェントプールが必要です。エージェントプールの制限とベストプラクティスの詳細については、「https://docs.microsoft.com/azure/aks/use-system-pools」を参照してください。
properties.networkProfile	AgentPoolNetworkProfile	エージェントプールのネットワーク関連の設定。
properties.nodeLabels	object	エージェントプール内のすべてのノードにわたって保持されるノードラベル。
properties.nodePublicIPPrefixID	string	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	マスター/エージェントプール内のすべてのマシンのディスクサイズを指定するために使用する 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 です。
properties.podSubnetID	string	起動時にポッドが参加するサブネットの ID。省略すると、ポッド IP はノードサブネットに静的に割り当てられます (詳細については、vnetSubnetID を参照してください)。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
properties.powerState	PowerState	エージェントプールが実行中か停止しているか。エージェントプールが最初に作成されるときは、最初に実行中です。エージェントプールは、このフィールドを [停止済み] に設定することで停止できます。停止したエージェントプールは、すべての VM を停止し、課金料金は発生しません。エージェントプールは、実行中でプロビジョニング状態が成功した場合にのみ停止できます
properties.proximityPlacementGroupID	string	近接通信配置グループの ID。
properties.scaleDownMode	ScaleDownMode	エージェントプールをスケーリングするときに使用するスケールダウンモード。これは、クラスターオートスケーラーの動作にも影響します。指定しない場合は、既定で Delete に設定されます。
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	使用する仮想マシンスケールセットの削除ポリシー。 scaleSetPriority が 'Spot' でない限り、これは指定できません。指定しない場合、既定値は 'Delete' です。
properties.scaleSetPriority	ScaleSetPriority	仮想マシンスケールセットの優先順位。指定しない場合、既定値は 'Regular' です。
properties.securityProfile	AgentPoolSecurityProfile	エージェントプールのセキュリティ設定。
properties.spotMaxPrice	number	スポットインスタンスに対して支払う最大価格 (米ドル)。使用できる値は、0 より大きい任意の 10 進値、または既定の価格がオンデマンドで up-to されることを示す -1 です。指定できる値は、0 より大きい任意の 10 進値またはオンデマンド価格を支払う意欲を示す -1 です。スポット価格の詳細については、スポット VM の価格を参照してください。
properties.tags	object	エージェントプールの仮想マシンスケールセットに保持されるタグ。
properties.type	AgentPoolType	エージェントプールの種類。
properties.upgradeSettings	AgentPoolUpgradeSettings	エージェントプールをアップグレードするための設定
properties.vmSize	string	エージェントプール VM のサイズ。 VM サイズの可用性はリージョンによって異なります。ノードに十分なコンピューティングリソース (メモリ、cpu など) が含まれている場合、ポッドが正常に実行されない可能性があります。制限付き VM サイズの詳細については、「https://docs.microsoft.com/azure/aks/quotas-skus-regions」を参照してください。
properties.vnetSubnetID	string	エージェントプールノードと必要に応じてポッドが起動時に参加するサブネットの ID。これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
properties.windowsProfile	AgentPoolWindowsProfile	Windows エージェントプールの特定のプロファイル。
properties.workloadRuntime	WorkloadRuntime	ノードが実行できるワークロードの種類を決定します。

応答

名前	型	説明
200 OK	AgentPool	既存のエージェントプールが正常に更新されました。
201 Created	AgentPool	新しいエージェントプールが正常に作成されました。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

Create Agent Pool using an agent pool snapshot

Create Agent Pool with Capacity Reservation Group

Create Agent Pool with Dedicated Host Group

Create Agent Pool with EncryptionAtHost enabled

Create Agent Pool with Ephemeral OS Disk

Create Agent Pool with FIPS enabled OS

Create Agent Pool with GPUMIG

Create Agent Pool with Krustlet and the WASI runtime

Create Agent Pool with KubeletConfig and LinuxOSConfig

Create Agent Pool with OSSKU

Create Agent Pool with PPG

Create Agent Pool with UltraSSD enabled

Create Agent Pool with Windows OSSKU

Create Spot Agent Pool

Create Windows Agent Pool with disabling OutboundNAT

Create/Update Agent Pool

Start Agent Pool

Stop Agent Pool

Update Agent Pool

Create Agent Pool using an agent pool snapshot

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Create Agent Pool with Capacity Reservation Group

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

Create Agent Pool with Dedicated Host Group

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

Create Agent Pool with EncryptionAtHost enabled

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Create Agent Pool with Ephemeral OS Disk

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "kubeletDiskType": "OS",
    "osDiskSizeGB": 64
  }
}

Create Agent Pool with FIPS enabled OS

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}

Create Agent Pool with GPUMIG

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with Krustlet and the WASI runtime

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Create Agent Pool with KubeletConfig and LinuxOSConfig

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with OSSKU

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with PPG

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Create Agent Pool with UltraSSD enabled

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Create Agent Pool with Windows OSSKU

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2?api-version=2024-09-01

{
  "properties": {
    "orchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

Create Spot Agent Pool

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}

Create Windows Agent Pool with disabling OutboundNAT

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2?api-version=2024-09-01

{
  "properties": {
    "orchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

Create/Update Agent Pool

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Start Agent Pool

要求のサンプル

HTTP

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

{
  "properties": {
    "powerState": {
      "code": "Running"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}

Stop Agent Pool

要求のサンプル

HTTP

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

{
  "properties": {
    "powerState": {
      "code": "Stopped"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}

Update Agent Pool

要求のサンプル

HTTP

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

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Updating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

定義

名前	説明
AgentPool	エージェントプール。
AgentPoolMode	エージェントプールのモード。
AgentPoolNetworkProfile	エージェントプールのネットワーク設定。
AgentPoolSecurityProfile	エージェントプールのセキュリティ設定。
AgentPoolType	エージェントプールの種類。
AgentPoolUpgradeSettings	エージェントプールをアップグレードするための設定
AgentPoolWindowsProfile	Windows エージェントプールの特定のプロファイル。
CloudError	コンテナーサービスからのエラー応答。
CloudErrorBody	コンテナーサービスからのエラー応答。
code	クラスターが実行中か停止かを示します
CreationData	ソースリソースからターゲットリソースを作成するときに使用されるデータ。
GPUInstanceProfile	サポートされている GPU VM SKU の GPU MIG インスタンスプロファイルを指定するために使用される GPUInstanceProfile。
IPTag	オブジェクトに関連付けられている IPTag を格納します。
KubeletConfig	エージェントノードの Kubelet 構成。
KubeletDiskType	emptyDir ボリューム、コンテナーランタイムデータルート、および Kubelet エフェメラルストレージの配置を決定します。
LinuxOSConfig	Linux エージェントノードの OS 構成。
OSDiskType	エージェントプール内のマシンに使用する OS ディスクの種類。
OSSKU	エージェントプールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。既定値は、Kubernetes <= 1.24 の場合は Windows 2019、OSType が Windows の場合は Kubernetes >= 1.25 の場合は Windows2022 です。
OSType	オペレーティングシステムの種類。既定値は Linux です。
PortRange	ポート範囲。
PowerState	クラスターの電源状態について説明します
Protocol	ポートのネットワークプロトコル。
ScaleDownMode	VM をエージェントプールに追加またはエージェントプールから削除する方法について説明します。課金状態を参照してください。
ScaleSetEvictionPolicy	仮想マシンスケールセットの削除ポリシー。
ScaleSetPriority	仮想マシンスケールセットの優先順位。
SysctlConfig	Linux エージェントノードの Sysctl 設定。
WorkloadRuntime	ノードが実行できるワークロードの種類を決定します。

AgentPool

エージェントプール。

名前	型	規定値	説明
id	string		リソース ID。
name	string		リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.availabilityZones	string[]		ノードに使用する可用性ゾーンの一覧。これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。
properties.capacityReservationGroupID	string		仮想マシンの予約グループから仮想マシンを提供する容量予約グループの完全修飾リソース ID。 AKS は、指定されたエージェントプールを容量予約グループに関連付けます。
properties.count	integer		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.gpuInstanceProfile	GPUInstanceProfile		サポートされている GPU VM SKU の GPU MIG インスタンスプロファイルを指定するために使用される GPUInstanceProfile。
properties.hostGroupID	string		仮想マシンをプロビジョニングする専用ホストグループの完全修飾リソース 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		自動スケーリングのノードの最大数
properties.maxPods	integer		ノードで実行できるポッドの最大数。
properties.minCount	integer		自動スケーリング用のノードの最小数
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		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		マスター/エージェントプール内のすべてのマシンのディスクサイズを指定するために使用する 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.podSubnetID	string		起動時にポッドが参加するサブネットの ID。省略すると、ポッド IP はノードサブネットに静的に割り当てられます (詳細については、vnetSubnetID を参照してください)。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
properties.powerState	PowerState		エージェントプールが実行中か停止しているか。エージェントプールが最初に作成されるときは、最初に実行中です。エージェントプールは、このフィールドを [停止済み] に設定することで停止できます。停止したエージェントプールは、すべての VM を停止し、課金料金は発生しません。エージェントプールは、実行中でプロビジョニング状態が成功した場合にのみ停止できます
properties.provisioningState	string		現在のデプロイまたはプロビジョニングの状態。
properties.proximityPlacementGroupID	string		近接通信配置グループの 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.tags	object		エージェントプールの仮想マシンスケールセットに保持されるタグ。
properties.type	AgentPoolType		エージェントプールの種類。
properties.upgradeSettings	AgentPoolUpgradeSettings		エージェントプールをアップグレードするための設定
properties.vmSize	string		エージェントプール VM のサイズ。 VM サイズの可用性はリージョンによって異なります。ノードに十分なコンピューティングリソース (メモリ、cpu など) が含まれている場合、ポッドが正常に実行されない可能性があります。制限付き VM サイズの詳細については、「https://docs.microsoft.com/azure/aks/quotas-skus-regions」を参照してください。
properties.vnetSubnetID	string		エージェントプールノードと必要に応じてポッドが起動時に参加するサブネットの ID。これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。
properties.windowsProfile	AgentPoolWindowsProfile		Windows エージェントプールの特定のプロファイル。
properties.workloadRuntime	WorkloadRuntime		ノードが実行できるワークロードの種類を決定します。
type	string		リソースの種類

AgentPoolMode

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

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

AgentPoolNetworkProfile

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

名前	型	説明
allowedHostPorts	PortRange[]	アクセスが許可されているポート範囲。指定した範囲は重複できます。
applicationSecurityGroups	string[]	エージェントプールの作成時に関連付けるアプリケーションセキュリティグループの ID。
nodePublicIPTags	IPTag[]	インスタンスレベルのパブリック IP の IP タグ。

AgentPoolSecurityProfile

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

名前	型	説明
enableSecureBoot	boolean	セキュアブートは、署名されたオペレーティングシステムとドライバーのみが起動できるようにする、トラステッド起動の機能です。詳細については、aka.ms/aks/trustedlaunch を参照してください。指定しない場合、既定値は false です。
enableVTPM	boolean	vTPM は、ノード上でローカルに保持されているキーと測定用に専用のセキュリティで保護されたコンテナーを構成するための信頼できる起動機能です。詳細については、aka.ms/aks/trustedlaunch を参照してください。指定しない場合、既定値は false です。

AgentPoolType

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

名前	型	説明
AvailabilitySet	string	これを使用することは強くお勧めします。
VirtualMachineScaleSets	string	仮想マシンスケールセットによってサポートされるエージェントプールを作成します。

AgentPoolUpgradeSettings

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

名前	型	説明
drainTimeoutInMinutes	integer	ノードのドレインタイムアウトポッドの削除とノードごとのグレースフル終了を待機する時間 (分単位)。この削除待機時間は、ポッドの中断予算の待機を優先します。この時間を超えると、アップグレードは失敗します。指定しない場合、既定値は 30 分です。
maxSurge	string	アップグレード中に急増したノードの最大数または割合。これは、整数 (例: '5') またはパーセンテージ (例: '50%') に設定できます。パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。パーセンテージの場合、小数部のノードは切り上げられます。指定しない場合、既定値は 1 です。ベストプラクティスを含む詳細については、「https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade」を参照してください。
nodeSoakDurationInMinutes	integer	ノードのソーク期間ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。指定しない場合、既定値は 0 分です。

AgentPoolWindowsProfile

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

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

CloudError

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

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

CloudErrorBody

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

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

code

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

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

CreationData

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

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

GPUInstanceProfile

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

名前	型	説明
MIG1g	string
MIG2g	string
MIG3g	string
MIG4g	string
MIG7g	string

IPTag

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

名前	型	説明
ipTagType	string	IP タグの種類。例: RoutingPreference。
tag	string	パブリック IP に関連付けられている IP タグの値。例: インターネット。

KubeletConfig

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

名前	型	説明
allowedUnsafeSysctls	string[]	安全でない sysctl または安全でない sysctl パターンの許可されたリスト (`*`で終わる)。
containerLogMaxFiles	integer	コンテナーに存在できるコンテナーログファイルの最大数。数値は 2 ≥する必要があります。
containerLogMaxSizeMB	integer	ローテーション前のコンテナーログファイルの最大サイズ (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	イメージガベージコレクションが常に実行された後のディスク使用率。イメージガベージコレクションを無効にするには、100 に設定します。既定値は 85%
imageGcLowThreshold	integer	イメージガベージコレクションが実行されない前のディスク使用率。 imageGcHighThreshold より高く設定することはできません。既定値は 80%
podMaxPids	integer	ポッドあたりのプロセスの最大数。
topologyManagerPolicy	string	使用するトポロジマネージャーポリシー。詳細については、「Kubernetes Topology Manager」を参照してください。既定値は 'none' です。使用できる値は、'none'、'best-effort'、'restricted'、および 'single-numa-node' です。

KubeletDiskType

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

名前	型	説明
OS	string	Kubelet は、データに OS ディスクを使用します。
Temporary	string	Kubelet は、データに一時ディスクを使用します。

LinuxOSConfig

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

名前	型	説明
swapFileSizeMB	integer	各ノードに作成されるスワップファイルのサイズ (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」を参照してください。

OSDiskType

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

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

OSSKU

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

名前	型	説明
AzureLinux	string	ノードイメージの OS として AzureLinux を使用します。 Azure Linux は、Microsoft によって構築されたコンテナー最適化 Linux ディストリビューションです。詳細については、https://aka.ms/azurelinux を参照してください。
CBLMariner	string	非推奨の OSSKU。新しいデプロイでは、代わりに "AzureLinux" を選択することをお勧めします。
Ubuntu	string	ノードイメージの OS として Ubuntu を使用します。
Windows2019	string	ノードイメージの OS として Windows2019 を使用します。システムノードプールではサポートされていません。 Windows2019 では、Windows2019 コンテナーのみがサポートされます。Windows 2022 コンテナーを実行することはできません。その逆も同様です。
Windows2022	string	ノードイメージの OS として Windows2022 を使用します。システムノードプールではサポートされていません。 Windows2022 では、Windows2022 コンテナーのみがサポートされます。Windows 2019 コンテナーを実行することはできません。その逆も同様です。

OSType

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

名前	型	説明
Linux	string	Linux を使用します。
Windows	string	Windows を使用します。

PortRange

ポート範囲。

名前	型	説明
portEnd	integer	範囲に含まれる最大ポート。範囲は 1 から 65535 で、portStart 以上である必要があります。
portStart	integer	範囲に含まれる最小ポート。範囲は 1 から 65535 で、portEnd 以下である必要があります。
protocol	Protocol	ポートのネットワークプロトコル。

PowerState

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

名前	型	説明
code	code	クラスターが実行中か停止かを示します

Protocol

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

名前	型	説明
TCP	string	TCP プロトコル。
UDP	string	UDP プロトコル。

ScaleDownMode

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

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

ScaleSetEvictionPolicy

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

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

ScaleSetPriority

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

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

SysctlConfig

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

名前	型	説明
fsAioMaxNr	integer	Sysctl setting fs.aio-max-nr.
fsFileMax	integer	Sysctl setting fs.file-max.
fsInotifyMaxUserWatches	integer	sysctl setting fs.inotify.max_user_watches.
fsNrOpen	integer	Sysctl 設定fs.nr_open。
kernelThreadsMax	integer	sysctl setting kernel.threads-max.
netCoreNetdevMaxBacklog	integer	Sysctl 設定net.core.netdev_max_backlog。
netCoreOptmemMax	integer	Sysctl 設定net.core.optmem_max。
netCoreRmemDefault	integer	Sysctl 設定net.core.rmem_default。
netCoreRmemMax	integer	Sysctl 設定net.core.rmem_max。
netCoreSomaxconn	integer	sysctl setting net.core.somaxconn.
netCoreWmemDefault	integer	Sysctl 設定net.core.wmem_default。
netCoreWmemMax	integer	Sysctl 設定net.core.wmem_max。
netIpv4IpLocalPortRange	string	Sysctl 設定net.ipv4.ip_local_port_range。
netIpv4NeighDefaultGcThresh1	integer	Sysctl 設定net.ipv4.neigh.default.gc_thresh1。
netIpv4NeighDefaultGcThresh2	integer	Sysctl 設定net.ipv4.neigh.default.gc_thresh2。
netIpv4NeighDefaultGcThresh3	integer	Sysctl 設定net.ipv4.neigh.default.gc_thresh3。
netIpv4TcpFinTimeout	integer	Sysctl 設定net.ipv4.tcp_fin_timeout。
netIpv4TcpKeepaliveProbes	integer	Sysctl 設定net.ipv4.tcp_keepalive_probes。
netIpv4TcpKeepaliveTime	integer	Sysctl 設定net.ipv4.tcp_keepalive_time。
netIpv4TcpMaxSynBacklog	integer	Sysctl 設定net.ipv4.tcp_max_syn_backlog。
netIpv4TcpMaxTwBuckets	integer	Sysctl 設定net.ipv4.tcp_max_tw_buckets。
netIpv4TcpTwReuse	boolean	Sysctl 設定net.ipv4.tcp_tw_reuse。
netIpv4TcpkeepaliveIntvl	integer	Sysctl 設定net.ipv4.tcp_keepalive_intvl。
netNetfilterNfConntrackBuckets	integer	Sysctl 設定net.netfilter.nf_conntrack_buckets。
netNetfilterNfConntrackMax	integer	Sysctl 設定net.netfilter.nf_conntrack_max。
vmMaxMapCount	integer	sysctl setting vm.max_map_count.
vmSwappiness	integer	Sysctl setting vm.swappiness.
vmVfsCachePressure	integer	Sysctl 設定vm.vfs_cache_pressure。

WorkloadRuntime

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

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

次の方法で共有

Agent Pools - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create Agent Pool using an agent pool snapshot

要求のサンプル

応答のサンプル

Create Agent Pool with Capacity Reservation Group

要求のサンプル

応答のサンプル

Create Agent Pool with Dedicated Host Group

要求のサンプル

応答のサンプル

Create Agent Pool with EncryptionAtHost enabled

要求のサンプル

応答のサンプル

Create Agent Pool with Ephemeral OS Disk

要求のサンプル

応答のサンプル

Create Agent Pool with FIPS enabled OS

要求のサンプル

応答のサンプル

Create Agent Pool with GPUMIG

要求のサンプル

応答のサンプル

Create Agent Pool with Krustlet and the WASI runtime

要求のサンプル

応答のサンプル

Create Agent Pool with KubeletConfig and LinuxOSConfig

要求のサンプル

応答のサンプル

Create Agent Pool with OSSKU

要求のサンプル

応答のサンプル

Create Agent Pool with PPG

要求のサンプル

応答のサンプル

Create Agent Pool with UltraSSD enabled

要求のサンプル

応答のサンプル

Create Agent Pool with Windows OSSKU

要求のサンプル

応答のサンプル

Create Spot Agent Pool

要求のサンプル

応答のサンプル

Create Windows Agent Pool with disabling OutboundNAT

要求のサンプル

応答のサンプル

Create/Update Agent Pool

要求のサンプル

応答のサンプル

Start Agent Pool

要求のサンプル

応答のサンプル

Stop Agent Pool

要求のサンプル

応答のサンプル

Update Agent Pool

要求のサンプル

応答のサンプル

定義

AgentPool

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUInstanceProfile