AgentPool interface

Paquete:

@azure/arm-containerservice

Grupo de agentes.

Extends

SubResource

Propiedades

availabilityZones	Lista de zonas de disponibilidad que se van a usar para los nodos. Esto solo se puede especificar si la propiedad AgentPoolType es "VirtualMachineScaleSets".
capacityReservationGroupID	AKS asociará el grupo de agentes especificado al grupo de reserva de capacidad.
count	Número de agentes (VM) para hospedar contenedores de Docker. Los valores permitidos deben estar comprendidos entre 0 y 1000 (ambos incluidos) para los grupos de usuarios y en el intervalo de 1 a 1000 (ambos incluidos) para los grupos del sistema. El valor predeterminado es 1.
creationData	CreationData que se usará para especificar el identificador de instantánea de origen si el grupo de nodos se creará o actualizará mediante una instantánea.
currentOrchestratorVersion	Si orchestratorVersion es una versión totalmente especificada <major.minor.patch>, este campo será exactamente igual a él. Si orchestratorVersion es <major.minor>, este campo contendrá el <principal.minor.patch> versión que se está usando. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
enableAutoScaling	Si se va a habilitar el escalador automático
enableEncryptionAtHost	Esto solo se admite en determinados tamaños de máquina virtual y en determinadas regiones de Azure. Para obtener más información, consulte: https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFips	Consulte Agregar un grupo de nodos habilitado para FIPS para obtener más información.
enableNodePublicIP	Algunos escenarios pueden requerir que los nodos de un grupo de nodos reciban sus propias direcciones IP públicas dedicadas. Un escenario común es para las cargas de trabajo de juegos, donde una consola debe realizar una conexión directa a una máquina virtual en la nube para minimizar los saltos. Para obtener más información, consulte asignación de una dirección IP pública por nodo. El valor predeterminado es false.
enableUltraSSD	Si se va a habilitar UltraSSD
eTag	Cadena de solo lectura única que se usa para implementar la simultaneidad optimista. El valor de eTag cambiará cuando se actualice el recurso. Especifique un encabezado if-match o if-none-match con el valor eTag de una solicitud posterior para habilitar la simultaneidad optimista según la convención de etag normal. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
gpuInstanceProfile	GPUInstanceProfile que se usará para especificar el perfil de instancia de MIG de GPU para la SKU de máquina virtual de GPU compatible.
hostGroupID	Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para más información, consulte hosts dedicados de Azure.
kubeletConfig	Configuración de Kubelet en los nodos del grupo de agentes.
kubeletDiskType	Determina la ubicación de volúmenes emptyDir, raíz de datos del entorno de ejecución del contenedor y almacenamiento efímero de Kubelet.
linuxOSConfig	Configuración del sistema operativo de los nodos del agente de Linux.
maxCount	Número máximo de nodos para el escalado automático
maxPods	Número máximo de pods que se pueden ejecutar en un nodo.
minCount	El número mínimo de nodos para el escalado automático
mode	Un clúster debe tener al menos un grupo de agentes "System" en todo momento. Para más información sobre las restricciones del grupo de agentes y los procedimientos recomendados, consulte: https://docs.microsoft.com/azure/aks/use-system-pools
networkProfile	Configuración relacionada con la red de un grupo de agentes.
nodeImageVersion	Versión de la imagen de nodo NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
nodeLabels	Las etiquetas de nodo que se conservarán en todos los nodos del grupo de agentes.
nodePublicIPPrefixID	Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	Los taints agregados a los nuevos nodos durante la creación y escala del grupo de nodos. Por ejemplo, key=value:NoSchedule.
orchestratorVersion	Ambas versiones de revisión <principal.minor.patch> (por ejemplo, 1.20.13) y <> principal.secundaria (por ejemplo, 1.20) se admiten. Cuando se especifica <major.minor>, se elige automáticamente la versión de revisión de disponibilidad general compatible más reciente. La actualización del clúster con la misma <principal.secundaria> una vez creado (por ejemplo, 1.14.x:> 1.14) no desencadenará una actualización, incluso si hay disponible una versión de revisión más reciente. Como procedimiento recomendado, debe actualizar todos los grupos de nodos de un clúster de AKS a la misma versión de Kubernetes. La versión del grupo de nodos debe tener la misma versión principal que el plano de control. La versión secundaria del grupo de nodos debe estar dentro de dos versiones secundarias de la versión del plano de control. La versión del grupo de nodos no puede ser mayor que la versión del plano de control. Para obtener más información, consulte actualizar un grupo de nodos.
osDiskSizeGB	Tamaño del disco del sistema operativo en GB que se va a usar para especificar el tamaño del disco para cada máquina del grupo de servidores maestros o agentes. Si especifica 0, se aplicará el tamaño predeterminado de osDisk según el valor de vmSize especificado.
osDiskType	El valor predeterminado es "Efímero" si la máquina virtual la admite y tiene un disco de caché mayor que el OSDiskSizeGB solicitado. De lo contrario, el valor predeterminado es "Administrado". Es posible que no se cambie después de la creación. Para obtener más información, consulte del sistema operativo efímero.
osSKU	Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.
osType	Tipo de sistema operativo. El valor predeterminado es Linux.
podSubnetID	Si se omite, las direcciones IP de pod se asignan estáticamente en la subred del nodo (consulte vnetSubnetID para obtener más detalles). Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState	Cuando se crea por primera vez un grupo de agentes, se ejecuta inicialmente. El grupo de agentes se puede detener estableciendo este campo en Detenido. Un grupo de agentes detenido detiene todas sus máquinas virtuales y no acumula cargos de facturación. Un grupo de agentes solo se puede detener si se está ejecutando y el estado de aprovisionamiento es Correcto
provisioningState	Estado actual de implementación o aprovisionamiento. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
proximityPlacementGroupID	Identificador del grupo de selección de ubicación de proximidad.
scaleDownMode	Esto también afecta al comportamiento del escalador automático del clúster. Si no se especifica, el valor predeterminado es Eliminar.
scaleSetEvictionPolicy	No se puede especificar a menos que scaleSetPriority sea "Spot". Si no se especifica, el valor predeterminado es "Delete".
scaleSetPriority	Prioridad del conjunto de escalado de máquinas virtuales. Si no se especifica, el valor predeterminado es "Regular".
securityProfile	Configuración de seguridad de un grupo de agentes.
spotMaxPrice	Los valores posibles son cualquier valor decimal mayor que cero o -1 que indica la voluntad de pagar cualquier precio a petición. Para más información sobre los precios puntuales, consulte precios de las máquinas virtuales de acceso puntual
tags	Etiquetas que se van a conservar en el conjunto de escalado de máquinas virtuales del grupo de agentes.
typePropertiesType	Tipo de grupo de agentes.
upgradeSettings	Configuración para actualizar el grupo de agentes
vmSize	La disponibilidad del tamaño de máquina virtual varía según la región. Si un nodo contiene recursos de proceso insuficientes (memoria, cpu, etc.) podría no ejecutarse correctamente. Para más información sobre los tamaños de máquina virtual restringidos, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	Si no se especifica, se generará y usará una red virtual y una subred. Si no se especifica ningún podSubnetID, esto se aplica a nodos y pods; de lo contrario, se aplica solo a los nodos. Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile	Perfil específico del grupo de agentes de Windows.
workloadRuntime	Determina el tipo de carga de trabajo que puede ejecutar un nodo.

Propiedades heredadas

id	Identificador de recurso. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
type	Tipo de recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

availabilityZones

Lista de zonas de disponibilidad que se van a usar para los nodos. Esto solo se puede especificar si la propiedad AgentPoolType es "VirtualMachineScaleSets".

availabilityZones?: string[]

Valor de propiedad

string[]

capacityReservationGroupID

AKS asociará el grupo de agentes especificado al grupo de reserva de capacidad.

capacityReservationGroupID?: string

Valor de propiedad

string

count

Número de agentes (VM) para hospedar contenedores de Docker. Los valores permitidos deben estar comprendidos entre 0 y 1000 (ambos incluidos) para los grupos de usuarios y en el intervalo de 1 a 1000 (ambos incluidos) para los grupos del sistema. El valor predeterminado es 1.

count?: number

Valor de propiedad

number

creationData

CreationData que se usará para especificar el identificador de instantánea de origen si el grupo de nodos se creará o actualizará mediante una instantánea.

creationData?: CreationData

Valor de propiedad

CreationData

currentOrchestratorVersion

Si orchestratorVersion es una versión totalmente especificada <major.minor.patch>, este campo será exactamente igual a él. Si orchestratorVersion es <major.minor>, este campo contendrá el <principal.minor.patch> versión que se está usando. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

currentOrchestratorVersion?: string

Valor de propiedad

string

enableAutoScaling

Si se va a habilitar el escalador automático

enableAutoScaling?: boolean

Valor de propiedad

boolean

enableEncryptionAtHost

Esto solo se admite en determinados tamaños de máquina virtual y en determinadas regiones de Azure. Para obtener más información, consulte: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableEncryptionAtHost?: boolean

Valor de propiedad

boolean

enableFips

Consulte Agregar un grupo de nodos habilitado para FIPS para obtener más información.

enableFips?: boolean

Valor de propiedad

boolean

enableNodePublicIP

Algunos escenarios pueden requerir que los nodos de un grupo de nodos reciban sus propias direcciones IP públicas dedicadas. Un escenario común es para las cargas de trabajo de juegos, donde una consola debe realizar una conexión directa a una máquina virtual en la nube para minimizar los saltos. Para obtener más información, consulte asignación de una dirección IP pública por nodo. El valor predeterminado es false.

enableNodePublicIP?: boolean

Valor de propiedad

boolean

enableUltraSSD

Si se va a habilitar UltraSSD

enableUltraSSD?: boolean

Valor de propiedad

boolean

eTag

Cadena de solo lectura única que se usa para implementar la simultaneidad optimista. El valor de eTag cambiará cuando se actualice el recurso. Especifique un encabezado if-match o if-none-match con el valor eTag de una solicitud posterior para habilitar la simultaneidad optimista según la convención de etag normal. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

eTag?: string

Valor de propiedad

string

gpuInstanceProfile

GPUInstanceProfile que se usará para especificar el perfil de instancia de MIG de GPU para la SKU de máquina virtual de GPU compatible.

gpuInstanceProfile?: string

Valor de propiedad

string

hostGroupID

Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para más información, consulte hosts dedicados de Azure.

hostGroupID?: string

Valor de propiedad

string

kubeletConfig

Configuración de Kubelet en los nodos del grupo de agentes.

kubeletConfig?: KubeletConfig

Valor de propiedad

KubeletConfig

kubeletDiskType

Determina la ubicación de volúmenes emptyDir, raíz de datos del entorno de ejecución del contenedor y almacenamiento efímero de Kubelet.

kubeletDiskType?: string

Valor de propiedad

string

linuxOSConfig

Configuración del sistema operativo de los nodos del agente de Linux.

linuxOSConfig?: LinuxOSConfig

Valor de propiedad

LinuxOSConfig

maxCount

Número máximo de nodos para el escalado automático

maxCount?: number

Valor de propiedad

number

maxPods

Número máximo de pods que se pueden ejecutar en un nodo.

maxPods?: number

Valor de propiedad

number

minCount

El número mínimo de nodos para el escalado automático

minCount?: number

Valor de propiedad

number

mode

Un clúster debe tener al menos un grupo de agentes "System" en todo momento. Para más información sobre las restricciones del grupo de agentes y los procedimientos recomendados, consulte: https://docs.microsoft.com/azure/aks/use-system-pools

mode?: string

Valor de propiedad

string

networkProfile

Configuración relacionada con la red de un grupo de agentes.

networkProfile?: AgentPoolNetworkProfile

Valor de propiedad

AgentPoolNetworkProfile

nodeImageVersion

Versión de la imagen de nodo NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

nodeImageVersion?: string

Valor de propiedad

string

nodeLabels

Las etiquetas de nodo que se conservarán en todos los nodos del grupo de agentes.

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

Valor de propiedad

{[propertyName: string]: string}

nodePublicIPPrefixID

Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Valor de propiedad

string

nodeTaints

Los taints agregados a los nuevos nodos durante la creación y escala del grupo de nodos. Por ejemplo, key=value:NoSchedule.

nodeTaints?: string[]

Valor de propiedad

string[]

orchestratorVersion

Ambas versiones de revisión <principal.minor.patch> (por ejemplo, 1.20.13) y <> principal.secundaria (por ejemplo, 1.20) se admiten. Cuando se especifica <major.minor>, se elige automáticamente la versión de revisión de disponibilidad general compatible más reciente. La actualización del clúster con la misma <principal.secundaria> una vez creado (por ejemplo, 1.14.x:> 1.14) no desencadenará una actualización, incluso si hay disponible una versión de revisión más reciente. Como procedimiento recomendado, debe actualizar todos los grupos de nodos de un clúster de AKS a la misma versión de Kubernetes. La versión del grupo de nodos debe tener la misma versión principal que el plano de control. La versión secundaria del grupo de nodos debe estar dentro de dos versiones secundarias de la versión del plano de control. La versión del grupo de nodos no puede ser mayor que la versión del plano de control. Para obtener más información, consulte actualizar un grupo de nodos.

orchestratorVersion?: string

Valor de propiedad

string

osDiskSizeGB

Tamaño del disco del sistema operativo en GB que se va a usar para especificar el tamaño del disco para cada máquina del grupo de servidores maestros o agentes. Si especifica 0, se aplicará el tamaño predeterminado de osDisk según el valor de vmSize especificado.

osDiskSizeGB?: number

Valor de propiedad

number

osDiskType

El valor predeterminado es "Efímero" si la máquina virtual la admite y tiene un disco de caché mayor que el OSDiskSizeGB solicitado. De lo contrario, el valor predeterminado es "Administrado". Es posible que no se cambie después de la creación. Para obtener más información, consulte del sistema operativo efímero.

osDiskType?: string

Valor de propiedad

string

osSKU

Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.

osSKU?: string

Valor de propiedad

string

osType

Tipo de sistema operativo. El valor predeterminado es Linux.

osType?: string

Valor de propiedad

string

podSubnetID

Si se omite, las direcciones IP de pod se asignan estáticamente en la subred del nodo (consulte vnetSubnetID para obtener más detalles). Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

podSubnetID?: string

Valor de propiedad

string

powerState

Cuando se crea por primera vez un grupo de agentes, se ejecuta inicialmente. El grupo de agentes se puede detener estableciendo este campo en Detenido. Un grupo de agentes detenido detiene todas sus máquinas virtuales y no acumula cargos de facturación. Un grupo de agentes solo se puede detener si se está ejecutando y el estado de aprovisionamiento es Correcto

powerState?: PowerState

Valor de propiedad

PowerState

provisioningState

Estado actual de implementación o aprovisionamiento. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

provisioningState?: string

Valor de propiedad

string

proximityPlacementGroupID

Identificador del grupo de selección de ubicación de proximidad.

proximityPlacementGroupID?: string

Valor de propiedad

string

scaleDownMode

Esto también afecta al comportamiento del escalador automático del clúster. Si no se especifica, el valor predeterminado es Eliminar.

scaleDownMode?: string

Valor de propiedad

string

scaleSetEvictionPolicy

No se puede especificar a menos que scaleSetPriority sea "Spot". Si no se especifica, el valor predeterminado es "Delete".

scaleSetEvictionPolicy?: string

Valor de propiedad

string

scaleSetPriority

Prioridad del conjunto de escalado de máquinas virtuales. Si no se especifica, el valor predeterminado es "Regular".

scaleSetPriority?: string

Valor de propiedad

string

securityProfile

Configuración de seguridad de un grupo de agentes.

securityProfile?: AgentPoolSecurityProfile

Valor de propiedad

AgentPoolSecurityProfile

spotMaxPrice

Los valores posibles son cualquier valor decimal mayor que cero o -1 que indica la voluntad de pagar cualquier precio a petición. Para más información sobre los precios puntuales, consulte precios de las máquinas virtuales de acceso puntual

spotMaxPrice?: number

Valor de propiedad

number

tags

Etiquetas que se van a conservar en el conjunto de escalado de máquinas virtuales del grupo de agentes.

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

Valor de propiedad

{[propertyName: string]: string}

typePropertiesType

Tipo de grupo de agentes.

typePropertiesType?: string

Valor de propiedad

string

upgradeSettings

Configuración para actualizar el grupo de agentes

upgradeSettings?: AgentPoolUpgradeSettings

Valor de propiedad

AgentPoolUpgradeSettings

vmSize

La disponibilidad del tamaño de máquina virtual varía según la región. Si un nodo contiene recursos de proceso insuficientes (memoria, cpu, etc.) podría no ejecutarse correctamente. Para más información sobre los tamaños de máquina virtual restringidos, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vmSize?: string

Valor de propiedad

string

vnetSubnetID

Si no se especifica, se generará y usará una red virtual y una subred. Si no se especifica ningún podSubnetID, esto se aplica a nodos y pods; de lo contrario, se aplica solo a los nodos. Este es el formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID?: string

Valor de propiedad

string

windowsProfile

Perfil específico del grupo de agentes de Windows.

windowsProfile?: AgentPoolWindowsProfile

Valor de propiedad

AgentPoolWindowsProfile

workloadRuntime

Determina el tipo de carga de trabajo que puede ejecutar un nodo.

workloadRuntime?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

id

Identificador de recurso. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

heredado deSubResource.id

name

Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

heredado deSubResource.name

type

Tipo de recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deSubResource.type