ManagedClusterAgentPoolProfile interface

Paquet:

@azure-rest/arm-containerservice

Profil du pool d’agents de service de conteneur.

Extends

ManagedClusterAgentPoolProfileProperties

Propriétés

name	Les noms de pool d’agents Windows doivent être de 6 caractères ou moins.

Propriétés héritées

availabilityZones	Liste des zones de disponibilité à utiliser pour les nœuds. Cela ne peut être spécifié que si la propriété AgentPoolType est « VirtualMachineScaleSets ».
capacityReservationGroupID	AKS associe le pool d’agents spécifié au groupe de réservations de capacité.
count	Nombre d’agents (machines virtuelles) pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 0 et 1 000 (inclus) pour les pools d’utilisateurs et dans la plage comprise entre 1 et 1 000 (inclus) pour les pools système. La valeur par défaut est 1.
creationData	CreationData à utiliser pour spécifier l’ID d’instantané source si le pool de nœuds sera créé/mis à niveau à l’aide d’un instantané.
enableAutoScaling	Indique s’il faut activer la mise à l’échelle automatique
enableCustomCATrust	Quand la valeur est true, AKS déploie un démonet et des services hôtes pour synchroniser les autorités de certification personnalisées à partir d’un mappage de configuration fourni par l’utilisateur dans des magasins d’approbation de nœuds. La valeur par défaut est false.
enableEncryptionAtHost	Cela n’est pris en charge que sur certaines tailles de machine virtuelle et dans certaines régions Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFIPS	Pour plus d’informations, consultez Ajouter un pool de nœuds compatible FIPS.
enableNodePublicIP	Certains scénarios peuvent nécessiter des nœuds dans un pool de nœuds pour recevoir leurs propres adresses IP publiques dédiées. Un scénario courant concerne les charges de travail de jeu, où une console doit établir une connexion directe à une machine virtuelle cloud afin de réduire les tronçons. Pour plus d’informations, consultez affectation d’une adresse IP publique par nœud. La valeur par défaut est false.
enableUltraSSD	Indique s’il faut activer UltraSSD
gpuInstanceProfile	GPUInstanceProfile à utiliser pour spécifier le profil d’instance GPU MIG pour la référence SKU de machine virtuelle GPU prise en charge.
hostGroupID	Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Pour plus d’informations, consultez hôtes dédiés Azure.
kubeletConfig	Configuration Kubelet sur les nœuds du pool d’agents.
kubeletDiskType	Détermine le placement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.
linuxOSConfig	Configuration du système d’exploitation des nœuds de l’agent Linux.
maxCount	Nombre maximal de nœuds pour la mise à l’échelle automatique
maxPods	Nombre maximal de pods qui peuvent s’exécuter sur un nœud.
messageOfTheDay	Chaîne encodée en base64 qui sera écrite dans /etc/motd après le décodage. Cela permet la personnalisation du message du jour pour les nœuds Linux. Il ne doit pas être spécifié pour les nœuds Windows. Il doit s’agir d’une chaîne statique (c’est-à-dire d’impression brute et non exécutée en tant que script).
minCount	Nombre minimal de nœuds pour la mise à l’échelle automatique
mode	Un cluster doit avoir au moins un pool d’agents « Système » à tout moment. Pour plus d’informations sur les restrictions de pool d’agents et les meilleures pratiques, consultez : https://docs.microsoft.com/azure/aks/use-system-pools
nodeLabels	Étiquettes de nœud à conserver sur tous les nœuds du pool d’agents.
nodePublicIPPrefixID	Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	Les teintes ajoutées aux nouveaux nœuds pendant la création et la mise à l’échelle du pool de nœuds. Par exemple, key=value :NoSchedule.
orchestratorVersion	Les deux versions de correctif <> major.minor.patch et <> major.minor sont prises en charge. Lorsque <> major.minor est spécifié, la dernière version de correctif prise en charge est choisie automatiquement. La mise à jour du pool d’agents avec le même <major.minor> une fois qu’elle a été créée ne déclenche pas de mise à niveau, même si une version de correctif plus récente est disponible. En guise de meilleure pratique, vous devez mettre à niveau tous les pools de nœuds d’un cluster AKS vers la même version de Kubernetes. La version du pool de nœuds doit avoir la même version principale que le plan de contrôle. La version mineure du pool de nœuds doit se trouver dans deux versions mineures de la version du plan de contrôle. La version du pool de nœuds ne peut pas être supérieure à la version du plan de contrôle. Pour plus d’informations, consultez mise à niveau d’un pool de nœuds.
osDiskSizeGB	Taille du disque du système d’exploitation en Go à utiliser pour spécifier la taille du disque pour chaque ordinateur du pool maître/agent. Si vous spécifiez 0, elle applique la taille osDisk par défaut en fonction de vmSize spécifiée.
osDiskType	La valeur par défaut est « Éphémère » si la machine virtuelle la prend en charge et a un disque de cache supérieur à celui demandé d’OSDiskSizeGB. Sinon, la valeur par défaut est « Gérée ». Peut ne pas être modifié après la création. Pour plus d’informations, consultez système d’exploitation éphémère.
osSKU	Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. Si ce n’est pas spécifié, la valeur par défaut est Ubuntu si OSType=Linux ou Windows2019 si OSType=Windows. Et la référence WINDOWS OSSKU par défaut sera remplacée par Windows2022 après la dépréciation de Windows2019.
osType	Type de système d’exploitation. La valeur par défaut est Linux.
podSubnetID	En cas d’omission, les adresses IP de pod sont affectées statiquement sur le sous-réseau de nœud (voir vnetSubnetID pour plus d’informations). Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState	Lorsqu’un pool d’agents est créé pour la première fois, il est en cours d’exécution. Le pool d’agents peut être arrêté en définissant ce champ sur Arrêté. Un pool d’agents arrêté arrête toutes ses machines virtuelles et n’accumule pas de frais de facturation. Un pool d’agents ne peut être arrêté que s’il est en cours d’exécution et si l’état d’approvisionnement est Réussi
proximityPlacementGroupID	ID du groupe de placement de proximité.
scaleDownMode	Cela affecte également le comportement du générateur de mise à l’échelle automatique du cluster. S’il n’est pas spécifié, il est défini par défaut sur Delete.
scaleSetEvictionPolicy	Cela ne peut pas être spécifié, sauf si scaleSetPriority est « Spot ». S’il n’est pas spécifié, la valeur par défaut est « Supprimer ».
scaleSetPriority	Priorité du groupe de machines virtuelles identiques. S’il n’est pas spécifié, la valeur par défaut est « Standard ».
spotMaxPrice	Les valeurs possibles sont une valeur décimale supérieure à zéro ou -1 qui indique la volonté de payer n’importe quel prix à la demande. Pour plus d’informations sur la tarification spot, consultez tarification des machines virtuelles spot
tags	Balises à conserver sur le groupe de machines virtuelles identiques du pool d’agents.
type	Type de pool d’agents.
upgradeSettings	Paramètres de mise à niveau du pool d’agents
vmSize	La disponibilité de la taille des machines virtuelles varie selon la région. Si un nœud contient des ressources de calcul insuffisantes (mémoire, processeur, etc.) les pods peuvent échouer à s’exécuter correctement. Pour plus d’informations sur les tailles de machine virtuelle restreintes, consultez : https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	Si ce n’est pas spécifié, un réseau virtuel et un sous-réseau sont générés et utilisés. Si aucun podSubnetID n’est spécifié, cela s’applique aux nœuds et aux pods, sinon il s’applique uniquement aux nœuds. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
workloadRuntime	Détermine le type de charge de travail qu’un nœud peut exécuter.

Détails de la propriété

name

Les noms de pool d’agents Windows doivent être de 6 caractères ou moins.

name: string

Valeur de propriété

string

Détails de la propriété héritée

availabilityZones

Liste des zones de disponibilité à utiliser pour les nœuds. Cela ne peut être spécifié que si la propriété AgentPoolType est « VirtualMachineScaleSets ».

availabilityZones?: string[]

Valeur de propriété

string[]

héritée deManagedClusterAgentPoolProfileProperties.availabilityZones

capacityReservationGroupID

AKS associe le pool d’agents spécifié au groupe de réservations de capacité.

capacityReservationGroupID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.capacityReservationGroupID

count

Nombre d’agents (machines virtuelles) pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 0 et 1 000 (inclus) pour les pools d’utilisateurs et dans la plage comprise entre 1 et 1 000 (inclus) pour les pools système. La valeur par défaut est 1.

count?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.count

creationData

CreationData à utiliser pour spécifier l’ID d’instantané source si le pool de nœuds sera créé/mis à niveau à l’aide d’un instantané.

creationData?: CreationData

Valeur de propriété

CreationData

héritée deManagedClusterAgentPoolProfileProperties.creationData

enableAutoScaling

Indique s’il faut activer la mise à l’échelle automatique

enableAutoScaling?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableAutoScaling

enableCustomCATrust

Quand la valeur est true, AKS déploie un démonet et des services hôtes pour synchroniser les autorités de certification personnalisées à partir d’un mappage de configuration fourni par l’utilisateur dans des magasins d’approbation de nœuds. La valeur par défaut est false.

enableCustomCATrust?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableCustomCATrust

enableEncryptionAtHost

Cela n’est pris en charge que sur certaines tailles de machine virtuelle et dans certaines régions Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/aks/enable-host-encryption

enableEncryptionAtHost?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost

enableFIPS

Pour plus d’informations, consultez Ajouter un pool de nœuds compatible FIPS.

enableFIPS?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableFIPS

enableNodePublicIP

Certains scénarios peuvent nécessiter des nœuds dans un pool de nœuds pour recevoir leurs propres adresses IP publiques dédiées. Un scénario courant concerne les charges de travail de jeu, où une console doit établir une connexion directe à une machine virtuelle cloud afin de réduire les tronçons. Pour plus d’informations, consultez affectation d’une adresse IP publique par nœud. La valeur par défaut est false.

enableNodePublicIP?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableNodePublicIP

enableUltraSSD

Indique s’il faut activer UltraSSD

enableUltraSSD?: boolean

Valeur de propriété

boolean

héritée deManagedClusterAgentPoolProfileProperties.enableUltraSSSD

gpuInstanceProfile

GPUInstanceProfile à utiliser pour spécifier le profil d’instance GPU MIG pour la référence SKU de machine virtuelle GPU prise en charge.

gpuInstanceProfile?: "MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

Valeur de propriété

"MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

héritée deManagedClusterAgentPoolProfileProperties.gpuInstanceProfile

hostGroupID

Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Pour plus d’informations, consultez hôtes dédiés Azure.

hostGroupID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.hostGroupID

kubeletConfig

Configuration Kubelet sur les nœuds du pool d’agents.

kubeletConfig?: KubeletConfig

Valeur de propriété

KubeletConfig

héritée deManagedClusterAgentPoolProfileProperties.kubeletConfig

kubeletDiskType

Détermine le placement des volumes emptyDir, de la racine des données du runtime de conteneur et du stockage éphémère Kubelet.

kubeletDiskType?: "OS" | "Temporary"

Valeur de propriété

"OS" | "Temporary"

héritée deManagedClusterAgentPoolProfileProperties.kubeletDiskType

linuxOSConfig

Configuration du système d’exploitation des nœuds de l’agent Linux.

linuxOSConfig?: LinuxOSConfig

Valeur de propriété

LinuxOSConfig

héritée deManagedClusterAgentPoolProfileProperties.linuxOSConfig

maxCount

Nombre maximal de nœuds pour la mise à l’échelle automatique

maxCount?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.maxCount

maxPods

Nombre maximal de pods qui peuvent s’exécuter sur un nœud.

maxPods?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.maxPods

messageOfTheDay

Chaîne encodée en base64 qui sera écrite dans /etc/motd après le décodage. Cela permet la personnalisation du message du jour pour les nœuds Linux. Il ne doit pas être spécifié pour les nœuds Windows. Il doit s’agir d’une chaîne statique (c’est-à-dire d’impression brute et non exécutée en tant que script).

messageOfTheDay?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.messageOfTheDay

minCount

Nombre minimal de nœuds pour la mise à l’échelle automatique

minCount?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.minCount

mode

Un cluster doit avoir au moins un pool d’agents « Système » à tout moment. Pour plus d’informations sur les restrictions de pool d’agents et les meilleures pratiques, consultez : https://docs.microsoft.com/azure/aks/use-system-pools

mode?: "System" | "User"

Valeur de propriété

"System" | "User"

héritée deManagedClusterAgentPoolProfileProperties.mode

nodeLabels

Étiquettes de nœud à conserver sur tous les nœuds du pool d’agents.

nodeLabels?: Record<string, string>

Valeur de propriété

Record<string, string>

héritée deManagedClusterAgentPoolProfileProperties.nodeLabels

nodePublicIPPrefixID

Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID

nodeTaints

Les teintes ajoutées aux nouveaux nœuds pendant la création et la mise à l’échelle du pool de nœuds. Par exemple, key=value :NoSchedule.

nodeTaints?: string[]

Valeur de propriété

string[]

héritée deManagedClusterAgentPoolProfileProperties.nodeTaints

orchestratorVersion

Les deux versions de correctif <> major.minor.patch et <> major.minor sont prises en charge. Lorsque <> major.minor est spécifié, la dernière version de correctif prise en charge est choisie automatiquement. La mise à jour du pool d’agents avec le même <major.minor> une fois qu’elle a été créée ne déclenche pas de mise à niveau, même si une version de correctif plus récente est disponible. En guise de meilleure pratique, vous devez mettre à niveau tous les pools de nœuds d’un cluster AKS vers la même version de Kubernetes. La version du pool de nœuds doit avoir la même version principale que le plan de contrôle. La version mineure du pool de nœuds doit se trouver dans deux versions mineures de la version du plan de contrôle. La version du pool de nœuds ne peut pas être supérieure à la version du plan de contrôle. Pour plus d’informations, consultez mise à niveau d’un pool de nœuds.

orchestratorVersion?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.orchestratorVersion

osDiskSizeGB

Taille du disque du système d’exploitation en Go à utiliser pour spécifier la taille du disque pour chaque ordinateur du pool maître/agent. Si vous spécifiez 0, elle applique la taille osDisk par défaut en fonction de vmSize spécifiée.

osDiskSizeGB?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.osDiskSizeGB

osDiskType

La valeur par défaut est « Éphémère » si la machine virtuelle la prend en charge et a un disque de cache supérieur à celui demandé d’OSDiskSizeGB. Sinon, la valeur par défaut est « Gérée ». Peut ne pas être modifié après la création. Pour plus d’informations, consultez système d’exploitation éphémère.

osDiskType?: "Managed" | "Ephemeral"

Valeur de propriété

"Managed" | "Ephemeral"

héritée deManagedClusterAgentPoolProfileProperties.osDiskType

osSKU

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. Si ce n’est pas spécifié, la valeur par défaut est Ubuntu si OSType=Linux ou Windows2019 si OSType=Windows. Et la référence WINDOWS OSSKU par défaut sera remplacée par Windows2022 après la dépréciation de Windows2019.

osSKU?: "Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

Valeur de propriété

"Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

héritée deManagedClusterAgentPoolProfileProperties.osSKU

osType

Type de système d’exploitation. La valeur par défaut est Linux.

osType?: "Linux" | "Windows"

Valeur de propriété

"Linux" | "Windows"

héritée deManagedClusterAgentPoolProfileProperties.osType

podSubnetID

En cas d’omission, les adresses IP de pod sont affectées statiquement sur le sous-réseau de nœud (voir vnetSubnetID pour plus d’informations). Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

podSubnetID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.podSubnetID

powerState

Lorsqu’un pool d’agents est créé pour la première fois, il est en cours d’exécution. Le pool d’agents peut être arrêté en définissant ce champ sur Arrêté. Un pool d’agents arrêté arrête toutes ses machines virtuelles et n’accumule pas de frais de facturation. Un pool d’agents ne peut être arrêté que s’il est en cours d’exécution et si l’état d’approvisionnement est Réussi

powerState?: PowerState

Valeur de propriété

PowerState

héritée deManagedClusterAgentPoolProfileProperties.powerState

proximityPlacementGroupID

ID du groupe de placement de proximité.

proximityPlacementGroupID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID

scaleDownMode

Cela affecte également le comportement du générateur de mise à l’échelle automatique du cluster. S’il n’est pas spécifié, il est défini par défaut sur Delete.

scaleDownMode?: "Delete" | "Deallocate"

Valeur de propriété

"Delete" | "Deallocate"

héritée deManagedClusterAgentPoolProfileProperties.scaleDownMode

scaleSetEvictionPolicy

Cela ne peut pas être spécifié, sauf si scaleSetPriority est « Spot ». S’il n’est pas spécifié, la valeur par défaut est « Supprimer ».

scaleSetEvictionPolicy?: "Delete" | "Deallocate"

Valeur de propriété

"Delete" | "Deallocate"

héritée deManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy

scaleSetPriority

Priorité du groupe de machines virtuelles identiques. S’il n’est pas spécifié, la valeur par défaut est « Standard ».

scaleSetPriority?: "Spot" | "Regular"

Valeur de propriété

"Spot" | "Regular"

héritée deManagedClusterAgentPoolProfileProperties.scaleSetPriority

spotMaxPrice

Les valeurs possibles sont une valeur décimale supérieure à zéro ou -1 qui indique la volonté de payer n’importe quel prix à la demande. Pour plus d’informations sur la tarification spot, consultez tarification des machines virtuelles spot

spotMaxPrice?: number

Valeur de propriété

number

héritée deManagedClusterAgentPoolProfileProperties.spotMaxPrice

tags

Balises à conserver sur le groupe de machines virtuelles identiques du pool d’agents.

tags?: Record<string, string>

Valeur de propriété

Record<string, string>

héritée deManagedClusterAgentPoolProfileProperties.tags

type

Type de pool d’agents.

type?: "VirtualMachineScaleSets" | "AvailabilitySet"

Valeur de propriété

"VirtualMachineScaleSets" | "AvailabilitySet"

héritée deManagedClusterAgentPoolProfileProperties.type

upgradeSettings

Paramètres de mise à niveau du pool d’agents

upgradeSettings?: AgentPoolUpgradeSettings

Valeur de propriété

AgentPoolUpgradeSettings

héritée deManagedClusterAgentPoolProfileProperties.upgradeSettings

vmSize

La disponibilité de la taille des machines virtuelles varie selon la région. Si un nœud contient des ressources de calcul insuffisantes (mémoire, processeur, etc.) les pods peuvent échouer à s’exécuter correctement. Pour plus d’informations sur les tailles de machine virtuelle restreintes, consultez : https://docs.microsoft.com/azure/aks/quotas-skus-regions

vmSize?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.vmSize

vnetSubnetID

Si ce n’est pas spécifié, un réseau virtuel et un sous-réseau sont générés et utilisés. Si aucun podSubnetID n’est spécifié, cela s’applique aux nœuds et aux pods, sinon il s’applique uniquement aux nœuds. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID?: string

Valeur de propriété

string

héritée deManagedClusterAgentPoolProfileProperties.vnetSubnetID

workloadRuntime

Détermine le type de charge de travail qu’un nœud peut exécuter.

workloadRuntime?: "OCIContainer" | "WasmWasi"

Valeur de propriété

"OCIContainer" | "WasmWasi"

héritée deManagedClusterAgentPoolProfileProperties.workloadRuntime