ManagedClusterAgentPoolProfileProperties interface

Пакет:

@azure/arm-containerservice

Свойства профиля пула агентов службы контейнеров.

Свойства

availabilityZones	Список зон доступности, используемых для узлов. Это можно указать, только если свойство AgentPoolType — VirtualMachineScaleSets.
capacityReservationGroupID	AKS связывает указанный пул агентов с группой резервирования емкости.
count	Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 0 до 1000 (включительно) для пулов пользователей и в диапазоне от 1 до 1000 (включительно) для системных пулов. Значение по умолчанию — 1.
creationData	Создание данных, используемых для указания исходного идентификатора моментального снимка, если пул узлов будет создан или обновлен с помощью моментального снимка.
currentOrchestratorVersion	Если orchestratorVersion является полностью указанной версией <major.minor.patch>, это поле будет точно равно ему. Если orchestratorVersion <major.minor>, это поле будет содержать полную версию <major.minor.patch>. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
enableAutoScaling	Включение автоматического масштабирования
enableEncryptionAtHost	Это поддерживается только в определенных размерах виртуальных машин и в определенных регионах Azure. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFips	Дополнительные сведения см. в статье Добавление пула узлов с поддержкой FIPS.
enableNodePublicIP	В некоторых сценариях может потребоваться, чтобы узлы в пуле узлов получали собственные выделенные общедоступные IP-адреса. Распространенный сценарий — для игровых рабочих нагрузок, где консоль должна сделать прямое подключение к облачной виртуальной машине, чтобы свести к минимуму прыжки. Дополнительные сведения см. в назначении общедоступного IP-адреса наузла. Значение по умолчанию — false.
enableUltraSSD	Включение UltraSSD
eTag	Уникальная строка только для чтения, используемая для реализации оптимистического параллелизма. Значение eTag изменится при обновлении ресурса. Укажите заголовок if-match или if-none-match со значением eTag для последующего запроса, чтобы включить оптимистическое параллелизм в соответствии с обычным соглашением etag. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
gpuInstanceProfile	GPUInstanceProfile для указания профиля экземпляра GPU MIG для поддерживаемого номера SKU виртуальной машины GPU.
hostGroupID	Это форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Дополнительные сведения см. в выделенных узлах Azure.
kubeletConfig	Конфигурация Kubelet на узлах пула агентов.
kubeletDiskType	Определяет размещение томов emptyDir, корневого каталога данных среды выполнения контейнера и эфемерного хранилища Kubelet.
linuxOSConfig	Конфигурация ОС узлов агента Linux.
maxCount	Максимальное количество узлов для автоматического масштабирования
maxPods	Максимальное количество модулей pod, которые могут выполняться на узле.
minCount	Минимальное количество узлов для автоматического масштабирования
mode	Кластер должен иметь по крайней мере один пул агентов System. Дополнительные сведения об ограничениях пула агентов и рекомендациях см. в статье https://docs.microsoft.com/azure/aks/use-system-pools
networkProfile	Параметры пула агентов, связанные с сетью.
nodeImageVersion	Версия образа узла ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
nodeLabels	Метки узлов, которые необходимо сохранить во всех узлах в пуле агентов.
nodePublicIPPrefixID	Это форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	Фрагменты, добавленные к новым узлам во время создания и масштабирования пула узлов. Например, key=value:NoSchedule.
orchestratorVersion	Поддерживаются оба исправления <major.minor.patch> (например, 1.20.13) и <основных.дополнительных> (например, 1.20). Если указан <основной.дополнительный>, то последняя поддерживаемая версия исправления общедоступной версии выбирается автоматически. Обновление кластера с тем же <основной.дополнительный> после его создания (например, 1.14.x -> 1.14) не активирует обновление, даже если новая версия исправлений доступна. Рекомендуется обновить все пулы узлов в кластере AKS до той же версии Kubernetes. Версия пула узлов должна иметь ту же основную версию, что и плоскость управления. Дополнительная версия пула узлов должна находиться в двух дополнительных версиях версии уровня управления. Версия пула узлов не может быть больше версии уровня управления. Дополнительные сведения см. в обновлении пула узлов.
osDiskSizeGB	Размер диска ОС в ГБ, используемый для указания размера диска для каждого компьютера в пуле главных и агентов. Если указать значение 0, он будет применять размер osDisk по умолчанию в соответствии с указанным vmSize.
osDiskType	Значение по умолчанию — "Ephemeral", если виртуальная машина поддерживает ее и имеет диск кэша больше запрошенного OSDiskSizeGB. В противном случае значение по умолчанию — Managed. Может не быть изменено после создания. Дополнительные сведения см. в эфемерной ОС.
osSKU	Указывает номер SKU ОС, используемый пулом агентов. По умолчанию используется Ubuntu, если OSType — Linux. По умолчанию используется Windows2019, если Kubernetes <= 1.24 или Windows2022, если Kubernetes >= 1,25, если OSType — Windows.
osType	Тип операционной системы. По умолчанию используется Linux.
podSubnetID	Если не указано, IP-адреса pod статически назначаются в подсети узла (дополнительные сведения см. в статье vnetSubnetID). Эта форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState	При первом создании пула агентов он изначально выполняется. Пул агентов можно остановить, установив для этого поля значение "Остановлено". Остановленный пул агентов останавливает все виртуальные машины и не взимает плата за выставление счетов. Пул агентов может быть остановлен только в том случае, если оно запущено и состояние подготовки выполнено успешно.
provisioningState	Текущее состояние развертывания или подготовки. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
proximityPlacementGroupID	Идентификатор группы размещения близкого взаимодействия.
scaleDownMode	Это также влияет на поведение автомасштабирования кластера. Если он не указан, по умолчанию используется значение Delete.
scaleSetEvictionPolicy	Это нельзя указать, если параметр scaleSetPriority не имеет значения Spot. Если значение не указано, значение по умолчанию — "Удалить".
scaleSetPriority	Приоритет масштабируемого набора виртуальных машин. Если значение не указано, значение по умолчанию — "Regular".
securityProfile	Параметры безопасности пула агентов.
spotMaxPrice	Возможные значения — это любое десятичное значение, больше нуля или -1 которое указывает на готовность платить любую цену по запросу. Дополнительные сведения о ценах на точечные виртуальные машины см. в цен на точечные виртуальные машины
tags	Теги, которые необходимо сохранить в масштабируемом наборе виртуальных машин пула агентов.
type	Тип пула агентов.
upgradeSettings	Параметры обновления агентаpool
vmSize	Доступность размера виртуальной машины зависит от региона. Если узел содержит недостаточные вычислительные ресурсы (память, ЦП и т. д.), модули pod могут не выполняться правильно. Дополнительные сведения об ограниченных размерах виртуальных машин см. в статье https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	Если это не указано, будет создана и используется виртуальная сеть и подсеть. Если параметр podSubnetID не указан, это относится к узлам и модулям pod, в противном случае оно применяется только к узлам. Эта форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile	Конкретный профиль пула агентов Windows.
workloadRuntime	Определяет тип рабочей нагрузки, который может выполнять узел.

Сведения о свойстве

availabilityZones

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

availabilityZones?: string[]

Значение свойства

string[]

capacityReservationGroupID

AKS связывает указанный пул агентов с группой резервирования емкости.

capacityReservationGroupID?: string

Значение свойства

string

count

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

count?: number

Значение свойства

number

creationData

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

creationData?: CreationData

Значение свойства

CreationData

currentOrchestratorVersion

Если orchestratorVersion является полностью указанной версией <major.minor.patch>, это поле будет точно равно ему. Если orchestratorVersion <major.minor>, это поле будет содержать полную версию <major.minor.patch>. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

currentOrchestratorVersion?: string

Значение свойства

string

enableAutoScaling

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

enableAutoScaling?: boolean

Значение свойства

boolean

enableEncryptionAtHost

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

enableEncryptionAtHost?: boolean

Значение свойства

boolean

enableFips

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

enableFips?: boolean

Значение свойства

boolean

enableNodePublicIP

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

enableNodePublicIP?: boolean

Значение свойства

boolean

enableUltraSSD

Включение UltraSSD

enableUltraSSD?: boolean

Значение свойства

boolean

eTag

Уникальная строка только для чтения, используемая для реализации оптимистического параллелизма. Значение eTag изменится при обновлении ресурса. Укажите заголовок if-match или if-none-match со значением eTag для последующего запроса, чтобы включить оптимистическое параллелизм в соответствии с обычным соглашением etag. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

eTag?: string

Значение свойства

string

gpuInstanceProfile

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

gpuInstanceProfile?: string

Значение свойства

string

hostGroupID

Это форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Дополнительные сведения см. в выделенных узлах Azure.

hostGroupID?: string

Значение свойства

string

kubeletConfig

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

kubeletConfig?: KubeletConfig

Значение свойства

KubeletConfig

kubeletDiskType

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

kubeletDiskType?: string

Значение свойства

string

linuxOSConfig

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

linuxOSConfig?: LinuxOSConfig

Значение свойства

LinuxOSConfig

maxCount

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

maxCount?: number

Значение свойства

number

maxPods

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

maxPods?: number

Значение свойства

number

minCount

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

minCount?: number

Значение свойства

number

mode

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

mode?: string

Значение свойства

string

networkProfile

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

networkProfile?: AgentPoolNetworkProfile

Значение свойства

AgentPoolNetworkProfile

nodeImageVersion

Версия образа узла ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

nodeImageVersion?: string

Значение свойства

string

nodeLabels

Метки узлов, которые необходимо сохранить во всех узлах в пуле агентов.

nodeLabels?: {[propertyName: string]: string}

Значение свойства

{[propertyName: string]: string}

nodePublicIPPrefixID

Это форма: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Значение свойства

string

nodeTaints

Фрагменты, добавленные к новым узлам во время создания и масштабирования пула узлов. Например, key=value:NoSchedule.

nodeTaints?: string[]

Значение свойства

string[]

orchestratorVersion

Поддерживаются оба исправления <major.minor.patch> (например, 1.20.13) и <основных.дополнительных> (например, 1.20). Если указан <основной.дополнительный>, то последняя поддерживаемая версия исправления общедоступной версии выбирается автоматически. Обновление кластера с тем же <основной.дополнительный> после его создания (например, 1.14.x -> 1.14) не активирует обновление, даже если новая версия исправлений доступна. Рекомендуется обновить все пулы узлов в кластере AKS до той же версии Kubernetes. Версия пула узлов должна иметь ту же основную версию, что и плоскость управления. Дополнительная версия пула узлов должна находиться в двух дополнительных версиях версии уровня управления. Версия пула узлов не может быть больше версии уровня управления. Дополнительные сведения см. в обновлении пула узлов.

orchestratorVersion?: string

Значение свойства

string

osDiskSizeGB

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

osDiskSizeGB?: number

Значение свойства

number

osDiskType

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

osDiskType?: string

Значение свойства

string

osSKU

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

osSKU?: string

Значение свойства

string

osType

Тип операционной системы. По умолчанию используется Linux.

osType?: string

Значение свойства

string

podSubnetID

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

podSubnetID?: string

Значение свойства

string

powerState

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

powerState?: PowerState

Значение свойства

PowerState

provisioningState

Текущее состояние развертывания или подготовки. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

provisioningState?: string

Значение свойства

string

proximityPlacementGroupID

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

proximityPlacementGroupID?: string

Значение свойства

string

scaleDownMode

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

scaleDownMode?: string

Значение свойства

string

scaleSetEvictionPolicy

Это нельзя указать, если параметр scaleSetPriority не имеет значения Spot. Если значение не указано, значение по умолчанию — "Удалить".

scaleSetEvictionPolicy?: string

Значение свойства

string

scaleSetPriority

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

scaleSetPriority?: string

Значение свойства

string

securityProfile

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

securityProfile?: AgentPoolSecurityProfile

Значение свойства

AgentPoolSecurityProfile

spotMaxPrice

Возможные значения — это любое десятичное значение, больше нуля или -1 которое указывает на готовность платить любую цену по запросу. Дополнительные сведения о ценах на точечные виртуальные машины см. в цен на точечные виртуальные машины

spotMaxPrice?: number

Значение свойства

number

tags

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

tags?: {[propertyName: string]: string}

Значение свойства

{[propertyName: string]: string}

type

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

type?: string

Значение свойства

string

upgradeSettings

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

upgradeSettings?: AgentPoolUpgradeSettings

Значение свойства

AgentPoolUpgradeSettings

vmSize

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

vmSize?: string

Значение свойства

string

vnetSubnetID

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

vnetSubnetID?: string

Значение свойства

string

windowsProfile

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

windowsProfile?: AgentPoolWindowsProfile

Значение свойства

AgentPoolWindowsProfile

workloadRuntime

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

workloadRuntime?: string

Значение свойства

string