AgentPool Classe

Conjunto de Agentes.

As variáveis só são preenchidas pelo servidor e serão ignoradas ao enviar um pedido.

Herança
azure.mgmt.containerservice.v2021_09_01.models._models_py3.SubResource
AgentPool

Construtor

AgentPool(*, count: int | None = None, vm_size: str | None = None, os_disk_size_gb: int | None = None, os_disk_type: str | _models.OSDiskType | None = None, kubelet_disk_type: str | _models.KubeletDiskType | None = None, workload_runtime: str | _models.WorkloadRuntime | None = None, vnet_subnet_id: str | None = None, pod_subnet_id: str | None = None, max_pods: int | None = None, os_type: str | _models.OSType = 'Linux', os_sku: str | _models.OSSKU | None = None, max_count: int | None = None, min_count: int | None = None, enable_auto_scaling: bool | None = None, scale_down_mode: str | _models.ScaleDownMode | None = None, type_properties_type: str | _models.AgentPoolType | None = None, mode: str | _models.AgentPoolMode | None = None, orchestrator_version: str | None = None, upgrade_settings: _models.AgentPoolUpgradeSettings | None = None, power_state: _models.PowerState | None = None, availability_zones: List[str] | None = None, enable_node_public_ip: bool | None = None, node_public_ip_prefix_id: str | None = None, scale_set_priority: str | _models.ScaleSetPriority = 'Regular', scale_set_eviction_policy: str | _models.ScaleSetEvictionPolicy = 'Delete', spot_max_price: float = -1, tags: Dict[str, str] | None = None, node_labels: Dict[str, str] | None = None, node_taints: List[str] | None = None, proximity_placement_group_id: str | None = None, kubelet_config: _models.KubeletConfig | None = None, linux_os_config: _models.LinuxOSConfig | None = None, enable_encryption_at_host: bool | None = None, enable_ultra_ssd: bool | None = None, enable_fips: bool | None = None, gpu_instance_profile: str | _models.GPUInstanceProfile | None = None, creation_data: _models.CreationData | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name Description
count
int

Número de agentes (VMs) para alojar contentores docker. Os valores permitidos têm de estar entre 0 e 1000 (inclusive) para conjuntos de utilizadores e no intervalo de 1 a 1000 (inclusive) para conjuntos de sistemas. O valor predefinido é 1.

vm_size
str

A disponibilidade do tamanho da VM varia consondo 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 de VM restritos, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions.

os_disk_size_gb
int

Tamanho do Disco do SO em GB a ser utilizado para especificar o tamanho do disco para cada máquina no conjunto principal/agente. Se especificar 0, este aplicará o tamanho do osDisk predefinido de acordo com o vmSize especificado.

os_disk_type

A predefinição é "Efémero" se a VM o suportar e tiver um disco de cache maior do que o OSDiskSizeGB pedido. Caso contrário, a predefinição é "Gerido". Pode não ser alterado após a criação. Para obter mais informações, veja SO efémero. Os valores conhecidos são: "Gerido" e "Efémero".

kubelet_disk_type

Determina a colocação de volumes emptyDir, raiz de dados de runtime de contentor e armazenamento efémero do Kubelet. Os valores conhecidos são: "SO" e "Temporário".

workload_runtime

Determina o tipo de carga de trabalho que um nó pode executar. Os valores conhecidos são: "OCIContainer" e "WasmWasi".

vnet_subnet_id
str

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

pod_subnet_id
str

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

max_pods
int

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

os_type
str ou OSType

O tipo de sistema operativo. A predefinição é Linux. Os valores conhecidos são: "Linux" e "Windows".

valor predefinido: Linux
os_sku
str ou OSSKU

Especifica um SKU do SO. Este valor não pode ser especificado se OSType for Windows. Os valores conhecidos são: "Ubuntu" e "CBLMariner".

max_count
int

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

min_count
int

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

enable_auto_scaling

Se pretende ativar o dimensionador automático.

scale_down_mode

Isto também afeta o comportamento do dimensionador automático do cluster. Se não for especificado, a predefinição é Eliminar. Os valores conhecidos são: "Eliminar" e "Desalocar".

type_properties_type

O tipo de Conjunto de Agentes. Os valores conhecidos são: "VirtualMachineScaleSets" e "AvailabilitySet".

mode

Um cluster tem de ter, pelo menos, um Conjunto de Agentes "Sistema" em todos os momentos. Para obter informações adicionais sobre as restrições do conjunto de agentes e as melhores práticas, consulte: https://docs.microsoft.com/azure/aks/use-system-pools. Os valores conhecidos são: "Sistema" e "Utilizador".

orchestrator_version
str

Como melhor prática, deve atualizar todos os conjuntos de nós num cluster do AKS para a mesma versão do Kubernetes. A versão do conjunto de nós tem de ter a mesma versão principal que o plano de controlo. A versão secundária do conjunto de nós tem de estar dentro de duas versões secundárias da versão do plano de controlo. A versão do conjunto de nós não pode ser maior do que a versão do plano de controlo. Para obter mais informações, veja atualizar um conjunto de nós.

upgrade_settings

Definições para atualizar o conjunto de agentes.

power_state

Quando um Conjunto de Agentes é criado pela primeira vez, está inicialmente em Execução. O Conjunto de Agentes pode ser parado ao definir este campo como Parado. Um Conjunto de Agentes parado para todas as VMs e não acumula custos de faturação. Um Conjunto de Agentes só pode ser parado se estiver em Execução e o estado de aprovisionamento for Bem-sucedido.

availability_zones

A lista de zonas de disponibilidade a utilizar para nós. Isto só pode ser especificado se a propriedade AgentPoolType for "VirtualMachineScaleSets".

enable_node_public_ip

Alguns cenários podem exigir que os nós num conjunto de nós recebam os seus próprios endereços IP públicos dedicados. Um cenário comum é para cargas de trabalho de jogos, em que uma consola precisa de fazer uma ligação direta a uma máquina virtual da cloud para minimizar os saltos. Para obter mais informações, veja Atribuir um IP público por nó. A predefinição é falsa.

node_public_ip_prefix_id
str

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

scale_set_priority

A prioridade do Conjunto de Dimensionamento de Máquinas Virtuais. Se não for especificado, a predefinição é "Regular". Os valores conhecidos são: "Spot" e "Regular".

valor predefinido: Regular
scale_set_eviction_policy

Não é possível especificar esta opção, a menos que o scaleSetPriority seja "Spot". Se não for especificado, a predefinição é "Eliminar". Os valores conhecidos são: "Eliminar" e "Desalocar".

valor predefinido: Delete
spot_max_price

Os valores possíveis são qualquer valor decimal superior a zero ou -1 que indique a disponibilidade para pagar qualquer preço a pedido. Para obter mais detalhes sobre os preços spot, veja preços de VMs spot.

valor predefinido: -1
tags

As etiquetas a manter no conjunto de dimensionamento de máquinas virtuais do conjunto de agentes.

node_labels

As etiquetas de nó a manter em todos os nós no conjunto de agentes.

node_taints

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

proximity_placement_group_id
str

O ID do Grupo de Colocação por Proximidade.

kubelet_config

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

linux_os_config

A configuração do SO dos nós de agente do Linux.

enable_encryption_at_host

Isto só é suportado 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.

enable_ultra_ssd

Se pretende ativar o UltraSSD.

enable_fips

Veja Adicionar um conjunto de nós com FIPS ativado para obter mais detalhes.

gpu_instance_profile

GPUInstanceProfile a ser utilizado para especificar o perfil de instância do GPU MIG para o SKU de VM de GPU suportado. Os valores conhecidos são: "MIG1g", "MIG2g", "MIG3g", "MIG4g" e "MIG7g".

creation_data

CreationData a ser utilizado para especificar o ID de Instantâneo de origem se o conjunto de nós for criado/atualizado com um instantâneo.

Variáveis

Name Description
id
str

ID do Recurso.

name
str

O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.

type
str

Tipo de recurso.

count
int

Número de agentes (VMs) para alojar contentores docker. Os valores permitidos têm de estar entre 0 e 1000 (inclusive) para conjuntos de utilizadores e no intervalo de 1 a 1000 (inclusive) para conjuntos de sistemas. O valor predefinido é 1.

vm_size
str

A disponibilidade do tamanho da VM varia consondo 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 de VM restritos, consulte: https://docs.microsoft.com/azure/aks/quotas-skus-regions.

os_disk_size_gb
int

Tamanho do Disco do SO em GB a ser utilizado para especificar o tamanho do disco para cada máquina no conjunto principal/agente. Se especificar 0, este aplicará o tamanho do osDisk predefinido de acordo com o vmSize especificado.

os_disk_type

A predefinição é "Efémero" se a VM o suportar e tiver um disco de cache maior do que o OSDiskSizeGB pedido. Caso contrário, a predefinição é "Gerido". Pode não ser alterado após a criação. Para obter mais informações, veja SO efémero. Os valores conhecidos são: "Gerido" e "Efémero".

kubelet_disk_type

Determina a colocação de volumes emptyDir, raiz de dados de runtime de contentor e armazenamento efémero do Kubelet. Os valores conhecidos são: "SO" e "Temporário".

workload_runtime

Determina o tipo de carga de trabalho que um nó pode executar. Os valores conhecidos são: "OCIContainer" e "WasmWasi".

vnet_subnet_id
str

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

pod_subnet_id
str

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

max_pods
int

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

os_type
str ou OSType

O tipo de sistema operativo. A predefinição é Linux. Os valores conhecidos são: "Linux" e "Windows".

os_sku
str ou OSSKU

Especifica um SKU do SO. Este valor não pode ser especificado se OSType for Windows. Os valores conhecidos são: "Ubuntu" e "CBLMariner".

max_count
int

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

min_count
int

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

enable_auto_scaling

Se pretende ativar o dimensionador automático.

scale_down_mode

Isto também afeta o comportamento do dimensionador automático do cluster. Se não for especificado, a predefinição é Eliminar. Os valores conhecidos são: "Eliminar" e "Desalocar".

type_properties_type

O tipo de Conjunto de Agentes. Os valores conhecidos são: "VirtualMachineScaleSets" e "AvailabilitySet".

mode

Um cluster tem de ter, pelo menos, um Conjunto de Agentes "Sistema" em todos os momentos. Para obter informações adicionais sobre as restrições do conjunto de agentes e as melhores práticas, consulte: https://docs.microsoft.com/azure/aks/use-system-pools. Os valores conhecidos são: "Sistema" e "Utilizador".

orchestrator_version
str

Como melhor prática, deve atualizar todos os conjuntos de nós num cluster do AKS para a mesma versão do Kubernetes. A versão do conjunto de nós tem de ter a mesma versão principal que o plano de controlo. A versão secundária do conjunto de nós tem de estar dentro de duas versões secundárias da versão do plano de controlo. A versão do conjunto de nós não pode ser maior do que a versão do plano de controlo. Para obter mais informações, veja atualizar um conjunto de nós.

node_image_version
str

A versão da imagem do nó.

upgrade_settings

Definições para atualizar o conjunto de agentes.

provisioning_state
str

O estado de implementação ou aprovisionamento atual.

power_state

Quando um Conjunto de Agentes é criado pela primeira vez, está inicialmente em Execução. O Conjunto de Agentes pode ser parado ao definir este campo como Parado. Um Conjunto de Agentes parado para todas as VMs e não acumula custos de faturação. Um Conjunto de Agentes só pode ser parado se estiver em Execução e o estado de aprovisionamento for Bem-sucedido.

availability_zones

A lista de zonas de disponibilidade a utilizar para nós. Isto só pode ser especificado se a propriedade AgentPoolType for "VirtualMachineScaleSets".

enable_node_public_ip

Alguns cenários podem exigir que os nós num conjunto de nós recebam os seus próprios endereços IP públicos dedicados. Um cenário comum é para cargas de trabalho de jogos, em que uma consola precisa de fazer uma ligação direta a uma máquina virtual da cloud para minimizar os saltos. Para obter mais informações, veja Atribuir um IP público por nó. A predefinição é falsa.

node_public_ip_prefix_id
str

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

scale_set_priority

A prioridade do Conjunto de Dimensionamento de Máquinas Virtuais. Se não for especificado, a predefinição é "Regular". Os valores conhecidos são: "Spot" e "Regular".

scale_set_eviction_policy

Não é possível especificar esta opção, a menos que o scaleSetPriority seja "Spot". Se não for especificado, a predefinição é "Eliminar". Os valores conhecidos são: "Eliminar" e "Desalocar".

spot_max_price

Os valores possíveis são qualquer valor decimal superior a zero ou -1 que indique a disponibilidade para pagar qualquer preço a pedido. Para obter mais detalhes sobre os preços spot, veja preços de VMs spot.

tags

As etiquetas a manter no conjunto de dimensionamento de máquinas virtuais do conjunto de agentes.

node_labels

As etiquetas de nó a manter em todos os nós no conjunto de agentes.

node_taints

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

proximity_placement_group_id
str

O ID do Grupo de Colocação por Proximidade.

kubelet_config

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

linux_os_config

A configuração do SO dos nós de agente do Linux.

enable_encryption_at_host

Isto só é suportado 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.

enable_ultra_ssd

Se pretende ativar o UltraSSD.

enable_fips

Veja Adicionar um conjunto de nós com FIPS ativado para obter mais detalhes.

gpu_instance_profile

GPUInstanceProfile a ser utilizado para especificar o perfil de instância do GPU MIG para o SKU de VM de GPU suportado. Os valores conhecidos são: "MIG1g", "MIG2g", "MIG3g", "MIG4g" e "MIG7g".

creation_data

CreationData a ser utilizado para especificar o ID de Instantâneo de origem se o conjunto de nós for criado/atualizado com um instantâneo.