Поделиться через

Agent Pools - Create Or Update

  • Ссылка
Service:
AKS
API Version:
2024-02-01

Создает или обновляет пул агентов в указанном управляемом кластере.

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

Параметры URI

Имя В Обязательно Тип Описание
agentPoolName
 path True

string

Имя пула агентов.

Regex pattern: ^[a-z][a-z0-9]{0,11}$
resourceGroupName
 path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.
resourceName
 path True

string

Имя ресурса управляемого кластера.

Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId
 path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
properties.availabilityZones

string[]

Список зон доступности, используемых для узлов. Это можно указать, только если свойство AgentPoolType имеет значение VirtualMachineScaleSets.
properties.capacityReservationGroupID

string

Полный идентификатор ресурса группы резервирования мощности для предоставления виртуальных машин из зарезервированной группы Виртуальные машины.
AKS свяжет указанный пул агентов с группой резервирования мощности.
properties.count

integer

Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 0 до 1000 (включительно) для пулов пользователей и в диапазоне от 1 до 1000 (включительно) для системных пулов. Значение по умолчанию — 1.
properties.creationData

CreationData

CreationData будет использоваться для указания исходного идентификатора моментального снимка, если пул узлов будет создан или обновлен с помощью snapshot.
properties.enableAutoScaling

boolean

Включение автомасштабирования
properties.enableEncryptionAtHost

boolean

Следует ли включить шифрование операционной системы и диска данных на основе узла.
Это поддерживается только для определенных размеров виртуальных машин и в определенных регионах Azure. Для получения дополнительной информации см. https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Указывает, следует ли использовать ОС с поддержкой FIPS.
Дополнительные сведения см. в статье Добавление пула узлов с поддержкой FIPS .
properties.enableNodePublicIP

boolean

Указывает, выделен ли каждому узлу собственный общедоступный IP-адрес.
В некоторых сценариях может потребоваться, чтобы узлы в пуле узлов получали собственные выделенные общедоступные IP-адреса. Типичный сценарий — для игровых рабочих нагрузок, в которых консоль должна установить прямое подключение к облачной виртуальной машине для снижения числа прыжков. Дополнительные сведения см. в статье Назначение общедоступного IP-адреса для каждого узла. Значение по умолчанию — false.
properties.enableUltraSSD

boolean

Следует ли включить UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile, используемый для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU.
properties.hostGroupID

string

Полный идентификатор ресурса выделенной группы узлов для подготовки виртуальных машин, который используется только в сценарии создания и не может изменяться после установки.
Имеется следующий вид: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Дополнительные сведения см. в статье Выделенные узлы Azure.
properties.kubeletConfig

KubeletConfig

Конфигурации Kubelet для узлов агента.
Конфигурация Kubelet на узлах пула агентов.
properties.kubeletDiskType

KubeletDiskType

Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и временного хранилища Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Конфигурации ОС узлов агента Linux.
Конфигурация ОС узлов агента Linux.
properties.maxCount

integer

Максимальное число узлов для автоматического масштабирования
properties.maxPods

integer

Максимальное количество модулей pod, которые могут выполняться на узле.
properties.minCount

integer

Минимальное количество узлов для автоматического масштабирования
properties.mode

AgentPoolMode

Режим пула агентов.
Кластер должен иметь по крайней мере один "системный" пул агентов в любое время. Дополнительные сведения об ограничениях пула агентов и рекомендации см. в разделе: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Параметры пула агентов, связанные с сетью.
properties.nodeLabels

object

Метки узлов, сохраняемые на всех узлах в пуле агентов.
properties.nodePublicIPPrefixID

string

Идентификатор префикса общедоступного IP-адреса, из которого узлы виртуальных машин должны использовать IP-адреса.
Имеется следующий вид: /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> , последняя поддерживаемая общедоступная версия исправления выбирается автоматически. Обновление кластера с тем же <параметром major.minor> после его создания (например, 1.14.x –> 1.14) не активирует обновление, даже если доступна более новая версия исправления. Рекомендуется обновить все пулы узлов в кластере AKS до одной версии Kubernetes. Версия пула узлов должна иметь ту же основную версию, что и уровень управления. Дополнительная версия пула узлов должна быть в пределах двух промежуточных дополнительных версий уровня управления. Версия пула узлов не может быть больше версии уровня управления. Дополнительные сведения см. в разделе Обновление пула узлов.
properties.osDiskSizeGB

integer

Размер диска ОС в ГБ, который будет использоваться для указания размера диска для каждого компьютера в пуле master или агента. Если указать значение 0, будет применен размер osDisk по умолчанию в соответствии с указанным vmSize.
properties.osDiskType

OSDiskType

Тип диска ОС, используемый для компьютеров в пуле агентов.
Значение по умолчанию — "Временный", если виртуальная машина поддерживает его и имеет диск кэша, превышающий запрошенный OSDiskSizeGB. В противном случае по умолчанию используется значение "Управляемый". Не может быть изменена после создания. Дополнительные сведения см. в разделе Временные ОС.
properties.osSKU

OSSKU

Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — Ubuntu, если OSType — Linux. По умолчанию используется Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType — Windows.
properties.osType

OSType

Тип операционной системы. Значение по умолчанию — Linux.
properties.podSubnetID

string

Идентификатор подсети, к которой присоединяются модули pod при запуске.
Если этот параметр опущен, IP-адреса pod статически назначаются в подсети узла (дополнительные сведения см. в разделе vnetSubnetID). Имеется следующий вид: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Указывает, запущен или остановлен ли пул агентов.
При создании пула агентов он изначально выполняется. Пул агентов можно остановить, задав для этого поля значение Остановлено. Остановленный пул агентов останавливает все виртуальные машины и не взимает плату за выставление счетов. Пул агентов может быть остановлен только в том случае, если он запущен и состояние подготовки — Succeeded
properties.proximityPlacementGroupID

string

Идентификатор группы размещения близкого взаимодействия.
properties.scaleDownMode

ScaleDownMode

Режим уменьшения масштаба, используемый при масштабировании пула агентов.
Это также влияет на поведение автомасштабирования кластера. Если значение не указано, по умолчанию используется значение Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Используемая политика вытеснения масштабируемого набора виртуальных машин.
Это нельзя указать, если параметр scaleSetPriority не имеет значение "Spot". Если значение не указано, по умолчанию используется значение "Delete".
properties.scaleSetPriority

ScaleSetPriority

Приоритет масштабируемого набора виртуальных машин. Если значение не указано, по умолчанию используется значение "Regular".
properties.spotMaxPrice

number

Максимальная цена (в долларах США), которую вы готовы заплатить за точечные экземпляры. Возможные значения — это любое десятичное значение больше нуля или -1, что указывает на цену по умолчанию по требованию.
Возможные значения — это любое десятичное значение больше нуля или -1, что указывает на готовность платить любую цену по требованию. Дополнительные сведения о ценах на точечные виртуальные машины см. в статье Цены на точечные виртуальные машины.
properties.tags

object

Теги, сохраняемые в масштабируемом наборе виртуальных машин пула агентов.
properties.type

AgentPoolType

Тип пула агентов.
properties.upgradeSettings

AgentPoolUpgradeSettings

Параметры обновления пула агентов
properties.vmSize

string

Размер виртуальных машин пула агентов.
Размер виртуальной машины зависит от региона. Если узел содержит недостаточные вычислительные ресурсы (память, ЦП и т. д.), модули pod могут работать неправильно. Дополнительные сведения об ограниченных размерах виртуальных машин см. в разделе: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

Идентификатор подсети, к которой присоединяются узлы пула агентов и при необходимости модули pod при запуске.
Если этот параметр не указан, будут созданы и использованы виртуальная сеть и подсеть. Если podSubnetID не указан, это относится к узлам и модулям pod, в противном случае применяется только к узлам. Имеется следующий вид: /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

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
    }
  }
}

Sample Response

Status code:
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"
    }
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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
    }
  }
}

Sample Response

Status code:
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
    }
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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
    }
  }
}

Sample Response

Status code:
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
    }
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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
    }
  }
}

Sample Response

Status code:
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
    }
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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
    }
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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"
    }
  }
}
Status code:
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

Sample Request

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

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

Sample Response

Status code:
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"
    }
  }
}
Status code:
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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-02-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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Параметры сети пула агентов.
AgentPoolType

Тип пула агентов.
AgentPoolUpgradeSettings

Параметры обновления пула агентов
AgentPoolWindowsProfile

Конкретный профиль пула агентов Windows.
CloudError

Ответ об ошибке от службы контейнеров.
CloudErrorBody

Ответ об ошибке от службы контейнеров.
code

Указывает, запущен ли кластер или остановлен.
CreationData

Данные, используемые при создании целевого ресурса из исходного ресурса.
GPUInstanceProfile

GPUInstanceProfile, используемый для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU.
IPTag

Содержит IPTag, связанный с объектом .
KubeletConfig

Конфигурации Kubelet для узлов агента.
KubeletDiskType

Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и временного хранилища Kubelet.
LinuxOSConfig

Конфигурации ОС узлов агента Linux.
OSDiskType

Тип диска ОС, используемый для компьютеров в пуле агентов.
OSSKU

Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — Ubuntu, если OSType — Linux. Значение по умолчанию — Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType имеет значение Windows.
OSType

Тип операционной системы. Значение по умолчанию — Linux.
PortRange

Диапазон портов.
PowerState

Описывает состояние питания кластера.
Protocol

Сетевой протокол порта.
ScaleDownMode

Описывает, как виртуальные машины добавляются в пулы агентов или удаляются из них. См. сведения о состоянии выставления счетов.
ScaleSetEvictionPolicy

Политика вытеснения масштабируемого набора виртуальных машин.
ScaleSetPriority

Приоритет масштабируемого набора виртуальных машин.
SysctlConfig

Параметры sysctl для узлов агента Linux.
WorkloadRuntime

Определяет тип рабочей нагрузки, который может выполнять узел.

AgentPool

Пул агентов

Имя Тип Значение по умолчанию Описание
id

string

Идентификатор ресурса.
name

string

Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.availabilityZones

string[]

Список зон доступности, используемых для узлов. Это можно указать, только если свойство AgentPoolType имеет значение VirtualMachineScaleSets.
properties.capacityReservationGroupID

string

Полный идентификатор ресурса группы резервирования мощности для предоставления виртуальных машин из зарезервированной группы Виртуальные машины.
AKS свяжет указанный пул агентов с группой резервирования мощности.
properties.count

integer

Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 0 до 1000 (включительно) для пулов пользователей и в диапазоне от 1 до 1000 (включительно) для системных пулов. Значение по умолчанию — 1.
properties.creationData

CreationData

CreationData будет использоваться для указания исходного идентификатора моментального снимка, если пул узлов будет создан или обновлен с помощью snapshot.
properties.currentOrchestratorVersion

string

Версия Kubernetes, на котором работает пул агентов.
Если orchestratorVersion является полностью указанной версией <major.minor.patch>, это поле будет точно равно ему. Если аргумент orchestratorVersion имеет значение <major.minor>, это поле будет содержать всю используемую <версию major.minor.patch> .
properties.enableAutoScaling

boolean

Включение автомасштабирования
properties.enableEncryptionAtHost

boolean

Следует ли включить шифрование операционной системы и диска данных на основе узла.
Это поддерживается только для определенных размеров виртуальных машин и в определенных регионах Azure. Для получения дополнительной информации см. https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS

boolean

Указывает, следует ли использовать ОС с поддержкой FIPS.
Дополнительные сведения см. в статье Добавление пула узлов с поддержкой FIPS .
properties.enableNodePublicIP

boolean

Указывает, выделен ли каждому узлу собственный общедоступный IP-адрес.
В некоторых сценариях может потребоваться, чтобы узлы в пуле узлов получали собственные выделенные общедоступные IP-адреса. Типичный сценарий — для игровых рабочих нагрузок, в которых консоль должна установить прямое подключение к облачной виртуальной машине для снижения числа прыжков. Дополнительные сведения см. в статье Назначение общедоступного IP-адреса для каждого узла. Значение по умолчанию — false.
properties.enableUltraSSD

boolean

Следует ли включить UltraSSD
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile, используемый для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU.
properties.hostGroupID

string

Полный идентификатор ресурса выделенной группы узлов для подготовки виртуальных машин, который используется только в сценарии создания и не может изменяться после установки.
Имеется следующий вид: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Дополнительные сведения см. в статье Выделенные узлы Azure.
properties.kubeletConfig

KubeletConfig

Конфигурации Kubelet для узлов агента.
Конфигурация Kubelet на узлах пула агентов.
properties.kubeletDiskType

KubeletDiskType

Определяет размещение томов emptyDir, корня данных среды выполнения контейнера и временного хранилища Kubelet.
properties.linuxOSConfig

LinuxOSConfig

Конфигурации ОС узлов агента Linux.
Конфигурация ОС узлов агента Linux.
properties.maxCount

integer

Максимальное число узлов для автоматического масштабирования
properties.maxPods

integer

Максимальное количество модулей pod, которые могут выполняться на узле.
properties.minCount

integer

Минимальное количество узлов для автоматического масштабирования
properties.mode

AgentPoolMode

Режим пула агентов.
Кластер должен иметь по крайней мере один "системный" пул агентов в любое время. Дополнительные сведения об ограничениях пула агентов и рекомендации см. в разделе: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile

AgentPoolNetworkProfile

Параметры пула агентов, связанные с сетью.
properties.nodeImageVersion

string

Версия образа узла
properties.nodeLabels

object

Метки узлов, сохраняемые на всех узлах в пуле агентов.
properties.nodePublicIPPrefixID

string

Идентификатор префикса общедоступного IP-адреса, из которого узлы виртуальных машин должны использовать IP-адреса.
Имеется следующий вид: /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> , последняя поддерживаемая общедоступная версия исправления выбирается автоматически. Обновление кластера с тем же <параметром major.minor> после его создания (например, 1.14.x –> 1.14) не активирует обновление, даже если доступна более новая версия исправления. Рекомендуется обновить все пулы узлов в кластере AKS до одной версии Kubernetes. Версия пула узлов должна иметь ту же основную версию, что и уровень управления. Дополнительная версия пула узлов должна быть в пределах двух промежуточных дополнительных версий уровня управления. Версия пула узлов не может быть больше версии уровня управления. Дополнительные сведения см. в разделе Обновление пула узлов.
properties.osDiskSizeGB

integer

Размер диска ОС в ГБ, используемый для указания размера диска для каждого компьютера в пуле master или агента. Если указать значение 0, будет применен размер osDisk по умолчанию в соответствии с указанным vmSize.
properties.osDiskType

OSDiskType

Тип диска ОС, используемый для компьютеров в пуле агентов.
Значение по умолчанию — "Эфемерный", если виртуальная машина поддерживает ее и имеет диск кэша, размер которого превышает запрошенный OSDiskSizeGB. В противном случае по умолчанию используется значение Managed. Не может быть изменен после создания. Дополнительные сведения см. в разделе Эфемерная ОС.
properties.osSKU

OSSKU

Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — Ubuntu, если OSType — Linux. По умолчанию используется Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType — Windows.
properties.osType

OSType

Linux

Тип операционной системы. Значение по умолчанию — Linux.
properties.podSubnetID

string

Идентификатор подсети, к которой присоединяются модули pod при запуске.
Если этот параметр опущен, IP-адреса pod статически назначаются в подсети узла (дополнительные сведения см. в разделе vnetSubnetID). Имеется следующий вид: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState

PowerState

Указывает, запущен или остановлен ли пул агентов.
При создании пула агентов он изначально выполняется. Пул агентов можно остановить, задав для этого поля значение Остановлено. Остановленный пул агентов останавливает все виртуальные машины и не взимает плату за выставление счетов. Пул агентов может быть остановлен только в том случае, если он запущен и состояние подготовки — Succeeded
properties.provisioningState

string

Текущее состояние развертывания или подготовки.
properties.proximityPlacementGroupID

string

Идентификатор группы размещения близкого взаимодействия.
properties.scaleDownMode

ScaleDownMode

Режим уменьшения масштаба, используемый при масштабировании пула агентов.
Это также влияет на поведение автомасштабирования кластера. Если значение не указано, по умолчанию используется значение Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

Используемая политика вытеснения масштабируемого набора виртуальных машин.
Это нельзя указать, если параметр scaleSetPriority не имеет значение "Spot". Если значение не указано, по умолчанию используется значение "Delete".
properties.scaleSetPriority

ScaleSetPriority

Regular

Приоритет масштабируемого набора виртуальных машин. Если значение не указано, по умолчанию используется значение "Regular".
properties.spotMaxPrice

number

-1

Максимальная цена (в долларах США), которую вы готовы заплатить за точечные экземпляры. Возможные значения — это любое десятичное значение больше нуля или -1, что указывает на цену по умолчанию по требованию.
Возможные значения — это любое десятичное значение больше нуля или -1, что указывает на готовность платить любую цену по требованию. Дополнительные сведения о ценах на точечные виртуальные машины см. в статье Цены на точечные виртуальные машины.
properties.tags

object

Теги, сохраняемые в масштабируемом наборе виртуальных машин пула агентов.
properties.type

AgentPoolType

Тип пула агентов.
properties.upgradeSettings

AgentPoolUpgradeSettings

Параметры обновления пула агентов
properties.vmSize

string

Размер виртуальных машин пула агентов.
Доступность размера виртуальной машины зависит от региона. Если узел содержит недостаточные вычислительные ресурсы (память, ЦП и т. д.), модули pod могут работать неправильно. Дополнительные сведения об ограниченных размерах виртуальных машин см. в разделе: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID

string

Идентификатор подсети, к которой присоединяются узлы пула агентов и при необходимости модули pod при запуске.
Если этот параметр не указан, будут созданы и использованы виртуальная сеть и подсеть. Если podSubnetID не указан, это относится к узлам и модулям pod, в противном случае применяется только к узлам. Имеется следующий вид: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile

AgentPoolWindowsProfile

Конкретный профиль пула агентов Windows.
properties.workloadRuntime

WorkloadRuntime

Определяет тип рабочей нагрузки, который может выполнять узел.
type

string

Тип ресурса

AgentPoolMode

Режим пула агентов.

Имя Тип Описание
System

string

Пулы системных агентов в основном предназначены для размещения критически важных системных модулей pod, таких как CoreDNS и metrics-server. Пулы системных агентов osType должны иметь тип Linux. SKU виртуальных машин пулов системных агентов должен иметь не менее 2 ЦП и 4 ГБ памяти.
User

string

Пулы агентов пользователей в основном предназначены для размещения модулей pod приложения.

AgentPoolNetworkProfile

Параметры сети пула агентов.

Имя Тип Описание
allowedHostPorts

PortRange[]

Диапазоны портов, к которым разрешен доступ. Указанные диапазоны могут перекрываться.
applicationSecurityGroups

string[]

Идентификаторы групп безопасности приложений, которые будут связаны пулом агентов при создании.
nodePublicIPTags

IPTag[]

IPTag общедоступных IP-адресов уровня экземпляра.

AgentPoolType

Тип пула агентов.

Имя Тип Описание
AvailabilitySet

string

Использовать это настоятельно не рекомендуется.
VirtualMachineScaleSets

string

Создайте пул агентов, поддерживаемый масштабируемым набором виртуальных машин.

AgentPoolUpgradeSettings

Параметры обновления пула агентов

Имя Тип Описание
drainTimeoutInMinutes

integer

Время ожидания стока для узла
Время (в минутах) ожидания вытеснения модулей pod и корректного завершения каждого узла. Это время ожидания вытеснения учитывает ожидание при нарушении бюджета pod. Если это время превышено, обновление завершается ошибкой. Если значение не указано, значение по умолчанию — 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

Следует ли отключить outboundNAT в узлах Windows
Значением по умолчанию является false. Исходящие NAT можно отключить, только если исходящий тип кластера — шлюз NAT, а в пуле агентов Windows не включен общедоступный IP-адрес узла.

CloudError

Ответ об ошибке от службы контейнеров.

Имя Тип Описание
error

CloudErrorBody

Сведения об ошибке.

CloudErrorBody

Ответ об ошибке от службы контейнеров.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details

CloudErrorBody[]

Список дополнительных сведений об ошибке.
message

string

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

code

Указывает, запущен ли кластер или остановлен.

Имя Тип Описание
Running

string

Кластер работает.
Stopped

string

Кластер остановлен.

CreationData

Данные, используемые при создании целевого ресурса из исходного ресурса.

Имя Тип Описание
sourceResourceId

string

Это идентификатор ARM исходного объекта, который будет использоваться для создания целевого объекта.

GPUInstanceProfile

GPUInstanceProfile, используемый для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU.

Имя Тип Описание
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 (оканчивающийся на *).
containerLogMaxFiles

integer

Максимальное количество файлов журнала контейнера, которое может присутствовать для контейнера. Номер должен быть ≥ 2.
containerLogMaxSizeMB

integer

Максимальный размер (например, 10Mi) файла журнала контейнера перед его сменой.
cpuCfsQuota

boolean

Если для контейнеров, указывающих ограничения ЦП, включено применение квоты CFS ЦП.
Значение по умолчанию — true.
cpuCfsQuotaPeriod

string

Значение периода квоты ЦП CFS.
Значение по умолчанию — "100 мс". Допустимые значения — это последовательность десятичных чисел с необязательными дробями и суффиксом единицы. Например: "300 мс", "2h45m". Поддерживаемые единицы: "ns", "us", "ms", "s", "m" и "h".
cpuManagerPolicy

string

Используемая политика диспетчера ЦП.
Значение по умолчанию — none. Дополнительные сведения см. в статье Политики управления ЦП Kubernetes . Допустимые значения: none и static.
failSwapOn

boolean

Если задано значение true, kubelet не запускается, если на узле включена замена.
imageGcHighThreshold

integer

Процент дискового пространства, после заполнения которого всегда выполняется сборка мусора образов.
Для отключения сборки мусора образов установите значение 100. Значение по умолчанию — 85 %
imageGcLowThreshold

integer

Процент дискового пространства, до заполнения которого сборка мусора образов не вообще выполняется.
Это значение не может быть выше, чем imageGcHighThreshold. Значение по умолчанию — 80 %
podMaxPids

integer

Максимальное количество процессов на модуль pod.
topologyManagerPolicy

string

Используемая политика диспетчера топологий.
Дополнительные сведения см. в разделе Диспетчер топологии Kubernetes. Значение по умолчанию — none. Допустимые значения: none, best-effort, restricted и single-numa-node.

KubeletDiskType

Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и временного хранилища Kubelet.

Имя Тип Описание
OS

string

Kubelet будет использовать диск ОС для своих данных.
Temporary

string

Kubelet будет использовать временный диск для своих данных.

LinuxOSConfig

Конфигурации ОС узлов агента Linux.

Имя Тип Описание
swapFileSizeMB

integer

Размер в МБ файла подкачки, который будет создан на каждом узле.
sysctls

SysctlConfig

Параметры sysctl для узлов агента Linux.
transparentHugePageDefrag

string

Должно ли ядро активно использовать сжатие памяти, чтобы сделать более доступными огромные страницы.
Допустимые значения: "always", "defer", "defer+madvise", "madvise" и "never". Значение по умолчанию — madvise. Дополнительные сведения см. в разделе Прозрачные огромные страницы.
transparentHugePageEnabled

string

Включены ли прозрачные огромные страницы.
Допустимые значения: always, madvise и never. Значение по умолчанию — "always". Дополнительные сведения см. в разделе Прозрачные огромные страницы.

OSDiskType

Тип диска ОС, используемый для компьютеров в пуле агентов.

Имя Тип Описание
Ephemeral

string

Временные диски ОС хранятся только на хост-компьютере, как и временный диск. Таким образом, обеспечивается меньшая задержка при чтении и записи, а также ускоряется масштабирование узлов и обновления кластера.
Managed

string

Azure реплицирует диск операционной системы для виртуальной машины в хранилище Azure, чтобы избежать потери данных, если виртуальную машину необходимо переместить на другой узел. Так как контейнеры не предназначены для сохранения локального состояния, такое поведение обеспечивает ограниченное значение, предоставляя некоторые недостатки, включая медленную подготовку узлов и более высокую задержку чтения и записи.

OSSKU

Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — Ubuntu, если OSType — Linux. Значение по умолчанию — Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType имеет значение Windows.

Имя Тип Описание
AzureLinux

string

Используйте AzureLinux в качестве ОС для образов узлов. Azure Linux — это дистрибутив Linux, оптимизированный для контейнеров, созданный корпорацией Майкрософт. Дополнительные сведения см https://aka.ms/azurelinux . в этой статье.
CBLMariner

string

Устаревший OSSKU. Корпорация Майкрософт рекомендует использовать azureLinux для новых развертываний.
Ubuntu

string

Используйте Ubuntu в качестве ОС для образов узлов.
Windows2019

string

Используйте Windows2019 в качестве ОС для образов узлов. Не поддерживается для пулов системных узлов. Windows2019 поддерживает только контейнеры Windows2019; он не может запускать контейнеры Windows2022 и наоборот.
Windows2022

string

Используйте Windows2022 в качестве ОС для образов узлов. Не поддерживается для пулов системных узлов. Windows2022 поддерживает только контейнеры Windows2022; он не может запускать контейнеры Windows2019 и наоборот.

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

Описывает, как виртуальные машины добавляются в пулы агентов или удаляются из них. См. сведения о состоянии выставления счетов.

Имя Тип Описание
Deallocate

string

Попробуйте запустить освобожденные экземпляры (если они существуют) во время увеличения масштаба и освободить экземпляры во время уменьшения масштаба.
Delete

string

Создавайте новые экземпляры во время увеличения масштаба и удаляйте экземпляры во время уменьшения масштаба.

ScaleSetEvictionPolicy

Политика вытеснения масштабируемого набора виртуальных машин.

Имя Тип Описание
Deallocate

string

Узлы в базовом масштабируемом наборе пула узлов после вытеснения задается в состояние остановлено и освобождено. Узлы в таком состоянии учитываются в квоте вычислений и могут вызвать проблемы с масштабированием или обновлением кластера.
Delete

string

Узлы в базовом масштабируемом наборе пула узлов удаляются при их удалении.

ScaleSetPriority

Приоритет масштабируемого набора виртуальных машин.

Имя Тип Описание
Regular

string

Будут использоваться обычные виртуальные машины.
Spot

string

Будут использоваться виртуальные машины с точечным приоритетом. Соглашение об уровне обслуживания для точечных узлов отсутствует. Дополнительные сведения см. в статье о месте в AKS .

SysctlConfig

Параметры sysctl для узлов агента Linux.

Имя Тип Описание
fsAioMaxNr

integer

Параметр sysctl fs.aio-max-nr.
fsFileMax

integer

Параметр sysctl fs.file-max.
fsInotifyMaxUserWatches

integer

Параметр Sysctl fs.inotify.max_user_watches.
fsNrOpen

integer

Параметр Sysctl fs.nr_open.
kernelThreadsMax

integer

Параметр sysctl kernel.threads-max.
netCoreNetdevMaxBacklog

integer

Net.core.netdev_max_backlog параметра Sysctl.
netCoreOptmemMax

integer

Net.core.optmem_max параметра Sysctl.
netCoreRmemDefault

integer

Параметр sysctl net.core.rmem_default.
netCoreRmemMax

integer

Net.core.rmem_max параметра Sysctl.
netCoreSomaxconn

integer

Sysctl setting net.core.somaxconn.
netCoreWmemDefault

integer

Net.core.wmem_default параметра Sysctl.
netCoreWmemMax

integer

Net.core.wmem_max параметра Sysctl.
netIpv4IpLocalPortRange

string

Параметр Sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer

Net.ipv4.neigh.default.gc_thresh1 параметра Sysctl.
netIpv4NeighDefaultGcThresh2

integer

Net.ipv4.neigh.default.gc_thresh2 параметра Sysctl.
netIpv4NeighDefaultGcThresh3

integer

Net.ipv4.neigh.default.gc_thresh3 параметра Sysctl.
netIpv4TcpFinTimeout

integer

Net.ipv4.tcp_fin_timeout параметра Sysctl.
netIpv4TcpKeepaliveProbes

integer

Net.ipv4.tcp_keepalive_probes параметра Sysctl.
netIpv4TcpKeepaliveTime

integer

Параметр Sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer

Net.ipv4.tcp_max_syn_backlog параметра Sysctl.
netIpv4TcpMaxTwBuckets

integer

Net.ipv4.tcp_max_tw_buckets параметра Sysctl.
netIpv4TcpTwReuse

boolean

Net.ipv4.tcp_tw_reuse параметра Sysctl.
netIpv4TcpkeepaliveIntvl

integer

Net.ipv4.tcp_keepalive_intvl параметра Sysctl.
netNetfilterNfConntrackBuckets

integer

Параметр sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer

Параметр sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer

Параметр Sysctl vm.max_map_count.
vmSwappiness

integer

Параметр sysctl vm.swappiness.
vmVfsCachePressure

integer

Vm.vfs_cache_pressure параметра Sysctl.

WorkloadRuntime

Определяет тип рабочей нагрузки, который может выполнять узел.

Имя Тип Описание
OCIContainer

string

Узлы будут использовать Kubelet для выполнения стандартных рабочих нагрузок контейнера OCI.
WasmWasi

string

Узлы будут использовать Krustlet для выполнения рабочих нагрузок WASM с помощью поставщика WASI (предварительная версия).