Agent Pools - Get

Referencia

Servicio:: AKS

Versión de la API:: 2024-09-01

Obtiene el grupo de agentes de clúster administrado especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
agentPoolName	path	True	string	Nombre del grupo de agentes. Patrón de Regex: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
resourceName	path	True	string	Nombre del recurso de clúster administrado. Patrón de Regex: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	AgentPool	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get Agent Pool

Solicitud de ejemplo

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


/**
 * Samples for AgentPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/
     * AgentPoolsGet.json
     */
    /**
     * Sample code: Get Agent Pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAgentPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getAgentPools().getWithResponse("rg1", "clustername1",
            "agentpool1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python agent_pools_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.agent_pools.get(
        resource_group_name="rg1",
        resource_name="clustername1",
        agent_pool_name="agentpool1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
func ExampleAgentPoolsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAgentPoolsClient().Get(ctx, "rg1", "clustername1", "agentpool1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AgentPool = armcontainerservice.AgentPool{
	// 	Name: to.Ptr("agentpool1"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1"),
	// 	Properties: &armcontainerservice.ManagedClusterAgentPoolProfileProperties{
	// 		Count: to.Ptr[int32](3),
	// 		CurrentOrchestratorVersion: to.Ptr("1.9.6"),
	// 		ETag: to.Ptr("ebwiyfneowv"),
	// 		MaxPods: to.Ptr[int32](110),
	// 		NodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
	// 		OrchestratorVersion: to.Ptr("1.9.6"),
	// 		OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		UpgradeSettings: &armcontainerservice.AgentPoolUpgradeSettings{
	// 			MaxSurge: to.Ptr("33%"),
	// 		},
	// 		VMSize: to.Ptr("Standard_DS1_v2"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified managed cluster agent pool.
 *
 * @summary Gets the specified managed cluster agent pool.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
 */
async function getAgentPool() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const agentPoolName = "agentpool1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.agentPools.get(resourceGroupName, resourceName, agentPoolName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 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%"
    }
  }
}

Definiciones

Nombre	Description
AgentPool	Grupo de agentes.
AgentPoolMode	Modo de un grupo de agentes.
AgentPoolNetworkProfile	Configuración de red de un grupo de agentes.
AgentPoolSecurityProfile	Configuración de seguridad de un grupo de agentes.
AgentPoolType	Tipo de grupo de agentes.
AgentPoolUpgradeSettings	Configuración para actualizar un grupo de agentes
AgentPoolWindowsProfile	Perfil específico del grupo de agentes de Windows.
CloudError	Respuesta de error del servicio contenedor.
CloudErrorBody	Respuesta de error del servicio contenedor.
code	Indica si el clúster está en ejecución o detenido.
CreationData	Datos usados al crear un recurso de destino a partir de un recurso de origen.
GPUInstanceProfile	GPUInstanceProfile que se usará para especificar el perfil de instancia de MIG de GPU para la SKU de máquina virtual de GPU compatible.
IPTag	Contiene el IPTag asociado al objeto .
KubeletConfig	Configuraciones de Kubelet de nodos de agente.
KubeletDiskType	Determina la ubicación de volúmenes emptyDir, raíz de datos del entorno de ejecución del contenedor y almacenamiento efímero de Kubelet.
LinuxOSConfig	Configuraciones del sistema operativo de los nodos del agente de Linux.
OSDiskType	Tipo de disco del sistema operativo que se va a usar para las máquinas del grupo de agentes.
OSSKU	Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.
OSType	Tipo de sistema operativo. El valor predeterminado es Linux.
PortRange	Intervalo de puertos.
PowerState	Describe el estado de energía del clúster.
Protocol	Protocolo de red del puerto.
ScaleDownMode	Describe cómo se agregan o quitan las máquinas virtuales de los grupos de agentes. Consulte estados de facturación.
ScaleSetEvictionPolicy	Directiva de expulsión del conjunto de escalado de máquinas virtuales.
ScaleSetPriority	Prioridad del conjunto de escalado de máquinas virtuales.
SysctlConfig	Configuración de Sysctl para los nodos del agente de Linux.
WorkloadRuntime	Determina el tipo de carga de trabajo que puede ejecutar un nodo.

AgentPool

Grupo de agentes.

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

AgentPoolMode

Modo de un grupo de agentes.

Nombre	Tipo	Description
System	string	Los grupos de agentes del sistema son principalmente para hospedar pods críticos del sistema, como CoreDNS y metrics-server. Los grupos de agentes del sistema osType deben ser Linux. La SKU de máquina virtual de grupos de agentes del sistema debe tener al menos 2vCPU y 4 GB de memoria.
User	string	Los grupos de agentes de usuario son principalmente para hospedar los pods de la aplicación.

AgentPoolNetworkProfile

Configuración de red de un grupo de agentes.

Nombre	Tipo	Description
allowedHostPorts	PortRange[]	Intervalos de puertos a los que se puede acceder. Los intervalos especificados pueden superponerse.
applicationSecurityGroups	string[]	Identificadores de los grupos de seguridad de aplicaciones que asociará el grupo de agentes cuando se cree.
nodePublicIPTags	IPTag[]	IPTags de direcciones IP públicas de nivel de instancia.

AgentPoolSecurityProfile

Configuración de seguridad de un grupo de agentes.

Nombre	Tipo	Description
enableSecureBoot	boolean	El arranque seguro es una característica de inicio seguro que garantiza que solo los sistemas operativos y controladores firmados puedan arrancar. Para obtener más información, consulte aka.ms/aks/trustedlaunch. Si no se especifica, el valor predeterminado es false.
enableVTPM	boolean	vTPM es una característica de inicio seguro para configurar un almacén seguro dedicado para claves y medidas que se mantienen localmente en el nodo. Para obtener más información, consulte aka.ms/aks/trustedlaunch. Si no se especifica, el valor predeterminado es false.

AgentPoolType

Tipo de grupo de agentes.

Nombre	Tipo	Description
AvailabilitySet	string	Se recomienda encarecidamente usar esto.
VirtualMachineScaleSets	string	Cree un grupo de agentes respaldado por un conjunto de escalado de máquinas virtuales.

AgentPoolUpgradeSettings

Configuración para actualizar un grupo de agentes

Nombre	Tipo	Description
drainTimeoutInMinutes	integer	Tiempo de espera de purga de un nodo Cantidad de tiempo (en minutos) que se espera a la expulsión de pods y terminación correcta por nodo. Este tiempo de espera de expulsión respeta la espera de los presupuestos de interrupciones del pod. Si se supera este tiempo, se produce un error en la actualización. Si no se especifica, el valor predeterminado es de 30 minutos.
maxSurge	string	Número máximo o porcentaje de nodos que se sobrecargan durante la actualización. Esto puede establecerse en un entero (por ejemplo, "5") o en un porcentaje (por ejemplo, "50%"). Si se especifica un porcentaje, es el porcentaje del tamaño total del grupo de agentes en el momento de la actualización. En porcentajes, los nodos fraccionarios se redondean hacia arriba. Si no se especifica, el valor predeterminado es 1. Para obtener más información, incluidos los procedimientos recomendados, consulte: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes	integer	Duración del empate de un nodo Cantidad de tiempo (en minutos) que se debe esperar después de purgar un nodo y antes de volver a importarlo y pasar al siguiente nodo. Si no se especifica, el valor predeterminado es 0 minutos.

AgentPoolWindowsProfile

Perfil específico del grupo de agentes de Windows.

Nombre	Tipo	Description
disableOutboundNat	boolean	Si se deshabilita OutboundNAT en los nodos de Windows El valor predeterminado es false. NAT de salida solo se puede deshabilitar si el clúster outboundType es NAT Gateway y el grupo de agentes de Windows no tiene habilitada la dirección IP pública del nodo.

CloudError

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
error	CloudErrorBody	Detalles sobre el error.

CloudErrorBody

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

code

Indica si el clúster está en ejecución o detenido.

Nombre	Tipo	Description
Running	string	El clúster se está ejecutando.
Stopped	string	El clúster se detiene.

CreationData

Datos usados al crear un recurso de destino a partir de un recurso de origen.

Nombre	Tipo	Description
sourceResourceId	string	Este es el identificador de ARM del objeto de origen que se va a usar para crear el objeto de destino.

GPUInstanceProfile

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

Nombre	Tipo	Description
MIG1g	string
MIG2g	string
MIG3g	string
MIG4g	string
MIG7g	string

IPTag

Contiene el IPTag asociado al objeto .

Nombre	Tipo	Description
ipTagType	string	Tipo de etiqueta IP. Ejemplo: RoutingPreference.
tag	string	Valor de la etiqueta IP asociada a la dirección IP pública. Ejemplo: Internet.

KubeletConfig

Configuraciones de Kubelet de nodos de agente.

Nombre	Tipo	Description
allowedUnsafeSysctls	string[]	Lista permitida de sysctls no seguros o patrones sysctl no seguros (que terminan en `*`).
containerLogMaxFiles	integer	Número máximo de archivos de registro de contenedor que pueden estar presentes para un contenedor. El número debe ser ≥ 2.
containerLogMaxSizeMB	integer	Tamaño máximo (por ejemplo, 10Mi) del archivo de registro de contenedor antes de girarlo.
cpuCfsQuota	boolean	Si la aplicación de cuota de CFS de CPU está habilitada para contenedores que especifican límites de CPU. El valor predeterminado es true.
cpuCfsQuotaPeriod	string	Valor del período de cuota cfS de CPU. El valor predeterminado es "100ms". Los valores válidos son una secuencia de números decimales con una fracción opcional y un sufijo de unidad. Por ejemplo: "300 ms", "2h45m". Las unidades admitidas son "ns", "us", "ms", "s", "m" y "h".
cpuManagerPolicy	string	Directiva del Administrador de CPU que se va a usar. El valor predeterminado es "none". Consulte directivas de administración de CPU de Kubernetes para obtener más información. Los valores permitidos son "none" y "static".
failSwapOn	boolean	Si se establece en true, se producirá un error al iniciar Kubelet si el intercambio está habilitado en el nodo.
imageGcHighThreshold	integer	El porcentaje de uso del disco después del cual siempre se ejecuta la recolección de elementos no utilizados de imagen. Para deshabilitar la recolección de elementos no utilizados de imagen, establezca en 100. El valor predeterminado es 85%
imageGcLowThreshold	integer	El porcentaje de uso del disco antes del cual nunca se ejecuta la recolección de elementos no utilizados de imagen. Esto no se puede establecer más alto que imageGcHighThreshold. El valor predeterminado es 80%
podMaxPids	integer	Número máximo de procesos por pod.
topologyManagerPolicy	string	Directiva del Administrador de topologías que se va a usar. Para obtener más información, consulte administrador de topologías de Kubernetes. El valor predeterminado es "none". Los valores permitidos son "none", "best-effort", "restricted" y "single-numa-node".

KubeletDiskType

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

Nombre	Tipo	Description
OS	string	Kubelet usará el disco del sistema operativo para sus datos.
Temporary	string	Kubelet usará el disco temporal para sus datos.

LinuxOSConfig

Configuraciones del sistema operativo de los nodos del agente de Linux.

Nombre	Tipo	Description
swapFileSizeMB	integer	Tamaño en MB de un archivo de intercambio que se creará en cada nodo.
sysctls	SysctlConfig	Configuración de Sysctl para los nodos del agente de Linux.
transparentHugePageDefrag	string	Si el kernel debe hacer un uso agresivo de la compactación de memoria para que estén disponibles más enormes páginas. Los valores válidos son "always", "defer", "defer+madvise", "madvise" y "never". El valor predeterminado es "madvise". Para obtener más información, consulte de enormes transparentes.
transparentHugePageEnabled	string	Si están habilitadas las enormes páginas transparentes. Los valores válidos son "always", "madvise" y "never". El valor predeterminado es "always". Para obtener más información, consulte de enormes transparentes.

OSDiskType

Tipo de disco del sistema operativo que se va a usar para las máquinas del grupo de agentes.

Nombre	Tipo	Description
Ephemeral	string	Los discos del sistema operativo efímeros solo se almacenan en el equipo host, al igual que un disco temporal. Esto proporciona una menor latencia de lectura y escritura, junto con el escalado de nodos y las actualizaciones de clúster más rápidas.
Managed	string	Azure replica el disco del sistema operativo de una máquina virtual en Azure Storage para evitar la pérdida de datos si la máquina virtual debe reubicarse en otro host. Dado que los contenedores no están diseñados para conservar el estado local, este comportamiento ofrece un valor limitado al proporcionar algunos inconvenientes, incluido el aprovisionamiento de nodos más lento y una mayor latencia de lectura y escritura.

OSSKU

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

Nombre	Tipo	Description
AzureLinux	string	Use AzureLinux como sistema operativo para imágenes de nodo. Azure Linux es una distribución linux optimizada para contenedores creada por Microsoft, visite https://aka.ms/azurelinux para obtener más información.
CBLMariner	string	OSSKU en desuso. Microsoft recomienda que las nuevas implementaciones elijan "AzureLinux" en su lugar.
Ubuntu	string	Use Ubuntu como sistema operativo para imágenes de nodo.
Windows2019	string	Use Windows2019 como sistema operativo para imágenes de nodo. No se admite para los grupos de nodos del sistema. Windows2019 solo admite contenedores de Windows2019; no puede ejecutar contenedores de Windows2022 y viceversa.
Windows2022	string	Use Windows2022 como sistema operativo para imágenes de nodo. No se admite para los grupos de nodos del sistema. Windows2022 solo admite contenedores de Windows2022; no puede ejecutar contenedores de Windows2019 y viceversa.

OSType

Tipo de sistema operativo. El valor predeterminado es Linux.

Nombre	Tipo	Description
Linux	string	Use Linux.
Windows	string	Use Windows.

PortRange

Intervalo de puertos.

Nombre	Tipo	Description
portEnd	integer	Puerto máximo que se incluye en el intervalo. Debe oscilar entre 1 y 65535 y debe ser mayor o igual que portStart.
portStart	integer	Puerto mínimo que se incluye en el intervalo. Debe oscilar entre 1 y 65535 y debe ser menor o igual que portEnd.
protocol	Protocol	Protocolo de red del puerto.

PowerState

Describe el estado de energía del clúster.

Nombre	Tipo	Description
code	code	Indica si el clúster está en ejecución o detenido.

Protocol

Protocolo de red del puerto.

Nombre	Tipo	Description
TCP	string	Protocolo TCP.
UDP	string	Protocolo UDP.

ScaleDownMode

Describe cómo se agregan o quitan las máquinas virtuales de los grupos de agentes. Consulte estados de facturación.

Nombre	Tipo	Description
Deallocate	string	Intente iniciar instancias desasignadas (si existen) durante el escalado vertical y desasignar instancias durante la reducción vertical.
Delete	string	Cree nuevas instancias durante el escalado vertical y quite instancias durante la reducción vertical.

ScaleSetEvictionPolicy

Directiva de expulsión del conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
Deallocate	string	Los nodos del conjunto de escalado subyacente del grupo de nodos se establecen en el estado detenido-desasignado tras la expulsión. Los nodos del recuento de estados detenidos y desasignados en la cuota de proceso pueden causar problemas con el escalado o la actualización del clúster.
Delete	string	Los nodos del conjunto de escalado subyacente del grupo de nodos se eliminan cuando se expulsan.

ScaleSetPriority

Prioridad del conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
Regular	string	Se usarán máquinas virtuales normales.
Spot	string	Se usarán máquinas virtuales de prioridad de acceso puntual. No hay ningún Acuerdo de Nivel de Servicio para los nodos de acceso puntual. Consulte spot en AKS para obtener más información.

SysctlConfig

Configuración de Sysctl para los nodos del agente de Linux.

Nombre	Tipo	Description
fsAioMaxNr	integer	Configuración de Sysctl fs.aio-max-nr.
fsFileMax	integer	Configuración de Sysctl fs.file-max.
fsInotifyMaxUserWatches	integer	Configuración de Sysctl fs.inotify.max_user_watches.
fsNrOpen	integer	Configuración de Sysctl fs.nr_open.
kernelThreadsMax	integer	Configuración de Sysctl kernel.threads-max.
netCoreNetdevMaxBacklog	integer	Configuración de Sysctl net.core.netdev_max_backlog.
netCoreOptmemMax	integer	Configuración de Sysctl net.core.optmem_max.
netCoreRmemDefault	integer	Configuración de Sysctl net.core.rmem_default.
netCoreRmemMax	integer	Configuración de Sysctl net.core.rmem_max.
netCoreSomaxconn	integer	Configuración de Sysctl net.core.somaxconn.
netCoreWmemDefault	integer	Configuración de Sysctl net.core.wmem_default.
netCoreWmemMax	integer	Configuración de Sysctl net.core.wmem_max.
netIpv4IpLocalPortRange	string	Configuración de Sysctl net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1	integer	Configuración de Sysctl net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2	integer	Configuración de Sysctl net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3	integer	Configuración de Sysctl net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout	integer	Configuración de Sysctl net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes	integer	Configuración de Sysctl net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime	integer	Configuración de Sysctl net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog	integer	Configuración de Sysctl net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets	integer	Configuración de Sysctl net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse	boolean	Configuración de Sysctl net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl	integer	Configuración de Sysctl net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets	integer	Configuración de Sysctl net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax	integer	Configuración de Sysctl net.netfilter.nf_conntrack_max.
vmMaxMapCount	integer	Configuración de Sysctl vm.max_map_count.
vmSwappiness	integer	Configuración de Sysctl vm.swappiness.
vmVfsCachePressure	integer	Configuración de Sysctl vm.vfs_cache_pressure.

WorkloadRuntime

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

Nombre	Tipo	Description
OCIContainer	string	Los nodos usarán Kubelet para ejecutar cargas de trabajo de contenedor OCI estándar.
WasmWasi	string	Los nodos usarán Krustlet para ejecutar cargas de trabajo WASM mediante el proveedor WASI (versión preliminar).

Compartir a través de

Agent Pools - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get Agent Pool

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AgentPool

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUInstanceProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

OSDiskType

OSSKU

OSType

PortRange

PowerState

Protocol

ScaleDownMode

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

WorkloadRuntime

Recursos adicionales