Agent Pools - Get

Service:

AKS

Version d'API:

2025-05-01

Obtient le pool d’agents de cluster managé spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2025-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	Nom du pool d’agents.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	Nom de la ressource de cluster managé.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	AgentPool	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get Agent Pool

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "eTag": "ebwiyfneowv",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
    "upgradeSettings": {
      "maxSurge": "33%"
    }
  }
}

Définitions

Nom	Description
AgentPool	Pool d’agents.
AgentPoolGatewayProfile	Profil du pool d’agents de passerelle de cluster managé.
AgentPoolMode	Mode d’un pool d’agents. 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
AgentPoolNetworkProfile	Paramètres réseau d’un pool d’agents.
AgentPoolSecurityProfile	Paramètres de sécurité d’un pool d’agents.
AgentPoolStatus	Contient des informations en lecture seule sur le pool d’agents.
AgentPoolType	Type de pool d’agents.
AgentPoolUpgradeSettings	Paramètres de mise à niveau d’un pool d’agents
AgentPoolWindowsProfile	Profil spécifique du pool d’agents Windows.
CloudError	Réponse d’erreur du service Conteneur.
CloudErrorBody	Réponse d’erreur du service Conteneur.
code	Indique si le cluster est en cours d’exécution ou arrêté
CreationData	Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.
GPUDriver	Indique s’il faut installer des pilotes GPU. Quand elle n’est pas spécifiée, la valeur par défaut est Install.
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.
GPUProfile	Paramètres GPU pour le pool d’agents.
IPTag	Contient l’IPTag associé à l’objet.
KubeletConfig	Configurations Kubelet des nœuds d’agent. Pour plus d’informations, consultez de configuration de nœud personnalisée AKS.
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	Configurations du système d’exploitation des nœuds d’agent Linux. Pour plus d’informations, consultez de configuration de nœud personnalisée AKS.
ManualScaleProfile	Spécifications sur le nombre de machines.
OSDiskType	Type de disque du système d’exploitation à utiliser pour les machines du pool d’agents. 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 le 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. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
OSType	Type de système d’exploitation. La valeur par défaut est Linux.
PodIPAllocationMode	Mode d’allocation IP du pod. Mode d’allocation IP pour les pods dans le pool d’agents. Doit être utilisé avec podSubnetId. La valeur par défaut est « DynamicIndividual ».
PortRange	Plage de ports.
PowerState	Décrit l’état de l’alimentation du cluster
Protocol	Protocole réseau du port.
ScaleDownMode	Décrit comment les machines virtuelles sont ajoutées ou supprimées des pools d’agents. Consultez les états de facturation.
ScaleProfile	Spécifications sur la façon de mettre à l’échelle un pool d’agents VirtualMachines.
ScaleSetEvictionPolicy	Stratégie d’éviction du groupe de machines virtuelles identiques. La stratégie d’éviction spécifie ce qu’il faut faire de la machine virtuelle lorsqu’elle est expulsée. La valeur par défaut est Supprimer. Pour plus d’informations sur l’éviction, consultez VM spot
ScaleSetPriority	Priorité du groupe de machines virtuelles identiques.
SysctlConfig	Paramètres Sysctl pour les nœuds d’agent Linux.
UndrainableNodeBehavior	Définit le comportement des nœuds indrainables pendant la mise à niveau. La cause la plus courante des nœuds indrainables est les budgets d’interruption de pod (PDB), mais d’autres problèmes, tels que la période de grâce de terminaison de pod, dépassent le délai d’expiration du drainage par nœud restant ou le pod est toujours dans un état d’exécution, peut également entraîner des nœuds indrainables.
VirtualMachineNodes	État actuel sur un groupe de nœuds de la même taille de machine virtuelle.
VirtualMachinesProfile	Spécifications sur le pool d’agents VirtualMachines.
WorkloadRuntime	Détermine le type de charge de travail qu’un nœud peut exécuter.

AgentPool

Object

Pool d’agents.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource.
name	string		Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.availabilityZones	string[]		Liste des zones de disponibilité à utiliser pour les nœuds. Cela ne peut être spécifié que si la propriété AgentPoolType est « VirtualMachineScaleSets ».
properties.capacityReservationGroupID	string (arm-id)		AKS associe le pool d’agents spécifié au groupe de réservations de capacité.
properties.count	integer (int32)		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.
properties.creationData	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é.
properties.currentOrchestratorVersion	string		La version de Kubernetes du pool d’agents est en cours d’exécution. Si orchestratorVersion est une version entièrement spécifiée <major.minor.patch>, ce champ est exactement égal à celui-ci. Si orchestratorVersion est <>major.minor, ce champ contient la version complète <major.minor.patch> utilisée.
properties.eTag	string		Chaîne en lecture seule unique utilisée pour implémenter l’accès concurrentiel optimiste. La valeur eTag change lorsque la ressource est mise à jour. Spécifiez un en-tête if-match ou if-none-match avec la valeur eTag d’une requête suivante pour activer la concurrence optimiste conformément à la convention etag normale.
properties.enableAutoScaling	boolean		Indique s’il faut activer la mise à l’échelle automatique
properties.enableEncryptionAtHost	boolean		Indique s’il faut activer le chiffrement du système d’exploitation et du lecteur de données basés sur l’hôte. 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
properties.enableFIPS	boolean		Indique s’il faut utiliser un système d’exploitation compatible FIPS. Pour plus d’informations, consultez Ajouter un pool de nœuds compatible FIPS .
properties.enableNodePublicIP	boolean		Indique si chaque nœud est alloué à sa propre adresse IP publique. 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 l’attribution d’une adresse IP publique par nœud. La valeur par défaut est false.
properties.enableUltraSSD	boolean		Indique s’il faut activer UltraSSD
properties.gatewayProfile	AgentPoolGatewayProfile		Profil spécifique à un pool d’agents managés en mode passerelle. Ce champ ne peut pas être défini si le mode pool d’agents n’est pas passerelle.
properties.gpuInstanceProfile	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.
properties.gpuProfile	GPUProfile		Paramètres GPU pour le pool d’agents.
properties.hostGroupID	string (arm-id)		ID de ressource complet du groupe hôte dédié à partir duquel provisionner des machines virtuelles, utilisé uniquement dans le scénario de création et non autorisé à changer une fois défini. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Pour plus d’informations, consultez les hôtes dédiés Azure.
properties.kubeletConfig	KubeletConfig		Configuration Kubelet sur les nœuds du pool d’agents.
properties.kubeletDiskType	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.
properties.linuxOSConfig	LinuxOSConfig		Configuration du système d’exploitation des nœuds de l’agent Linux.
properties.maxCount	integer (int32)		Nombre maximal de nœuds pour la mise à l’échelle automatique
properties.maxPods	integer (int32)		Nombre maximal de pods qui peuvent s’exécuter sur un nœud.
properties.messageOfTheDay	string		Message du jour pour les nœuds Linux, encodés en base64. 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).
properties.minCount	integer (int32)		Nombre minimal de nœuds pour la mise à l’échelle automatique
properties.mode	AgentPoolMode		Mode d’un pool d’agents. 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
properties.networkProfile	AgentPoolNetworkProfile		Paramètres liés au réseau d’un pool d’agents.
properties.nodeImageVersion	string		Version de l’image de nœud
properties.nodeLabels	object		Étiquettes de nœud à conserver sur tous les nœuds du pool d’agents.
properties.nodePublicIPPrefixID	string (arm-id)		ID de préfixe IP public à partir duquel les nœuds de machine virtuelle doivent utiliser des adresses IP. Il s’agit de la forme suivante : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints	string[]		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.
properties.orchestratorVersion	string		Version de Kubernetes spécifiée par l’utilisateur. Les deux versions <correctives major.minor.patch> (par exemple, 1.20.13) et <major.minor> (par exemple, 1.20) sont prises en charge. Lorsque <major.minor> est spécifié, la dernière version de correctif ga prise en charge est choisie automatiquement. La mise à jour du cluster avec le même <fichier major.minor> une fois qu’il a été créé (par exemple, 1.14.x -> 1.14) 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 la mise à niveau d’un pool de nœuds.
properties.osDiskSizeGB	integer (int32) minimum: 0 maximum: 2048		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.
properties.osDiskType	OSDiskType		Type de disque du système d’exploitation à utiliser pour les machines du pool d’agents. 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 le système d’exploitation éphémère.
properties.osSKU	OSSKU		Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
properties.osType	OSType	Linux	Type de système d’exploitation. La valeur par défaut est Linux.
properties.podIPAllocationMode	PodIPAllocationMode		Mode d’allocation IP du pod. Mode d’allocation IP pour les pods dans le pool d’agents. Doit être utilisé avec podSubnetId. La valeur par défaut est « DynamicIndividual ».
properties.podSubnetID	string (arm-id)		ID du sous-réseau auquel les pods seront joints lors du lancement. 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}
properties.powerState	PowerState		Indique si le pool d’agents est en cours d’exécution ou arrêté. 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
properties.provisioningState	string		État actuel du déploiement ou de l’approvisionnement.
properties.proximityPlacementGroupID	string (arm-id)		ID du groupe de placement de proximité.
properties.scaleDownMode	ScaleDownMode		Mode scale-down à utiliser lors de la mise à l’échelle du pool d’agents. 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.
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	Stratégie d’éviction du groupe de machines virtuelles identiques à utiliser. 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 ».
properties.scaleSetPriority	ScaleSetPriority	Regular	Priorité du groupe de machines virtuelles identiques. S’il n’est pas spécifié, la valeur par défaut est « Standard ».
properties.securityProfile	AgentPoolSecurityProfile		Paramètres de sécurité d’un pool d’agents.
properties.spotMaxPrice	number	-1	Le prix maximal (en dollars AMÉRICAINs) que vous êtes prêt à payer pour les instances spot. Les valeurs possibles sont toutes les valeurs décimales supérieures à zéro ou -1 qui indiquent le prix par défaut up-to à la demande. 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 la tarification des machines virtuelles spot
properties.status	AgentPoolStatus		Contient des informations en lecture seule sur le pool d’agents.
properties.tags	object		Balises à conserver sur le groupe de machines virtuelles identiques du pool d’agents.
properties.type	AgentPoolType		Type de pool d’agents.
properties.upgradeSettings	AgentPoolUpgradeSettings		Paramètres de mise à niveau du pool d’agents
properties.virtualMachineNodesStatus	VirtualMachineNodes[]		État des nœuds dans un pool d’agents VirtualMachines.
properties.virtualMachinesProfile	VirtualMachinesProfile		Spécifications sur le pool d’agents VirtualMachines.
properties.vmSize	string		Taille des machines virtuelles du pool d’agents. 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
properties.vnetSubnetID	string (arm-id)		ID du sous-réseau sur lequel les nœuds du pool d’agents et éventuellement les pods se joignent au démarrage. 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}
properties.windowsProfile	AgentPoolWindowsProfile		Profil spécifique du pool d’agents Windows.
properties.workloadRuntime	WorkloadRuntime		Détermine le type de charge de travail qu’un nœud peut exécuter.
type	string		Type de ressource

AgentPoolGatewayProfile

Object

Profil du pool d’agents de passerelle de cluster managé.

Nom	Type	Valeur par défaut	Description
publicIPPrefixSize	integer (int32) minimum: 28 maximum: 31	31	Le pool d’agents de passerelle associe un IPPrefix public pour chaque passerelle de sortie statique pour fournir une sortie publique. La taille d’IPPrefix publique doit être sélectionnée par l’utilisateur. Chaque nœud du pool d’agents est affecté avec une adresse IP à partir de l’adresse IPPrefix. La taille IPPrefix sert donc de limite à la taille du pool d’agents de passerelle. En raison de la limitation de taille d’IPPrefix publique Azure, la plage de valeurs valide est [28, 31] (/31 = 2 nœuds/adresses IP, /30 = 4 nœuds/adresses IP, /29 = 8 nœuds/adresses IP, /28 = 16 nœuds/adresses IP). La valeur par défaut est 31.

AgentPoolMode

Énumération

Mode d’un pool d’agents. 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

Valeur	Description
Gateway	Les pools d’agents de passerelle sont dédiés à fournir des adresses IP de sortie statiques aux pods. Pour plus d’informations, consultez https://aka.ms/aks/static-egress-gateway.
System	Les pools d’agents système sont principalement destinés à héberger des pods système critiques tels que CoreDNS et metrics-server. Les pools d’agents système osType doivent être Linux. La référence SKU de machine virtuelle des pools d’agents système doit avoir au moins 2 processeurs virtuels et 4 Go de mémoire.
User	Les pools d’agents utilisateur sont principalement destinés à héberger vos pods d’application.

AgentPoolNetworkProfile

Object

Paramètres réseau d’un pool d’agents.

Nom	Type	Description
allowedHostPorts	PortRange[]	Plages de ports autorisées à accéder. Les plages spécifiées sont autorisées à se chevaucher.
applicationSecurityGroups	string[] (arm-id)	ID des groupes de sécurité d’application associés au pool d’agents lors de la création.
nodePublicIPTags	IPTag[]	IPTags d’adresses IP publiques au niveau de l’instance.

AgentPoolSecurityProfile

Object

Paramètres de sécurité d’un pool d’agents.

Nom	Type	Description
enableSecureBoot	boolean	Le démarrage sécurisé est une fonctionnalité de lancement approuvé qui garantit que seuls les systèmes d’exploitation signés et les pilotes peuvent démarrer. Pour plus d’informations, consultez aka.ms/aks/trustedlaunch. S’il n’est pas spécifié, la valeur par défaut est false.
enableVTPM	boolean	vTPM est une fonctionnalité de lancement approuvé permettant de configurer un coffre sécurisé dédié pour les clés et les mesures conservées localement sur le nœud. Pour plus d’informations, consultez aka.ms/aks/trustedlaunch. S’il n’est pas spécifié, la valeur par défaut est false.

AgentPoolStatus

Object

Contient des informations en lecture seule sur le pool d’agents.

Nom	Type	Description
provisioningError	CloudErrorBody	Informations détaillées sur l’erreur du pool d’agents. Conserve les informations détaillées de l’échec. En l’absence d’erreur, ce champ est omis.

AgentPoolType

Énumération

Type de pool d’agents.

Valeur	Description
AvailabilitySet	L’utilisation de ce problème est fortement déconseillée.
VirtualMachineScaleSets	Créez un pool d’agents soutenu par un groupe de machines virtuelles identiques.
VirtualMachines	Créez un pool d’agents soutenu par un mode d’orchestration de machine virtuelle à instance unique.

AgentPoolUpgradeSettings

Object

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

Nom	Type	Description
drainTimeoutInMinutes	integer (int32) minimum: 1 maximum: 1440	Délai d’expiration de l’écoulement d’un nœud. Durée (en minutes) d’attente de l’éviction des pods et de l’arrêt approprié par nœud. Ce temps d’attente d’éviction respecte les budgets d’interruption des pods. Si cette durée est dépassée, la mise à niveau échoue. Si aucun délai n’est spécifié, la valeur par défaut est de 30 minutes.
maxSurge	string	Nombre maximal ou pourcentage de nœuds qui sont augmentés pendant la mise à niveau. Cela peut être défini sur un entier (par exemple, « 5 ») ou sur un pourcentage (par exemple, « 50%»). Si un pourcentage est spécifié, il s’agit du pourcentage de la taille totale du pool d’agents au moment de la mise à niveau. Pour les pourcentages, les nœuds fractionnaires sont arrondis. Si ce n’est pas spécifié, la valeur par défaut est 10%. Pour plus d’informations, notamment les meilleures pratiques, consultez : https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable	string	Nombre maximal ou pourcentage de nœuds qui peuvent être simultanément indisponibles pendant la mise à niveau. Cela peut être défini sur un entier (par exemple, « 1 ») ou un pourcentage (par exemple, « 5%»). Si un pourcentage est spécifié, il s’agit du pourcentage de la taille totale du pool d’agents au moment de la mise à niveau. Pour les pourcentages, les nœuds fractionnaires sont arrondis. Si ce n’est pas spécifié, la valeur par défaut est 0. Pour plus d’informations, notamment les meilleures pratiques, consultez : https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes	integer (int32) minimum: 0 maximum: 30	Durée d’imprégnation d’un nœud. Durée (en minutes) d’attente après le drainage d’un nœud et avant de la réimager et passer au nœud suivant. S’il n’est pas spécifié, la valeur par défaut est de 0 minutes.
undrainableNodeBehavior	UndrainableNodeBehavior	Définit le comportement des nœuds indrainables pendant la mise à niveau. La cause la plus courante des nœuds indrainables est les budgets d’interruption de pod (PDB), mais d’autres problèmes, tels que la période de grâce de terminaison de pod, dépassent le délai d’expiration du drainage par nœud restant ou le pod est toujours dans un état d’exécution, peut également entraîner des nœuds indrainables.

AgentPoolWindowsProfile

Object

Profil spécifique du pool d’agents Windows.

Nom	Type	Description
disableOutboundNat	boolean	Indique s’il faut désactiver OutboundNAT dans les nœuds Windows. La valeur par défaut est false. La nat sortante ne peut être désactivée que si le type de trafic sortant du cluster est une passerelle NAT et que le pool d’agents Windows n’a pas d’adresse IP publique de nœud activée.

CloudError

Object

Réponse d’erreur du service Conteneur.

Nom	Type	Description
error	CloudErrorBody	Détails sur l’erreur.

CloudErrorBody

Object

Réponse d’erreur du service Conteneur.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

code

Énumération

Indique si le cluster est en cours d’exécution ou arrêté

Valeur	Description
Running	Le cluster est en cours d’exécution.
Stopped	Le cluster est arrêté.

CreationData

Object

Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.

Nom	Type	Description
sourceResourceId	string (arm-id)	Il s’agit de l’ID ARM de l’objet source à utiliser pour créer l’objet cible.

GPUDriver

Énumération

Indique s’il faut installer des pilotes GPU. Quand elle n’est pas spécifiée, la valeur par défaut est Install.

Valeur	Description
Install	Installez le pilote.
None	Ignorez l’installation du pilote.

GPUInstanceProfile

Énumération

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

Valeur	Description
MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

GPUProfile

Object

Paramètres GPU pour le pool d’agents.

Nom	Type	Description
driver	GPUDriver	Indique s’il faut installer des pilotes GPU. Quand elle n’est pas spécifiée, la valeur par défaut est Install.

IPTag

Object

Contient l’IPTag associé à l’objet.

Nom	Type	Description
ipTagType	string	Type d’étiquette IP. Exemple : RoutingPreference.
tag	string	Valeur de la balise IP associée à l’adresse IP publique. Exemple : Internet.

KubeletConfig

Object

Configurations Kubelet des nœuds d’agent. Pour plus d’informations, consultez de configuration de nœud personnalisée AKS.

Nom	Type	Description
allowedUnsafeSysctls	string[]	Liste autorisée de sysctls non sécurisés ou de modèles sysctl non sécurisés (se terminant par *).
containerLogMaxFiles	integer (int32) minimum: 2	Nombre maximal de fichiers journaux de conteneur pouvant être présents pour un conteneur. Le nombre doit être ≥ 2.
containerLogMaxSizeMB	integer (int32)	Taille maximale (par exemple, 10Mi) du fichier journal conteneur avant sa rotation.
cpuCfsQuota	boolean	Si l’application du quota CFS du processeur est activée pour les conteneurs qui spécifient des limites d’UC. La valeur par défaut est true.
cpuCfsQuotaPeriod	string	Valeur de la période de quota CFS du processeur. La valeur par défaut est « 100ms ». Les valeurs valides sont une séquence de nombres décimaux avec une fraction facultative et un suffixe d’unité. Par exemple : « 300ms », « 2h45m ». Les unités prises en charge sont « ns », « us », « ms », « s », « m » et « h ».
cpuManagerPolicy	string	Stratégie du Gestionnaire d’UC à utiliser. La valeur par défaut est « none ». Pour plus d’informations, consultez les stratégies de gestion du processeur Kubernetes . Les valeurs autorisées sont « none » et « static ».
failSwapOn	boolean	Si la valeur est true, kubelet ne démarre pas si l’échange est activé sur le nœud.
imageGcHighThreshold	integer (int32)	Pourcentage d’utilisation du disque après laquelle le garbage collection d’images est toujours exécuté. Pour désactiver le garbage collection d’images, définissez sur 100. La valeur par défaut est 85%
imageGcLowThreshold	integer (int32)	Pourcentage d’utilisation du disque avant laquelle le garbage collection d’images n’est jamais exécuté. Cela ne peut pas être défini plus haut que imageGcHighThreshold. La valeur par défaut est 80%
podMaxPids	integer (int32)	Nombre maximal de processus par pod.
topologyManagerPolicy	string	Stratégie du Gestionnaire de topologie à utiliser. Pour plus d’informations, consultez le Gestionnaire de topologie Kubernetes. La valeur par défaut est « none ». Les valeurs autorisées sont « none », « best-effort », « restricted » et « single-numa-node ».

KubeletDiskType

Énumération

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

Valeur	Description
OS	Kubelet utilisera le disque du système d’exploitation pour ses données.
Temporary	Kubelet utilisera le disque temporaire pour ses données.

LinuxOSConfig

Object

Configurations du système d’exploitation des nœuds d’agent Linux. Pour plus d’informations, consultez de configuration de nœud personnalisée AKS.

Nom	Type	Description
swapFileSizeMB	integer (int32)	Taille en Mo d’un fichier d’échange qui sera créé sur chaque nœud.
sysctls	SysctlConfig	Paramètres Sysctl pour les nœuds d’agent Linux.
transparentHugePageDefrag	string	Indique si le noyau doit utiliser agressivement le compactage de la mémoire pour rendre plus énormes pages disponibles. Les valeurs valides sont « always », « defer », « defer+madvise », « madvise » et « never ». La valeur par défaut est « madvise ». Pour plus d’informations, consultez Transparent Hugepages.
transparentHugePageEnabled	string	Indique si les énormes pages transparentes sont activées. Les valeurs valides sont « always », « madvise » et « never ». La valeur par défaut est « always ». Pour plus d’informations, consultez Transparent Hugepages.

ManualScaleProfile

Object

Spécifications sur le nombre de machines.

Nom	Type	Description
count	integer (int32)	Nombre de nœuds.
size	string	Taille de machine virtuelle utilisée par AKS lors de la création et de la mise à l’échelle, par exemple , « Standard_E4s_v3 », « Standard_E16s_v3 » ou « Standard_D16s_v5 ».

OSDiskType

Énumération

Type de disque du système d’exploitation à utiliser pour les machines du pool d’agents. 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 le système d’exploitation éphémère.

Valeur	Description
Ephemeral	Les disques de système d’exploitation éphémères sont stockés uniquement sur la machine hôte, comme un disque temporaire. Cela fournit une latence de lecture/écriture inférieure, ainsi que des mises à niveau de nœud et de cluster plus rapides.
Managed	Azure réplique le disque du système d’exploitation d’une machine virtuelle vers le stockage Azure pour éviter toute perte de données si la machine virtuelle doit être déplacée vers un autre hôte. Étant donné que les conteneurs ne sont pas conçus pour conserver l’état local, ce comportement offre une valeur limitée tout en fournissant certains inconvénients, notamment l’approvisionnement de nœuds lent et une latence de lecture/écriture plus élevée.

OSSKU

Énumération

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.

Valeur	Description
AzureLinux	Utilisez AzureLinux comme système d’exploitation pour les images de nœud. Azure Linux est une distribution Linux optimisée par conteneur créée par Microsoft, visitez https://aka.ms/azurelinux pour plus d’informations.
CBLMariner	Référence OSSKU déconseillée. Microsoft recommande que les nouveaux déploiements choisissent « AzureLinux » à la place.
Ubuntu	Utilisez Ubuntu comme système d’exploitation pour les images de nœud.
Ubuntu2204	Utilisez Ubuntu2204 comme système d’exploitation pour les images de nœuds, cependant, Ubuntu 22.04 peut ne pas être pris en charge pour tous les pools de nœuds. Pour connaître les limitations et les versions de Kubernetes prises en charge, consultez https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Utilisez Windows2019 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2019 prend uniquement en charge les conteneurs Windows2019 ; il ne peut pas exécuter les conteneurs Windows2022 et vice versa.
Windows2022	Utilisez Windows2022 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2022 prend uniquement en charge les conteneurs Windows2022 ; il ne peut pas exécuter les conteneurs Windows2019 et vice versa.

OSType

Énumération

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

Valeur	Description
Linux	Utilisez Linux.
Windows	Utilisez Windows.

PodIPAllocationMode

Énumération

Mode d’allocation IP du pod. Mode d’allocation IP pour les pods dans le pool d’agents. Doit être utilisé avec podSubnetId. La valeur par défaut est « DynamicIndividual ».

Valeur	Description
DynamicIndividual	Chaque nœud est alloué avec une liste non contiguë d’adresses IP pouvant être attribuées à des pods. Il est préférable d’optimiser un sous-réseau petit à moyen de taille /16 ou plus petite. Le cluster Azure CNI avec allocation IP dynamique est défini par défaut sur ce mode si le client ne spécifie pas explicitement un podIPAllocationMode
StaticBlock	Chaque nœud est alloué statiquement aux blocs CIDR de taille /28 = 16 adresses IP par bloc pour satisfaire les maxPods par nœud. Nombre de blocs CIDR >= (maxPods / 16). Le bloc, plutôt qu’une seule adresse IP, compte sur la limite d’adresses IP privées du réseau virtuel Azure de 65 Ko. Par conséquent, le mode bloc convient à l’exécution de charges de travail plus volumineuses avec plus que la limite actuelle de pods de 65 Ko dans un cluster. Ce mode est mieux adapté à la mise à l’échelle avec des sous-réseaux plus volumineux de /15 ou plus

PortRange

Object

Plage de ports.

Nom	Type	Description
portEnd	integer (int32) minimum: 1 maximum: 65535	Port maximal inclus dans la plage. Elle doit être comprise entre 1 et 65535, et être supérieure ou égale à portStart.
portStart	integer (int32) minimum: 1 maximum: 65535	Port minimal inclus dans la plage. Elle doit être comprise entre 1 et 65535, et être inférieure ou égale à portEnd.
protocol	Protocol	Protocole réseau du port.

PowerState

Object

Décrit l’état de l’alimentation du cluster

Nom	Type	Description
code	code	Indique si le cluster est en cours d’exécution ou arrêté

Protocol

Énumération

Protocole réseau du port.

Valeur	Description
TCP	Protocole TCP.
UDP	Protocole UDP.

ScaleDownMode

Énumération

Décrit comment les machines virtuelles sont ajoutées ou supprimées des pools d’agents. Consultez les états de facturation.

Valeur	Description
Deallocate	Essayez de démarrer des instances libérées (le cas échéant) pendant le scale-up et la libération des instances lors d’un scale-down.
Delete	Créez de nouvelles instances pendant le scale-up et supprimez des instances lors d’un scale-down.

ScaleProfile

Object

Spécifications sur la façon de mettre à l’échelle un pool d’agents VirtualMachines.

Nom	Type	Description
manual	ManualScaleProfile[]	Spécifications sur la façon de mettre à l’échelle le pool d’agents VirtualMachines à une taille fixe.

ScaleSetEvictionPolicy

Énumération

Stratégie d’éviction du groupe de machines virtuelles identiques. La stratégie d’éviction spécifie ce qu’il faut faire de la machine virtuelle lorsqu’elle est expulsée. La valeur par défaut est Supprimer. Pour plus d’informations sur l’éviction, consultez VM spot

Valeur	Description
Deallocate	Les nœuds du groupe identique sous-jacent du pool de nœuds sont définis sur l’état arrêté-désalloué lors de l’éviction. Les nœuds dans le nombre d’états désalloués arrêtés par rapport à votre quota de calcul peuvent entraîner des problèmes de mise à l’échelle ou de mise à niveau de cluster.
Delete	Les nœuds du groupe identique sous-jacent du pool de nœuds sont supprimés lorsqu’ils sont supprimés.

ScaleSetPriority

Énumération

Priorité du groupe de machines virtuelles identiques.

Valeur	Description
Regular	Les machines virtuelles régulières seront utilisées.
Spot	Les machines virtuelles de priorité Spot seront utilisées. Il n’existe aucun contrat SLA pour les nœuds spot. Pour plus d’informations, consultez spot sur AKS.

SysctlConfig

Object

Paramètres Sysctl pour les nœuds d’agent Linux.

Nom	Type	Description
fsAioMaxNr	integer (int32)	Paramètre Sysctl fs.aio-max-nr.
fsFileMax	integer (int32)	Paramètre Sysctl fs.file-max.
fsInotifyMaxUserWatches	integer (int32)	Paramètre Sysctl fs.inotify.max_user_watch.
fsNrOpen	integer (int32)	Paramètre Sysctl fs.nr_open.
kernelThreadsMax	integer (int32)	Sysctl définissant kernel.threads-max.
netCoreNetdevMaxBacklog	integer (int32)	Paramètre Sysctl net.core.netdev_max_backlog.
netCoreOptmemMax	integer (int32)	Paramètre Sysctl net.core.optmem_max.
netCoreRmemDefault	integer (int32)	Paramètre Sysctl net.core.rmem_default.
netCoreRmemMax	integer (int32)	Paramètre Sysctl net.core.rmem_max.
netCoreSomaxconn	integer (int32)	Sysctl définissant net.core.somaxconn.
netCoreWmemDefault	integer (int32)	Paramètre Sysctl net.core.wmem_default.
netCoreWmemMax	integer (int32)	Paramètre Sysctl net.core.wmem_max.
netIpv4IpLocalPortRange	string	Paramètre Sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1	integer (int32)	Paramètre Sysctl net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2	integer (int32)	Paramètre Sysctl net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3	integer (int32)	Paramètre Sysctl net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout	integer (int32)	Paramètre Sysctl net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes	integer (int32)	Paramètre Sysctl net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime	integer (int32)	Paramètre Sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog	integer (int32)	Paramètre Sysctl net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets	integer (int32)	Paramètre Sysctl net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse	boolean	Paramètre Sysctl net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl	integer (int32) minimum: 10 maximum: 90	Paramètre Sysctl net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets	integer (int32) minimum: 65536 maximum: 524288	Paramètre Sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax	integer (int32) minimum: 131072 maximum: 2097152	Paramètre Sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount	integer (int32)	Paramètre Sysctl vm.max_map_count.
vmSwappiness	integer (int32)	Sysctl définissant vm.swappiness.
vmVfsCachePressure	integer (int32)	Paramètre Sysctl vm.vfs_cache_pressure.

UndrainableNodeBehavior

Énumération

Définit le comportement des nœuds indrainables pendant la mise à niveau. La cause la plus courante des nœuds indrainables est les budgets d’interruption de pod (PDB), mais d’autres problèmes, tels que la période de grâce de terminaison de pod, dépassent le délai d’expiration du drainage par nœud restant ou le pod est toujours dans un état d’exécution, peut également entraîner des nœuds indrainables.

Valeur	Description
Cordon	AKS cordonne les nœuds bloqués et les remplace par des nœuds de surtension pendant la mise à niveau. Les nœuds bloqués sont cordonnés et remplacés par des nœuds de surtension. Les nœuds bloqués auront l’étiquette « kubernetes.azure.com/upgrade-status:Quarantined ». Un nœud de surtension sera conservé pour chaque nœud bloqué. Une tentative optimale sera effectuée pour supprimer tous les autres nœuds de surtension. S’il existe suffisamment de nœuds d’augmentation pour remplacer les nœuds bloqués, l’opération de mise à niveau et le cluster managé sont en état d’échec. Sinon, l’opération de mise à niveau et le cluster managé sont à l’état annulé.
Schedule	AKS marque les nœuds bloqués schedulables, mais les nœuds bloqués ne sont pas mis à niveau. Une tentative optimale sera effectuée pour supprimer tous les nœuds de surtension. L’opération de mise à niveau et le cluster managé sont en état d’échec s’il existe des nœuds bloqués.

VirtualMachineNodes

Object

État actuel sur un groupe de nœuds de la même taille de machine virtuelle.

Nom	Type	Description
count	integer (int32)	Nombre de nœuds.
size	string	Taille de machine virtuelle des agents utilisés pour héberger ce groupe de nœuds.

VirtualMachinesProfile

Object

Spécifications sur le pool d’agents VirtualMachines.

Nom	Type	Description
scale	ScaleProfile	Spécifications sur la façon de mettre à l’échelle un pool d’agents VirtualMachines.

WorkloadRuntime

Énumération

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

Valeur	Description
OCIContainer	Les nœuds utilisent Kubelet pour exécuter des charges de travail de conteneur OCI standard.
WasmWasi	Les nœuds utilisent Krustlet pour exécuter des charges de travail WASM à l’aide du fournisseur WASI (préversion).