AgentPool interface

Pacote:

@azure/arm-containerservice

Pool de agentes.

Extends

SubResource

Propriedades

availabilityZones	A lista de zonas de disponibilidade a serem usadas para nós. Isso só poderá ser especificado se a propriedade AgentPoolType for 'VirtualMachineScaleSets'.
capacityReservationGroupID	O AKS associará o pool de agentes especificado ao Grupo de Reserva de Capacidade.
count	Número de agentes (VMs) para hospedar contêineres do Docker. Os valores permitidos devem estar no intervalo de 0 a 1000 (inclusive) para pools de usuários e no intervalo de 1 a 1000 (inclusive) para pools de sistema. O valor padrão é 1.
creationData	CreationData a ser usado para especificar a ID do Instantâneo de origem se o pool de nós for criado/atualizado usando um instantâneo.
currentOrchestratorVersion	Se orchestratorVersion for uma versão totalmente especificada <major.minor.patch>, esse campo será exatamente igual a ele. Se orchestratorVersion for <>major.minor, esse campo conterá a versão de> principal.minor.patch de <completa que está sendo usada. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
enableAutoScaling	Se o dimensionador automático deve ser habilitado
enableEncryptionAtHost	Isso só tem suporte em determinados tamanhos de VM e em determinadas regiões do Azure. Para obter mais informações, consulte: https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFips	Consulte Adicionar um pool de nós habilitado para FIPS para obter mais detalhes.
enableNodePublicIP	Alguns cenários podem exigir nós em um pool de nós para receber seus próprios endereços IP públicos dedicados. Um cenário comum é para cargas de trabalho de jogos, em que um console precisa fazer uma conexão direta com uma máquina virtual de nuvem para minimizar os saltos. Para obter mais informações, consulte atribuir um IP público por nó. O padrão é false.
enableUltraSSD	Se deseja habilitar o UltraSSD
eTag	Cadeia de caracteres somente leitura exclusiva usada para implementar simultaneidade otimista. O valor da eTag será alterado quando o recurso for atualizado. Especifique um cabeçalho if-match ou if-none-match com o valor eTag para uma solicitação subsequente para habilitar a simultaneidade otimista de acordo com a convenção de etag normal. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
gpuInstanceProfile	GPUInstanceProfile a ser usado para especificar o perfil de instância de GPU MIG para SKU de VM de GPU com suporte.
hostGroupID	Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para obter mais informações, consulte hosts dedicados do Azure.
kubeletConfig	A configuração do Kubelet nos nós do pool de agentes.
kubeletDiskType	Determina o posicionamento de volumes emptyDir, raiz de dados do runtime do contêiner e armazenamento efêmero do Kubelet.
linuxOSConfig	A configuração do sistema operacional dos nós do agente do Linux.
maxCount	O número máximo de nós para dimensionamento automático
maxPods	O número máximo de pods que podem ser executados em um nó.
minCount	O número mínimo de nós para dimensionamento automático
mode	Um cluster deve ter pelo menos um pool de agentes 'System' o tempo todo. Para obter informações adicionais sobre restrições de pool de agentes e práticas recomendadas, consulte: https://docs.microsoft.com/azure/aks/use-system-pools
networkProfile	Configurações relacionadas à rede de um pool de agentes.
nodeImageVersion	A versão da imagem do nó OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
nodeLabels	Os rótulos de nó a serem persistidos em todos os nós no pool de agentes.
nodePublicIPPrefixID	Isso é do formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	Os taints adicionados a novos nós durante a criação e a escala do pool de nós. Por exemplo, key=value:NoSchedule.
orchestratorVersion	Há suporte para a versão do patch <> major.minor.patch (por exemplo, 1.20.13) e <> major.minor (por exemplo, 1.20). Quando <> principal.minor é especificada, a versão mais recente do patch ga com suporte é escolhida automaticamente. Atualizar o cluster com o mesmo <principal.minor> depois que ele tiver sido criado (por exemplo, 1.14.x -> 1.14) não disparará uma atualização, mesmo se uma versão de patch mais recente estiver disponível. Como prática recomendada, você deve atualizar todos os pools de nós em um cluster do AKS para a mesma versão do Kubernetes. A versão do pool de nós deve ter a mesma versão principal do plano de controle. A versão secundária do pool de nós deve estar dentro de duas versões secundárias da versão do painel de controle. A versão do pool de nós não pode ser maior que a versão do painel de controle. Para obter mais informações, consulte atualizando um pool de nós.
osDiskSizeGB	Tamanho do disco do sistema operacional em GB a ser usado para especificar o tamanho do disco para cada computador no pool mestre/agente. Se você especificar 0, ele aplicará o tamanho do osDisk padrão de acordo com o vmSize especificado.
osDiskType	O padrão será "Efêmero" se a VM der suporte a ela e tiver um disco de cache maior que o OSDiskSizeGB solicitado. Caso contrário, o padrão será 'Gerenciado'. Pode não ser alterado após a criação. Para obter mais informações, consulte do sistema operacional efêmero.
osSKU	Especifica o SKU do sistema operacional usado pelo pool de agentes. O padrão é Ubuntu se OSType for Linux. O padrão é o Windows2019 quando o Kubernetes <= 1,24 ou Windows2022 quando o Kubernetes >= 1,25 se o OSType for Windows.
osType	O tipo de sistema operacional. O padrão é Linux.
podSubnetID	Se omitidos, os IPs de pod são atribuídos estaticamente na sub-rede do nó (consulte vnetSubnetID para obter mais detalhes). Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState	Quando um Pool de Agentes é criado pela primeira vez, ele está em execução inicialmente. O Pool de Agentes pode ser interrompido definindo esse campo como Parado. Um Pool de Agentes interrompido interrompe todas as suas VMs e não acumula encargos de cobrança. Um pool de agentes só poderá ser interrompido se ele estiver em execução e o estado de provisionamento for bem-sucedido
provisioningState	O estado atual de implantação ou provisionamento. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
proximityPlacementGroupID	A ID do Grupo de Posicionamento por Proximidade.
scaleDownMode	Isso também afeta o comportamento do dimensionador automático do cluster. Se não for especificado, o padrão será Excluir.
scaleSetEvictionPolicy	Isso não pode ser especificado, a menos que scaleSetPriority seja 'Spot'. Se não for especificado, o padrão será 'Delete'.
scaleSetPriority	A prioridade do Conjunto de Dimensionamento de Máquinas Virtuais. Se não for especificado, o padrão será 'Regular'.
securityProfile	As configurações de segurança de um pool de agentes.
spotMaxPrice	Os valores possíveis são qualquer valor decimal maior que zero ou -1 que indica a disposição de pagar qualquer preço sob demanda. Para obter mais detalhes sobre preços spot, consulte preços spot de VMs
tags	As marcas a serem mantidas no conjunto de dimensionamento de máquinas virtuais do pool de agentes.
typePropertiesType	O tipo de Pool de Agentes.
upgradeSettings	Configurações para atualizar o agentpool
vmSize	A disponibilidade do tamanho da VM varia de acordo com a região. Se um nó contiver recursos de computação insuficientes (memória, cpu etc), os pods poderão não ser executados corretamente. Para obter mais detalhes sobre tamanhos restritos de VM, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	Se isso não for especificado, uma VNET e uma sub-rede serão geradas e usadas. Se nenhum podSubnetID for especificado, isso se aplicará a nós e pods, caso contrário, aplica-se a apenas nós. Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile	O perfil específico do pool de agentes do Windows.
workloadRuntime	Determina o tipo de carga de trabalho que um nó pode executar.

Propriedades herdadas

id	ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name	O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type	Observação do tipo de recurso: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

availabilityZones

A lista de zonas de disponibilidade a serem usadas para nós. Isso só poderá ser especificado se a propriedade AgentPoolType for 'VirtualMachineScaleSets'.

availabilityZones?: string[]

Valor da propriedade

string[]

capacityReservationGroupID

O AKS associará o pool de agentes especificado ao Grupo de Reserva de Capacidade.

capacityReservationGroupID?: string

Valor da propriedade

string

count

Número de agentes (VMs) para hospedar contêineres do Docker. Os valores permitidos devem estar no intervalo de 0 a 1000 (inclusive) para pools de usuários e no intervalo de 1 a 1000 (inclusive) para pools de sistema. O valor padrão é 1.

count?: number

Valor da propriedade

number

creationData

CreationData a ser usado para especificar a ID do Instantâneo de origem se o pool de nós for criado/atualizado usando um instantâneo.

creationData?: CreationData

Valor da propriedade

CreationData

currentOrchestratorVersion

Se orchestratorVersion for uma versão totalmente especificada <major.minor.patch>, esse campo será exatamente igual a ele. Se orchestratorVersion for <>major.minor, esse campo conterá a versão de> principal.minor.patch de <completa que está sendo usada. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

currentOrchestratorVersion?: string

Valor da propriedade

string

enableAutoScaling

Se o dimensionador automático deve ser habilitado

enableAutoScaling?: boolean

Valor da propriedade

boolean

enableEncryptionAtHost

Isso só tem suporte em determinados tamanhos de VM e em determinadas regiões do Azure. Para obter mais informações, consulte: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableEncryptionAtHost?: boolean

Valor da propriedade

boolean

enableFips

Consulte Adicionar um pool de nós habilitado para FIPS para obter mais detalhes.

enableFips?: boolean

Valor da propriedade

boolean

enableNodePublicIP

Alguns cenários podem exigir nós em um pool de nós para receber seus próprios endereços IP públicos dedicados. Um cenário comum é para cargas de trabalho de jogos, em que um console precisa fazer uma conexão direta com uma máquina virtual de nuvem para minimizar os saltos. Para obter mais informações, consulte atribuir um IP público por nó. O padrão é false.

enableNodePublicIP?: boolean

Valor da propriedade

boolean

enableUltraSSD

Se deseja habilitar o UltraSSD

enableUltraSSD?: boolean

Valor da propriedade

boolean

eTag

Cadeia de caracteres somente leitura exclusiva usada para implementar simultaneidade otimista. O valor da eTag será alterado quando o recurso for atualizado. Especifique um cabeçalho if-match ou if-none-match com o valor eTag para uma solicitação subsequente para habilitar a simultaneidade otimista de acordo com a convenção de etag normal. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

eTag?: string

Valor da propriedade

string

gpuInstanceProfile

GPUInstanceProfile a ser usado para especificar o perfil de instância de GPU MIG para SKU de VM de GPU com suporte.

gpuInstanceProfile?: string

Valor da propriedade

string

hostGroupID

Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Para obter mais informações, consulte hosts dedicados do Azure.

hostGroupID?: string

Valor da propriedade

string

kubeletConfig

A configuração do Kubelet nos nós do pool de agentes.

kubeletConfig?: KubeletConfig

Valor da propriedade

KubeletConfig

kubeletDiskType

Determina o posicionamento de volumes emptyDir, raiz de dados do runtime do contêiner e armazenamento efêmero do Kubelet.

kubeletDiskType?: string

Valor da propriedade

string

linuxOSConfig

A configuração do sistema operacional dos nós do agente do Linux.

linuxOSConfig?: LinuxOSConfig

Valor da propriedade

LinuxOSConfig

maxCount

O número máximo de nós para dimensionamento automático

maxCount?: number

Valor da propriedade

number

maxPods

O número máximo de pods que podem ser executados em um nó.

maxPods?: number

Valor da propriedade

number

minCount

O número mínimo de nós para dimensionamento automático

minCount?: number

Valor da propriedade

number

mode

Um cluster deve ter pelo menos um pool de agentes 'System' o tempo todo. Para obter informações adicionais sobre restrições de pool de agentes e práticas recomendadas, consulte: https://docs.microsoft.com/azure/aks/use-system-pools

mode?: string

Valor da propriedade

string

networkProfile

Configurações relacionadas à rede de um pool de agentes.

networkProfile?: AgentPoolNetworkProfile

Valor da propriedade

AgentPoolNetworkProfile

nodeImageVersion

A versão da imagem do nó OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

nodeImageVersion?: string

Valor da propriedade

string

nodeLabels

Os rótulos de nó a serem persistidos em todos os nós no pool de agentes.

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

Valor da propriedade

{[propertyName: string]: string}

nodePublicIPPrefixID

Isso é do formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Valor da propriedade

string

nodeTaints

Os taints adicionados a novos nós durante a criação e a escala do pool de nós. Por exemplo, key=value:NoSchedule.

nodeTaints?: string[]

Valor da propriedade

string[]

orchestratorVersion

Há suporte para a versão do patch <> major.minor.patch (por exemplo, 1.20.13) e <> major.minor (por exemplo, 1.20). Quando <> principal.minor é especificada, a versão mais recente do patch ga com suporte é escolhida automaticamente. Atualizar o cluster com o mesmo <principal.minor> depois que ele tiver sido criado (por exemplo, 1.14.x -> 1.14) não disparará uma atualização, mesmo se uma versão de patch mais recente estiver disponível. Como prática recomendada, você deve atualizar todos os pools de nós em um cluster do AKS para a mesma versão do Kubernetes. A versão do pool de nós deve ter a mesma versão principal do plano de controle. A versão secundária do pool de nós deve estar dentro de duas versões secundárias da versão do painel de controle. A versão do pool de nós não pode ser maior que a versão do painel de controle. Para obter mais informações, consulte atualizando um pool de nós.

orchestratorVersion?: string

Valor da propriedade

string

osDiskSizeGB

Tamanho do disco do sistema operacional em GB a ser usado para especificar o tamanho do disco para cada computador no pool mestre/agente. Se você especificar 0, ele aplicará o tamanho do osDisk padrão de acordo com o vmSize especificado.

osDiskSizeGB?: number

Valor da propriedade

number

osDiskType

O padrão será "Efêmero" se a VM der suporte a ela e tiver um disco de cache maior que o OSDiskSizeGB solicitado. Caso contrário, o padrão será 'Gerenciado'. Pode não ser alterado após a criação. Para obter mais informações, consulte do sistema operacional efêmero.

osDiskType?: string

Valor da propriedade

string

osSKU

Especifica o SKU do sistema operacional usado pelo pool de agentes. O padrão é Ubuntu se OSType for Linux. O padrão é o Windows2019 quando o Kubernetes <= 1,24 ou Windows2022 quando o Kubernetes >= 1,25 se o OSType for Windows.

osSKU?: string

Valor da propriedade

string

osType

O tipo de sistema operacional. O padrão é Linux.

osType?: string

Valor da propriedade

string

podSubnetID

Se omitidos, os IPs de pod são atribuídos estaticamente na sub-rede do nó (consulte vnetSubnetID para obter mais detalhes). Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

podSubnetID?: string

Valor da propriedade

string

powerState

Quando um Pool de Agentes é criado pela primeira vez, ele está em execução inicialmente. O Pool de Agentes pode ser interrompido definindo esse campo como Parado. Um Pool de Agentes interrompido interrompe todas as suas VMs e não acumula encargos de cobrança. Um pool de agentes só poderá ser interrompido se ele estiver em execução e o estado de provisionamento for bem-sucedido

powerState?: PowerState

Valor da propriedade

PowerState

provisioningState

O estado atual de implantação ou provisionamento. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor da propriedade

string

proximityPlacementGroupID

A ID do Grupo de Posicionamento por Proximidade.

proximityPlacementGroupID?: string

Valor da propriedade

string

scaleDownMode

Isso também afeta o comportamento do dimensionador automático do cluster. Se não for especificado, o padrão será Excluir.

scaleDownMode?: string

Valor da propriedade

string

scaleSetEvictionPolicy

Isso não pode ser especificado, a menos que scaleSetPriority seja 'Spot'. Se não for especificado, o padrão será 'Delete'.

scaleSetEvictionPolicy?: string

Valor da propriedade

string

scaleSetPriority

A prioridade do Conjunto de Dimensionamento de Máquinas Virtuais. Se não for especificado, o padrão será 'Regular'.

scaleSetPriority?: string

Valor da propriedade

string

securityProfile

As configurações de segurança de um pool de agentes.

securityProfile?: AgentPoolSecurityProfile

Valor da propriedade

AgentPoolSecurityProfile

spotMaxPrice

Os valores possíveis são qualquer valor decimal maior que zero ou -1 que indica a disposição de pagar qualquer preço sob demanda. Para obter mais detalhes sobre preços spot, consulte preços spot de VMs

spotMaxPrice?: number

Valor da propriedade

number

tags

As marcas a serem mantidas no conjunto de dimensionamento de máquinas virtuais do pool de agentes.

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

Valor da propriedade

{[propertyName: string]: string}

typePropertiesType

O tipo de Pool de Agentes.

typePropertiesType?: string

Valor da propriedade

string

upgradeSettings

Configurações para atualizar o agentpool

upgradeSettings?: AgentPoolUpgradeSettings

Valor da propriedade

AgentPoolUpgradeSettings

vmSize

A disponibilidade do tamanho da VM varia de acordo com a região. Se um nó contiver recursos de computação insuficientes (memória, cpu etc), os pods poderão não ser executados corretamente. Para obter mais detalhes sobre tamanhos restritos de VM, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vmSize?: string

Valor da propriedade

string

vnetSubnetID

Se isso não for especificado, uma VNET e uma sub-rede serão geradas e usadas. Se nenhum podSubnetID for especificado, isso se aplicará a nós e pods, caso contrário, aplica-se a apenas nós. Esse é o formulário: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID?: string

Valor da propriedade

string

windowsProfile

O perfil específico do pool de agentes do Windows.

windowsProfile?: AgentPoolWindowsProfile

Valor da propriedade

AgentPoolWindowsProfile

workloadRuntime

Determina o tipo de carga de trabalho que um nó pode executar.

workloadRuntime?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

id

ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

herdado deSubResource.id

name

O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

herdado deSubResource.name

type

Observação do tipo de recurso: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

herdado desubResource.type