Agent Pools - Get
Возвращает указанный пул агентов управляемого кластера.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2024-09-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
agent
|
path | True |
string |
Имя пула агентов. Шаблон регулярного выражения: |
resource
|
path | True |
string |
Имя группы ресурсов. Имя не учитывает регистр. |
resource
|
path | True |
string |
Имя ресурса управляемого кластера. Шаблон регулярного выражения: |
subscription
|
path | True |
string uuid |
Идентификатор целевой подписки. Значение должно быть UUID. |
api-version
|
query | True |
string |
Версия API, используемая для этой операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Get Agent Pool
Образец запроса
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-09-01
Пример ответа
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
"name": "agentpool1",
"properties": {
"provisioningState": "Succeeded",
"count": 3,
"vmSize": "Standard_DS1_v2",
"maxPods": 110,
"osType": "Linux",
"eTag": "ebwiyfneowv",
"orchestratorVersion": "1.9.6",
"currentOrchestratorVersion": "1.9.6",
"nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
"upgradeSettings": {
"maxSurge": "33%"
}
}
}
Определения
Имя | Описание |
---|---|
Agent |
Пул агентов. |
Agent |
Режим пула агентов. |
Agent |
Параметры сети пула агентов. |
Agent |
Параметры безопасности пула агентов. |
Agent |
Тип пула агентов. |
Agent |
Параметры обновления агентаpool |
Agent |
Конкретный профиль пула агентов Windows. |
Cloud |
Ответ об ошибке службы контейнеров. |
Cloud |
Ответ об ошибке службы контейнеров. |
code |
Указывает, запущен ли кластер или остановлен |
Creation |
Данные, используемые при создании целевого ресурса из исходного ресурса. |
GPUInstance |
GPUInstanceProfile для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU. |
IPTag |
Содержит IPTag, связанный с объектом. |
Kubelet |
Конфигурации Kubelet узлов агента. |
Kubelet |
Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и эфемерного хранилища Kubelet. |
Linux |
Конфигурации ОС узлов агента Linux. |
OSDisk |
Тип диска ОС, используемый для компьютеров в пуле агентов. |
OSSKU |
Указывает номер SKU ОС, используемый пулом агентов. По умолчанию используется Ubuntu, если OSType — Linux. По умолчанию используется Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType — Windows. |
OSType |
Тип операционной системы. По умолчанию используется Linux. |
Port |
Диапазон портов. |
Power |
Описание состояния power для кластера |
Protocol |
Сетевой протокол порта. |
Scale |
Описывает, как виртуальные машины добавляются в пулы агентов или удаляются из них. См. состояния выставления счетов. |
Scale |
Политика вытеснения масштабируемого набора виртуальных машин. |
Scale |
Приоритет масштабируемого набора виртуальных машин. |
Sysctl |
Параметры sysctl для узлов агента Linux. |
Workload |
Определяет тип рабочей нагрузки, который может выполнять узел. |
AgentPool
Пул агентов.
Имя | Тип | Default value | Описание |
---|---|---|---|
id |
string |
Идентификатор ресурса. |
|
name |
string |
Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. |
|
properties.availabilityZones |
string[] |
Список зон доступности, используемых для узлов. Это можно указать, только если свойство AgentPoolType — VirtualMachineScaleSets. |
|
properties.capacityReservationGroupID |
string |
Полный идентификатор ресурса группы резервирования емкости для предоставления виртуальных машин из зарезервированной группы виртуальных машин. |
|
properties.count |
integer |
Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 0 до 1000 (включительно) для пулов пользователей и в диапазоне от 1 до 1000 (включительно) для системных пулов. Значение по умолчанию — 1. |
|
properties.creationData |
Создание данных, используемых для указания исходного идентификатора моментального снимка, если пул узлов будет создан или обновлен с помощью моментального снимка. |
||
properties.currentOrchestratorVersion |
string |
Версия Kubernetes, запущенная пулом агентов. |
|
properties.eTag |
string |
Уникальная строка только для чтения, используемая для реализации оптимистического параллелизма. Значение eTag изменится при обновлении ресурса. Укажите заголовок if-match или if-none-match со значением eTag для последующего запроса, чтобы включить оптимистическое параллелизм в соответствии с обычным соглашением etag. |
|
properties.enableAutoScaling |
boolean |
Включение автоматического масштабирования |
|
properties.enableEncryptionAtHost |
boolean |
Следует ли включить шифрование дисков на основе узла и ОС. |
|
properties.enableFIPS |
boolean |
Следует ли использовать ОС с поддержкой FIPS. |
|
properties.enableNodePublicIP |
boolean |
Выделяется ли каждый узел собственным общедоступным IP-адресом. |
|
properties.enableUltraSSD |
boolean |
Включение UltraSSD |
|
properties.gpuInstanceProfile |
GPUInstanceProfile для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU. |
||
properties.hostGroupID |
string |
Полный идентификатор ресурса выделенной группы узлов для подготовки виртуальных машин, используемый только в сценарии создания и не допуская изменения после установки. |
|
properties.kubeletConfig |
Конфигурации Kubelet узлов агента. |
||
properties.kubeletDiskType |
Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и эфемерного хранилища Kubelet. |
||
properties.linuxOSConfig |
Конфигурации ОС узлов агента Linux. |
||
properties.maxCount |
integer |
Максимальное количество узлов для автоматического масштабирования |
|
properties.maxPods |
integer |
Максимальное количество модулей pod, которые могут выполняться на узле. |
|
properties.minCount |
integer |
Минимальное количество узлов для автоматического масштабирования |
|
properties.mode |
Режим пула агентов. |
||
properties.networkProfile |
Параметры пула агентов, связанные с сетью. |
||
properties.nodeImageVersion |
string |
Версия образа узла |
|
properties.nodeLabels |
object |
Метки узлов, которые необходимо сохранить во всех узлах в пуле агентов. |
|
properties.nodePublicIPPrefixID |
string |
Идентификатор префикса общедоступного IP-адреса, из которого узлы виртуальной машины должны использовать IP-адреса. |
|
properties.nodeTaints |
string[] |
Фрагменты, добавленные к новым узлам во время создания и масштабирования пула узлов. Например, key=value:NoSchedule. |
|
properties.orchestratorVersion |
string |
Версия Kubernetes, указанная пользователем. |
|
properties.osDiskSizeGB |
integer |
Размер диска ОС в ГБ, используемый для указания размера диска для каждого компьютера в пуле главных и агентов. Если указать значение 0, он будет применять размер osDisk по умолчанию в соответствии с указанным vmSize. |
|
properties.osDiskType |
Тип диска ОС, используемый для компьютеров в пуле агентов. |
||
properties.osSKU |
Указывает номер SKU ОС, используемый пулом агентов. По умолчанию используется Ubuntu, если OSType — Linux. По умолчанию используется Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType — Windows. |
||
properties.osType | Linux |
Тип операционной системы. По умолчанию используется Linux. |
|
properties.podSubnetID |
string |
Идентификатор подсети, к которой будут присоединяться модули pod при запуске. |
|
properties.powerState |
Выполняется или останавливается ли пул агентов. |
||
properties.provisioningState |
string |
Текущее состояние развертывания или подготовки. |
|
properties.proximityPlacementGroupID |
string |
Идентификатор группы размещения близкого взаимодействия. |
|
properties.scaleDownMode |
Режим уменьшения масштаба, используемый при масштабировании пула агентов. |
||
properties.scaleSetEvictionPolicy | Delete |
Политика вытеснения масштабируемого набора виртуальных машин. |
|
properties.scaleSetPriority | Regular |
Приоритет масштабируемого набора виртуальных машин. Если значение не указано, значение по умолчанию — "Regular". |
|
properties.securityProfile |
Параметры безопасности пула агентов. |
||
properties.spotMaxPrice |
number |
-1 |
Максимальная цена (в долларах США) вы готовы платить за точечные экземпляры. Возможные значения — это любое десятичное значение больше нуля или -1, указывающее, что цена по умолчанию up-to по запросу. |
properties.tags |
object |
Теги, которые необходимо сохранить в масштабируемом наборе виртуальных машин пула агентов. |
|
properties.type |
Тип пула агентов. |
||
properties.upgradeSettings |
Параметры обновления агентаpool |
||
properties.vmSize |
string |
Размер виртуальных машин пула агентов. |
|
properties.vnetSubnetID |
string |
Идентификатор подсети, в которой узлы пула агентов и при необходимости модули pod присоединяются при запуске. |
|
properties.windowsProfile |
Конкретный профиль пула агентов Windows. |
||
properties.workloadRuntime |
Определяет тип рабочей нагрузки, который может выполнять узел. |
||
type |
string |
Тип ресурса |
AgentPoolMode
Режим пула агентов.
Имя | Тип | Описание |
---|---|---|
System |
string |
Пулы агентов системы в основном предназначены для размещения критически важных системных модулей pod, таких как CoreDNS и metrics-server. Пулы системных агентов osType должны быть Linux. Номер SKU пулов агентов системы должен содержать не менее 2vCP и 4 ГБ памяти. |
User |
string |
Пулы агентов пользователей в основном предназначены для размещения модулей pod приложения. |
AgentPoolNetworkProfile
Параметры сети пула агентов.
Имя | Тип | Описание |
---|---|---|
allowedHostPorts |
Диапазоны портов, к которым разрешен доступ. Указанные диапазоны могут перекрываться. |
|
applicationSecurityGroups |
string[] |
Идентификаторы групп безопасности приложений, которые будут связывать пул агентов при создании. |
nodePublicIPTags |
IPTag[] |
IPTags общедоступных IP-адресов уровня экземпляра. |
AgentPoolSecurityProfile
Параметры безопасности пула агентов.
Имя | Тип | Описание |
---|---|---|
enableSecureBoot |
boolean |
Безопасная загрузка — это функция доверенного запуска, которая гарантирует загрузку только подписанных операционных систем и драйверов. Дополнительные сведения см. в aka.ms/aks/trustedlaunch. Если значение не указано, значение по умолчанию равно false. |
enableVTPM |
boolean |
VTPM — это функция доверенного запуска для настройки выделенного безопасного хранилища для ключей и измерений, которые хранятся локально на узле. Дополнительные сведения см. в aka.ms/aks/trustedlaunch. Если значение не указано, значение по умолчанию равно false. |
AgentPoolType
Тип пула агентов.
Имя | Тип | Описание |
---|---|---|
AvailabilitySet |
string |
Использование этого настоятельно не рекомендуется. |
VirtualMachineScaleSets |
string |
Создайте пул агентов, поддерживаемый масштабируемым набором виртуальных машин. |
AgentPoolUpgradeSettings
Параметры обновления агентаpool
Имя | Тип | Описание |
---|---|---|
drainTimeoutInMinutes |
integer |
Время ожидания очистки узла |
maxSurge |
string |
Максимальное число или процент узлов, которые резко возросли во время обновления. |
nodeSoakDurationInMinutes |
integer |
Длительность замока для узла |
AgentPoolWindowsProfile
Конкретный профиль пула агентов Windows.
Имя | Тип | Описание |
---|---|---|
disableOutboundNat |
boolean |
Отключение outboundNAT в узлах Windows |
CloudError
Ответ об ошибке службы контейнеров.
Имя | Тип | Описание |
---|---|---|
error |
Сведения об ошибке. |
CloudErrorBody
Ответ об ошибке службы контейнеров.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования. |
details |
Список дополнительных сведений об ошибке. |
|
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 включено для контейнеров, указывающих ограничения ЦП. |
cpuCfsQuotaPeriod |
string |
Значение квоты ЦП CFS. |
cpuManagerPolicy |
string |
Политика диспетчера ЦП, используемая. |
failSwapOn |
boolean |
Если задано значение true, это приведет к сбою запуска Kubelet, если переключение включено на узле. |
imageGcHighThreshold |
integer |
Процент использования диска, после которого сборка мусора образа всегда выполняется. |
imageGcLowThreshold |
integer |
Процент использования диска, перед которым не выполняется сборка мусора образа. |
podMaxPids |
integer |
Максимальное количество процессов на модуль pod. |
topologyManagerPolicy |
string |
Политика диспетчера топологий, используемая. |
KubeletDiskType
Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и эфемерного хранилища Kubelet.
Имя | Тип | Описание |
---|---|---|
OS |
string |
Kubelet будет использовать диск ОС для своих данных. |
Temporary |
string |
Kubelet будет использовать временный диск для своих данных. |
LinuxOSConfig
Конфигурации ОС узлов агента Linux.
Имя | Тип | Описание |
---|---|---|
swapFileSizeMB |
integer |
Размер файла буфера в МБ, который будет создан на каждом узле. |
sysctls |
Параметры sysctl для узлов агента Linux. |
|
transparentHugePageDefrag |
string |
Следует ли ядро использовать агрессивное использование сжатия памяти для повышения доступности огромных страниц. |
transparentHugePageEnabled |
string |
Включены ли прозрачные огромные страницы. |
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, а также быть больше или равен портуStart. |
portStart |
integer |
Минимальный порт, включенный в диапазон. Он должен быть равен от 1 до 65535, а также должен быть меньше или равен portEnd. |
protocol |
Сетевой протокол порта. |
PowerState
Описание состояния power для кластера
Имя | Тип | Описание |
---|---|---|
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 setting fs.aio-max-nr. |
fsFileMax |
integer |
Sysctl setting fs.file-max. |
fsInotifyMaxUserWatches |
integer |
Параметр sysctl 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 vm.max_map_count. |
vmSwappiness |
integer |
Параметр sysctl vm.swappiness. |
vmVfsCachePressure |
integer |
Параметр sysctl vm.vfs_cache_pressure. |
WorkloadRuntime
Определяет тип рабочей нагрузки, который может выполнять узел.
Имя | Тип | Описание |
---|---|---|
OCIContainer |
string |
Узлы будут использовать Kubelet для выполнения стандартных рабочих нагрузок контейнеров OCI. |
WasmWasi |
string |
Узлы будут использовать Krustlet для запуска рабочих нагрузок WASM с помощью поставщика WASI (предварительная версия). |