Agent Pools - Get

Dienst:: AKS

API-Version:: 2025-10-01

Ruft den angegebenen verwalteten Cluster-Agent-Pool ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	Der Name des Agentpools.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
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]$	Der Name der verwalteten Clusterressource.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AgentPool	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get Agent Pool

Beispielanforderung

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

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/2025-10-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/v8"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9cc7633f842575274f715cc02e37c5769ac2742d/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-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");
require("dotenv/config");

/**
 * 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/2025-10-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ContainerService.Models;
using Azure.ResourceManager.ContainerService;

// Generated from example definition: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/examples/AgentPoolsGet.json
// this example is just showing the usage of "AgentPools_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerServiceAgentPoolResource created on azure
// for more information of creating ContainerServiceAgentPoolResource, please refer to the document of ContainerServiceAgentPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string resourceName = "clustername1";
string agentPoolName = "agentpool1";
ResourceIdentifier containerServiceAgentPoolResourceId = ContainerServiceAgentPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName, agentPoolName);
ContainerServiceAgentPoolResource containerServiceAgentPool = client.GetContainerServiceAgentPoolResource(containerServiceAgentPoolResourceId);

// invoke the operation
ContainerServiceAgentPoolResource result = await containerServiceAgentPool.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ContainerServiceAgentPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AgentPool	Agent-Pool.
AgentPoolGatewayProfile	Profil des verwalteten Clustergateway-Agentpools.
AgentPoolMode	Der Modus eines Agentpools. Ein Cluster muss immer über mindestens einen 'System'-Agentpool verfügen. Weitere Informationen zu Agentpooleinschränkungen und bewährten Methoden finden Sie unter: https://docs.microsoft.com/azure/aks/use-system-pools
AgentPoolNetworkProfile	Netzwerkeinstellungen eines Agentpools.
AgentPoolSecurityProfile	Die Sicherheitseinstellungen eines Agentpools.
AgentPoolSSHAccess	SSH-Zugriffsmethode eines Agentpools.
AgentPoolStatus	Enthält schreibgeschützte Informationen zum Agentpool.
AgentPoolType	Der Typ des Agentpools.
AgentPoolUpgradeSettings	Einstellungen für das Upgrade eines Agentpools
AgentPoolWindowsProfile	Das spezifische Profil des Windows-Agentpools.
code	Gibt an, ob der Cluster ausgeführt oder beendet wird.
CreationData	Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GPUDriver	Gibt an, ob GPU-Treiber installiert werden sollen. Wenn sie nicht angegeben ist, ist die Standardeinstellung "Installieren".
GPUInstanceProfile	GPUInstanceProfile, das zum Angeben des GPU-MIG-Instanzprofils für unterstützte GPU-VM-SKU verwendet werden soll.
GPUProfile	GPU-Einstellungen für den Agentpool.
IPTag	Enthält das dem Objekt zugeordnete IPTag.
KubeletConfig	Kubelet-Konfigurationen von Agentknoten. Weitere Informationen finden Sie unter konfiguration der benutzerdefinierten AKS-Knotenkonfiguration.
KubeletDiskType	Bestimmt die Platzierung von emptyDir-Volumes, Containerlaufzeitdatenstamm und Kubelet-Kurzspeicher.
LinuxOSConfig	Betriebssystemkonfigurationen von Linux-Agentknoten. Weitere Informationen finden Sie unter konfiguration der benutzerdefinierten AKS-Knotenkonfiguration.
LocalDNSForwardDestination	Zielserver für DNS-Abfragen, die von localDNS weitergeleitet werden sollen.
LocalDNSForwardPolicy	Forward-Richtlinie für die Auswahl des Upstream-DNS-Servers. Weitere Informationen finden Sie unter Forward-Plugin .
LocalDNSMode	Aktivierungsmodus für localDNS.
LocalDNSOverride	Außerkraftsetzungen für localDNS-Profil.
LocalDNSProfile	Konfiguriert das lokale DNS pro Knoten mit VnetDNS- und KubeDNS-Außerkraftsetzungen. LocalDNS trägt dazu bei, die Leistung und Zuverlässigkeit der DNS-Auflösung in einem AKS-Cluster zu verbessern. Weitere Informationen finden Sie unter aka.ms/aks/localdns.
LocalDNSProtocol	Erzwingen Sie TCP oder bevorzugen Sie das UDP-Protokoll für Verbindungen von localDNS zum Upstream-DNS-Server.
LocalDNSQueryLogging	Protokollebene für DNS-Abfragen in localDNS.
LocalDNSServeStale	Richtlinie für die Bereitstellung veralteter Daten. Weitere Informationen finden Sie unter Cache-Plugin .
LocalDNSState	Vom System generierter Zustand von localDNS.
ManualScaleProfile	Spezifikationen für die Anzahl der Maschinen.
OSDiskType	Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll. Der Standardwert ist "Ephemeral", wenn die VM sie unterstützt und über einen Cachedatenträger verfügt, der größer als die angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" verwendet. Kann nach der Erstellung nicht mehr geändert werden. Weitere Informationen finden Sie unter Ephemeral OS.
OSSKU	Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.
OSType	Der Betriebssystemtyp. Der Standardwert ist Linux.
PodIPAllocationMode	Pod-IP-Zuordnungsmodus. Der IP-Zuordnungsmodus für Pods im Agentpool. Muss mit podSubnetId verwendet werden. Der Standardwert ist "DynamicIndividual".
PortRange	Der Portbereich.
PowerState	Beschreibt den Power State des Clusters.
Protocol	Das Netzwerkprotokoll des Ports.
ScaleDownMode	Beschreibt, wie VMs zu Agentpools hinzugefügt oder daraus entfernt werden. Weitere Informationen finden Sie unter Abrechnungsstatus.
ScaleProfile	Spezifikationen zum Skalieren eines VirtualMachines-Agentpools.
ScaleSetEvictionPolicy	Die Richtlinie zum Entfernen von VM-Skalierungsgruppen. Die Entfernungsrichtlinie gibt an, was mit der VM geschehen soll, wenn sie entfernt wird. Der Standardwert ist Löschen. Weitere Informationen zur Entfernung finden Sie unter Spot-VMs.
ScaleSetPriority	Priorität des Skalierungssatzes für virtuelle Computer.
SysctlConfig	Sysctl-Einstellungen für Linux-Agentknoten.
UndrainableNodeBehavior	Definiert das Verhalten für nicht feststellbare Knoten während des Upgrades. Die häufigste Ursache für uneinnehmbare Knoten ist Pod Disruption Budgets (PDBs), aber andere Probleme, z. B. pod-Beendigungsfrist, überschreiten das verbleibende Zeitlimit pro Knoten entwässern, oder pod befindet sich weiterhin in einem laufenden Zustand, kann auch zu uneinschränkbaren Knoten führen.
VirtualMachineNodes	Aktueller Status für eine Gruppe von Knoten derselben VM-Größe.
VirtualMachinesProfile	Spezifikationen für den VirtualMachines-Agentpool.
WorkloadRuntime	Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

AgentPool

Objekt

Agent-Pool.

Name	Typ	Standardwert	Beschreibung
id	string		Ressourcen-ID.
name	string		Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.availabilityZones	string[]		Die Liste der Verfügbarkeitszonen, die für Knoten verwendet werden sollen. Dies kann nur angegeben werden, wenn die AgentPoolType-Eigenschaft "VirtualMachineScaleSets" lautet.
properties.capacityReservationGroupID	string (arm-id)		AKS ordnet den angegebenen Agentpool der Kapazitätsreservierungsgruppe zu.
properties.count	integer (int32)		Anzahl der Agents (VMs) zum Hosten von Docker-Containern. Zulässige Werte müssen sich im Bereich von 0 bis 1000 (einschließlich) für Benutzerpools und im Bereich von 1 bis 1000 (einschließlich) für Systempools befinden. Der Standardwert ist 1.
properties.creationData	CreationData		CreationData zur Angabe der Quellmomentaufnahme-ID, wenn der Knotenpool mithilfe einer Momentaufnahme erstellt/aktualisiert wird.
properties.currentOrchestratorVersion	string		Die Version von Kubernetes, der Agent-Pool ausgeführt wird. Wenn OrchestratorVersion eine vollständig angegebene Version <major.minor.patch>ist, ist dieses Feld genau gleich. Wenn OrchestratorVersion <major.minor>ist, enthält dieses Feld den vollständigen <major.minor.patch> verwendete Version.
properties.eTag	string		Eindeutige schreibgeschützte Zeichenfolge, die verwendet wird, um optimistische Parallelität zu implementieren. Der eTag-Wert ändert sich, wenn die Ressource aktualisiert wird. Geben Sie einen if-match- oder if-none-match-Header mit dem eTag-Wert für eine nachfolgende Anforderung an, um die optimistische Parallelität gemäß der normalen eTag-Konvention zu aktivieren.
properties.enableAutoScaling	boolean		Gibt an, ob automatisch skaliert werden soll
properties.enableEncryptionAtHost	boolean		Gibt an, ob hostbasierte Betriebssystem- und Datenlaufwerkverschlüsselung aktiviert werden sollen. Dies wird nur für bestimmte VM-Größen und in bestimmten Azure-Regionen unterstützt. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS	boolean		Gibt an, ob ein FIPS-fähiges Betriebssystem verwendet werden soll. Weitere Informationen finden Sie unter Hinzufügen eines FIPS-fähigen Knotenpools.
properties.enableNodePublicIP	boolean		Gibt an, ob jedem Knoten eine eigene öffentliche IP zugewiesen wird. Einige Szenarien erfordern möglicherweise Knoten in einem Knotenpool, um ihre eigenen dedizierten öffentlichen IP-Adressen zu empfangen. Ein häufiges Szenario ist für Gaming-Workloads, bei denen eine Konsole eine direkte Verbindung mit einem virtuellen Cloudcomputer herstellen muss, um Hops zu minimieren. Weitere Informationen finden Sie unter Zuweisen einer öffentlichen IP pro Knoten. Der Standardwert ist "false".
properties.enableUltraSSD	boolean		Gibt an, ob UltraSSD aktiviert werden soll
properties.gatewayProfile	AgentPoolGatewayProfile		Profil spezifisch für einen verwalteten Agentpool im Gatewaymodus. Dieses Feld kann nicht festgelegt werden, wenn der Agentpoolmodus kein Gateway ist.
properties.gpuInstanceProfile	GPUInstanceProfile		GPUInstanceProfile, das zum Angeben des GPU-MIG-Instanzprofils für unterstützte GPU-VM-SKU verwendet werden soll.
properties.gpuProfile	GPUProfile		GPU-Einstellungen für den Agentpool.
properties.hostGroupID	string (arm-id)		Die vollqualifizierte Ressourcen-ID der dedizierten Hostgruppe zum Bereitstellen virtueller Computer, die nur im Erstellungsszenario verwendet und nicht einmal geändert werden dürfen. Dies ist das Formular: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Weitere Informationen finden Sie unter dedizierten Azure-Hosts.
properties.kubeletConfig	KubeletConfig		Die Kubelet-Konfiguration auf den Agentpoolknoten.
properties.kubeletDiskType	KubeletDiskType		Bestimmt die Platzierung von emptyDir-Volumes, Containerlaufzeitdatenstamm und Kubelet-Kurzspeicher.
properties.linuxOSConfig	LinuxOSConfig		Die Betriebssystemkonfiguration von Linux-Agentknoten.
properties.localDNSProfile	LocalDNSProfile		Konfiguriert das lokale DNS pro Knoten mit VnetDNS- und KubeDNS-Außerkraftsetzungen. LocalDNS trägt dazu bei, die Leistung und Zuverlässigkeit der DNS-Auflösung in einem AKS-Cluster zu verbessern. Weitere Informationen finden Sie unter aka.ms/aks/localdns.
properties.maxCount	integer (int32)		Die maximale Anzahl von Knoten für die automatische Skalierung
properties.maxPods	integer (int32)		Die maximale Anzahl von Pods, die auf einem Knoten ausgeführt werden können.
properties.messageOfTheDay	string		Nachricht des Tages für Linux-Knoten, base64-codiert. Eine base64-codierte Zeichenfolge, die nach der Decodierung in /etc/motd geschrieben wird. Dies ermöglicht die Anpassung der Nachricht des Tages für Linux-Knoten. Es darf nicht für Windows-Knoten angegeben werden. Es muss sich um eine statische Zeichenfolge (d. h. wird unformatierte Zeichenfolge gedruckt und nicht als Skript ausgeführt).
properties.minCount	integer (int32)		Die Mindestanzahl von Knoten für die automatische Skalierung
properties.mode	AgentPoolMode		Der Modus eines Agentpools. Ein Cluster muss immer über mindestens einen 'System'-Agentpool verfügen. Weitere Informationen zu Agentpooleinschränkungen und bewährten Methoden finden Sie unter: https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile	AgentPoolNetworkProfile		Netzwerkbezogene Einstellungen eines Agentpools.
properties.nodeImageVersion	string		Die Version des Knotenimages
properties.nodeLabels	object		Die Knotenbeschriftungen, die über alle Knoten im Agentpool hinweg beibehalten werden sollen.
properties.nodePublicIPPrefixID	string (arm-id)		Die öffentliche IP-Präfix-ID, von der VM-Knoten IPs verwenden sollen. Dies ist das Formular: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints	string[]		Die zu neuen Knoten hinzugefügtenTaints während der Erstellung und Skalierung des Knotenpools. Beispiel: key=value:NoSchedule.
properties.orchestratorVersion	string		Die vom Benutzer angegebene Version von Kubernetes. Sowohl patchversion <major.minor.patch> (z. B. 1.20.13) als auch <major.minor> (z. B. 1.20) werden unterstützt. Wenn <major.minor> angegeben wird, wird automatisch die neueste unterstützte GA-Patchversion ausgewählt. Das Aktualisieren des Clusters mit demselben <major.minor> nach der Erstellung (z. B. 1.14.x -> 1.14) löst kein Upgrade aus, auch wenn eine neuere Patchversion verfügbar ist. Als bewährte Methode sollten Sie alle Knotenpools in einem AKS-Cluster auf dieselbe Kubernetes-Version aktualisieren. Die Knotenpoolversion muss dieselbe Hauptversion wie die Steuerebene aufweisen. Die Nebenversion des Knotenpools muss sich innerhalb von zwei Nebenversionen der Steuerebenenversion befinden. Die Knotenpoolversion darf nicht größer als die Steuerebenenversion sein. Weitere Informationen finden Sie unter Upgrade eines Knotenpools.
properties.osDiskSizeGB	integer (int32) minimum: 0 maximum: 2048		Betriebssystemdatenträgergröße in GB, die verwendet werden soll, um die Datenträgergröße für jeden Computer im Master-/Agent-Pool anzugeben. Wenn Sie "0" angeben, wird die Standardmäßige osDisk-Größe entsprechend der angegebenen vmSize angewendet.
properties.osDiskType	OSDiskType		Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll. Der Standardwert ist "Ephemeral", wenn die VM sie unterstützt und über einen Cachedatenträger verfügt, der größer als die angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" verwendet. Kann nach der Erstellung nicht mehr geändert werden. Weitere Informationen finden Sie unter Ephemeral OS.
properties.osSKU	OSSKU		Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.
properties.osType	OSType	Linux	Der Betriebssystemtyp. Der Standardwert ist Linux.
properties.podIPAllocationMode	PodIPAllocationMode		Pod-IP-Zuordnungsmodus. Der IP-Zuordnungsmodus für Pods im Agentpool. Muss mit podSubnetId verwendet werden. Der Standardwert ist "DynamicIndividual".
properties.podSubnetID	string (arm-id)		Die ID des Subnetzes, dem pods beim Starten beitreten. Wenn diese Angabe weggelassen wird, werden Pod-IPs im Knotensubnetz statisch zugewiesen (weitere Details finden Sie unter vnetSubnetID). Dies ist das Formular: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState	PowerState		Gibt an, ob der Agentpool ausgeführt oder beendet wird. Wenn ein Agentpool zum ersten Mal erstellt wird, wird er anfangs ausgeführt. Der Agentpool kann beendet werden, indem sie dieses Feld auf "Beendet" festlegen. Ein beendeter Agentpool stoppt alle VMs und fälligkeit keine Abrechnungsgebühren. Ein Agentpool kann nur beendet werden, wenn er ausgeführt wird und der Bereitstellungsstatus erfolgreich ist.
properties.provisioningState	string		Der aktuelle Bereitstellungs- oder Bereitstellungsstatus.
properties.proximityPlacementGroupID	string (arm-id)		Die ID für die Näherungsplatzierungsgruppe.
properties.scaleDownMode	ScaleDownMode		Der Skalierungsmodus nach unten, der beim Skalieren des Agentpools verwendet werden soll. Dies wirkt sich auch auf das Cluster-Autoskalerverhalten aus. Wenn nicht angegeben, wird standardmäßig "Löschen" verwendet.
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	Die zu verwendende Richtlinie für die Skalierungsgruppe des virtuellen Computers. Dies kann nur angegeben werden, wenn "scaleSetPriority" den Wert "Spot" hat. Wenn nicht angegeben, lautet der Standardwert "Delete".
properties.scaleSetPriority	ScaleSetPriority	Regular	Priorität des Skalierungssatzes für virtuelle Computer. Wenn nicht angegeben, lautet der Standardwert "Normal".
properties.securityProfile	AgentPoolSecurityProfile		Die Sicherheitseinstellungen eines Agentpools.
properties.spotMaxPrice	number	-1	Der Höchstpreis (in US-Dollar), den Sie für Spotinstanzen bezahlen möchten. Mögliche Werte sind ein beliebiger Dezimalwert größer als Null oder -1, der angibt, dass der Standardpreis bei Bedarf up-to wird. Mögliche Werte sind ein Dezimalwert größer als Null oder -1, der die Bereitschaft angibt, einen On-Demand-Preis zu zahlen. Weitere Informationen zu Spotpreisen finden Sie unter Spot-VMs-Preisgestaltung
properties.status	AgentPoolStatus		Enthält schreibgeschützte Informationen zum Agentpool.
properties.tags	object		Die Tags, die im Skalierungssatz des virtuellen Agentpools beibehalten werden sollen.
properties.type	AgentPoolType		Der Typ des Agentpools.
properties.upgradeSettings	AgentPoolUpgradeSettings		Einstellungen für das Upgrade des Agentpools
properties.virtualMachineNodesStatus	VirtualMachineNodes[]		Der Status von Knoten in einem VirtualMachines-Agentpool.
properties.virtualMachinesProfile	VirtualMachinesProfile		Spezifikationen für den VirtualMachines-Agentpool.
properties.vmSize	string		Die Größe der VMs des Agentpools. Die Verfügbarkeit der VM variiert je nach Region. Wenn ein Knoten unzureichende Computeressourcen (Arbeitsspeicher, CPU usw.) enthält, können Pods möglicherweise nicht ordnungsgemäß ausgeführt werden. Weitere Informationen zu eingeschränkten VM-Größen finden Sie unter: https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID	string (arm-id)		Die ID des Subnetzes, dem Agentpoolknoten und optional Pods beim Start beitreten. Wenn dies nicht angegeben ist, wird ein VNET und ein Subnetz generiert und verwendet. Wenn keine podSubnetID angegeben ist, gilt dies für Knoten und Pods, andernfalls gilt sie nur für Knoten. Dies ist das Formular: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile	AgentPoolWindowsProfile		Das spezifische Profil des Windows-Agentpools.
properties.workloadRuntime	WorkloadRuntime		Bestimmt den Typ der Workload, die ein Knoten ausführen kann.
type	string		Ressourcentyp

AgentPoolGatewayProfile

Objekt

Profil des verwalteten Clustergateway-Agentpools.

Name	Typ	Standardwert	Beschreibung
publicIPPrefixSize	integer (int32) minimum: 28 maximum: 31	31	Der Gateway-Agentpool ordnet ein öffentliches IPPrefix für jedes statische Ausgangsgateway zu, um einen öffentlichen Ausgang bereitzustellen. Die Größe von Public IPPrefix sollte vom Benutzer ausgewählt werden. Jedem Knoten im Agentpool wird eine IP aus der IPPrefix zugewiesen. Die IPPrefix-Größe dient somit als Obergrenze für die Größe des Gateway-Agent-Pools. Aufgrund der Azure public IPPrefix-Größenbeschränkung ist der gültige Wertbereich [28, 31] (/31 = 2 Knoten/IPs, /30 = 4 Knoten/IPs, /29 = 8 Knoten/IPs, /28 = 16 Knoten/IPs). Der Standardwert ist 31.

AgentPoolMode

Enumeration

Der Modus eines Agentpools. Ein Cluster muss immer über mindestens einen 'System'-Agentpool verfügen. Weitere Informationen zu Agentpooleinschränkungen und bewährten Methoden finden Sie unter: https://docs.microsoft.com/azure/aks/use-system-pools

Wert	Beschreibung
System	System-Agent-Pools dienen in erster Linie zum Hosten kritischer System-Pods wie CoreDNS und metrics-server. OsType für System-Agent-Pools muss Linux sein. Die VM-SKU für System-Agentpools muss mindestens 2vCPUs und 4 GB Arbeitsspeicher aufweisen.
User	Benutzer-Agent-Pools dienen in erster Linie zum Hosten Ihrer Anwendungspods.
Gateway	Gateway-Agent-Pools sind für die Bereitstellung statischer Ausgangs-IPs für Pods vorgesehen. Weitere Details finden Sie unter https://aka.ms/aks/static-egress-gateway.

AgentPoolNetworkProfile

Objekt

Netzwerkeinstellungen eines Agentpools.

Name	Typ	Beschreibung
allowedHostPorts	PortRange[]	Die Portbereiche, auf die zugegriffen werden darf. Die angegebenen Bereiche dürfen sich überlappen.
applicationSecurityGroups	string[] (arm-id)	Die IDs der Anwendungssicherheitsgruppen, denen der Agentpool bei der Erstellung zugeordnet wird.
nodePublicIPTags	IPTag[]	IPTags von öffentlichen IP-Adressen auf Instanzebene.

AgentPoolSecurityProfile

Objekt

Die Sicherheitseinstellungen eines Agentpools.

Name	Typ	Beschreibung
enableSecureBoot	boolean	Sicherer Start ist ein Feature des vertrauenswürdigen Starts, das sicherstellt, dass nur signierte Betriebssysteme und Treiber starten können. Weitere Informationen finden Sie unter aka.ms/aks/trustedlaunch. Wenn nicht angegeben, ist der Standardwert "false".
enableVTPM	boolean	vTPM ist ein vertrauenswürdiges Startfeature zum Konfigurieren eines dedizierten sicheren Tresors für Schlüssel und Messungen, die lokal auf dem Knoten gespeichert sind. Weitere Informationen finden Sie unter aka.ms/aks/trustedlaunch. Wenn nicht angegeben, ist der Standardwert "false".
sshAccess	AgentPoolSSHAccess	SSH-Zugriffsmethode eines Agentpools.

AgentPoolSSHAccess

Enumeration

SSH-Zugriffsmethode eines Agentpools.

Wert	Beschreibung
LocalUser	Kann als lokaler Benutzer mithilfe eines privaten Schlüssels eine SSH-Verbindung zum Knoten herstellen.
Disabled	Der SSH-Dienst wird auf dem Knoten deaktiviert.

AgentPoolStatus

Objekt

Enthält schreibgeschützte Informationen zum Agentpool.

Name	Typ	Beschreibung
provisioningError	ErrorDetail	Die Fehlerdetailinformationen des Agentpools. Behält die detaillierten Informationen zum Fehler bei. Wenn kein Fehler aufgetreten ist, wird dieses Feld weggelassen.

AgentPoolType

Enumeration

Der Typ des Agentpools.

Wert	Beschreibung
VirtualMachineScaleSets	Erstellen Sie einen Agentpool, der von einer VM-Skalierungsgruppe unterstützt wird.
AvailabilitySet	Von der Verwendung dieser Option wird dringend abgeraten.
VirtualMachines	Erstellen Sie einen Agent-Pool, der von einem Orchestrierungsmodus für eine einzelne Instanz unterstützt wird.

AgentPoolUpgradeSettings

Objekt

Einstellungen für das Upgrade eines Agentpools

Name	Typ	Beschreibung
drainTimeoutInMinutes	integer (int32) minimum: 1 maximum: 1440	Das Ausgleichstimeout für einen Knoten. Die Zeitspanne (in Minuten), die auf die Entfernung von Pods und die ordnungsgemäße Beendigung pro Knoten wartet. Diese Vertreibungszeit berücksichtigt das Warten auf Pod-Unterbrechungsbudgets. Wenn diese Zeit überschritten wird, schlägt das Upgrade fehl. Sofern nicht angegeben, wird der Wert standardmäßig auf 30 Minuten festgelegt.
maxSurge	string	Die maximale Anzahl oder der Prozentsatz der Knoten, die während des Upgrades bereinigt werden. Dies kann entweder auf eine ganze Zahl (z. B. "5") oder einen Prozentsatz (z. B. "50%" festgelegt werden). Wenn ein Prozentsatz angegeben ist, ist er der Prozentsatz der Gesamtgröße des Agentpools zum Zeitpunkt des Upgrades. Bei Prozentsätzen werden Bruchknoten aufgerundet. Wenn nicht angegeben, ist der Standardwert 10%. Weitere Informationen, einschließlich Best Practices, finden Sie unter: https://v4.hkg1.meaqua.org/en-us/azure/aks/upgrade-cluster
maxUnavailable	string	Die maximale Anzahl oder der Prozentsatz der Knoten, die während des Upgrades gleichzeitig nicht verfügbar sein können. Dies kann entweder auf eine ganze Zahl (z. B. '1') oder einen Prozentsatz (z. B. '5%') festgelegt werden. Wenn ein Prozentsatz angegeben ist, ist er der Prozentsatz der Gesamtgröße des Agentpools zum Zeitpunkt des Upgrades. Bei Prozentsätzen werden Bruchknoten aufgerundet. Wenn nicht angegeben, ist der Standardwert 0. Weitere Informationen, einschließlich Best Practices, finden Sie unter: https://v4.hkg1.meaqua.org/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes	integer (int32) minimum: 0 maximum: 30	Die Soak-Dauer für einen Knoten. Die Zeit (in Minuten), die nach dem Entwässern eines Knotens und vor dem Neustellen des Knotens und dem Wechsel zum nächsten Knoten gewartet werden soll. Wenn nicht angegeben, beträgt die Standardeinstellung 0 Minuten.
undrainableNodeBehavior	UndrainableNodeBehavior	Definiert das Verhalten für nicht feststellbare Knoten während des Upgrades. Die häufigste Ursache für uneinnehmbare Knoten ist Pod Disruption Budgets (PDBs), aber andere Probleme, z. B. pod-Beendigungsfrist, überschreiten das verbleibende Zeitlimit pro Knoten entwässern, oder pod befindet sich weiterhin in einem laufenden Zustand, kann auch zu uneinschränkbaren Knoten führen.

AgentPoolWindowsProfile

Objekt

Das spezifische Profil des Windows-Agentpools.

Name	Typ	Beschreibung
disableOutboundNat	boolean	Gibt an, ob OutboundNAT in Windows-Knoten deaktiviert werden soll. Der Standardwert ist "false". Ausgehende NAT kann nur deaktiviert werden, wenn der cluster outboundType NAT-Gateway ist und der Windows-Agentpool keine öffentliche IP-Knoten aktiviert hat.

code

Enumeration

Gibt an, ob der Cluster ausgeführt oder beendet wird.

Wert	Beschreibung
Running	Der Cluster wird ausgeführt.
Stopped	Der Cluster wird gestoppt.

CreationData

Objekt

Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.

Name	Typ	Beschreibung
sourceResourceId	string (arm-id)	Dies ist die ARM-ID des Quellobjekts, das zum Erstellen des Zielobjekts verwendet werden soll.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GPUDriver

Enumeration

Gibt an, ob GPU-Treiber installiert werden sollen. Wenn sie nicht angegeben ist, ist die Standardeinstellung "Installieren".

Wert	Beschreibung
Install	Installieren Sie den Treiber.
None	Überspringen Sie die Treiberinstallation.

GPUInstanceProfile

Enumeration

GPUInstanceProfile, das zum Angeben des GPU-MIG-Instanzprofils für unterstützte GPU-VM-SKU verwendet werden soll.

Wert	Beschreibung
MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

GPUProfile

Objekt

GPU-Einstellungen für den Agentpool.

Name	Typ	Beschreibung
driver	GPUDriver	Gibt an, ob GPU-Treiber installiert werden sollen. Wenn sie nicht angegeben ist, ist die Standardeinstellung "Installieren".

IPTag

Objekt

Enthält das dem Objekt zugeordnete IPTag.

Name	Typ	Beschreibung
ipTagType	string	Der IP-Tagtyp. Beispiel: RoutingPreference.
tag	string	Der Wert des IP-Tags, das der öffentlichen IP zugeordnet ist. Beispiel: Internet.

KubeletConfig

Objekt

Kubelet-Konfigurationen von Agentknoten. Weitere Informationen finden Sie unter konfiguration der benutzerdefinierten AKS-Knotenkonfiguration.

Name	Typ	Beschreibung
allowedUnsafeSysctls	string[]	Liste zulässiger unsicherer Sysctls oder unsicherer Sysctl-Muster (endend in `*`).
containerLogMaxFiles	integer (int32) minimum: 2	Die maximale Anzahl von Containerprotokolldateien, die für einen Container vorhanden sein können. Die Zahl muss ≥ 2 sein.
containerLogMaxSizeMB	integer (int32)	Die maximale Größe (z. B. 10Mi) der Containerprotokolldatei, bevor sie gedreht wird.
cpuCfsQuota	boolean	Wenn die Erzwingung von CPU-CFS-Kontingenten für Container aktiviert ist, die CPU-Grenzwerte angeben. Der Standardwert ist "true".
cpuCfsQuotaPeriod	string	Der CPU CFS-Kontingentzeitraumswert. Der Standardwert ist "100 ms". Gültige Werte sind eine Sequenz von Dezimalzahlen mit einem optionalen Bruch und einem Einheitensuffix. Beispiel: '300 ms', '2h45m'. Unterstützte Einheiten sind 'ns', 'us', 'ms', 's', 'm' und 'h'.
cpuManagerPolicy	string	Die zu verwendende CPU-Manager-Richtlinie. Der Standardwert ist "none". Weitere Informationen finden Sie unter Kubernetes CPU-Verwaltungsrichtlinien . Zulässige Werte sind "none" und "static".
failSwapOn	boolean	Wenn dieser Wert auf "true" festgelegt ist, schlägt das Kubelet fehl, wenn der Tausch auf dem Knoten aktiviert ist.
imageGcHighThreshold	integer (int32)	Der Prozentsatz der Datenträgerauslastung, nach der die Garbage Collection des Images immer ausgeführt wird. Um die Garbage Collection von Bildern zu deaktivieren, legen Sie diesen auf 100 fest. Der Standardwert ist 85%
imageGcLowThreshold	integer (int32)	Der Prozentsatz der Datenträgerauslastung, vor der die Garbage Collection von Bildern nie ausgeführt wird. Dies kann nicht höher als imageGcHighThreshold festgelegt werden. Der Standardwert ist 80%
podMaxPids	integer (int32)	Die maximale Anzahl von Prozessen pro Pod.
topologyManagerPolicy	string	Die zu verwendende Topologie-Manager-Richtlinie. Weitere Informationen finden Sie unter Kubernetes Topology Manager. Der Standardwert ist "none". Zulässige Werte sind "none", "best-effort", "restricted" und "single-numa-node".

KubeletDiskType

Enumeration

Bestimmt die Platzierung von emptyDir-Volumes, Containerlaufzeitdatenstamm und Kubelet-Kurzspeicher.

Wert	Beschreibung
OS	Kubelet verwendet den Betriebssystemdatenträger für seine Daten.
Temporary	Kubelet verwendet die temporäre Festplatte für seine Daten.

LinuxOSConfig

Objekt

Betriebssystemkonfigurationen von Linux-Agentknoten. Weitere Informationen finden Sie unter konfiguration der benutzerdefinierten AKS-Knotenkonfiguration.

Name	Typ	Beschreibung
swapFileSizeMB	integer (int32)	Die Größe in MB einer Swapdatei, die auf jedem Knoten erstellt wird.
sysctls	SysctlConfig	Sysctl-Einstellungen für Linux-Agentknoten.
transparentHugePageDefrag	string	Gibt an, ob der Kernel aggressive Speicherkomprimierung nutzen soll, um mehr Hugepages zur Verfügung zu stellen. Gültige Werte sind "always", "defer", "defer+madvise", "madvise" und "never". Der Standardwert ist "madvise". Weitere Informationen finden Sie unter Transparent Hugepages.
transparentHugePageEnabled	string	Gibt an, ob transparente Hugepages aktiviert sind. Gültige Werte sind "always", "madvise" und "never". Der Standardwert ist "always". Weitere Informationen finden Sie unter Transparent Hugepages.

LocalDNSForwardDestination

Enumeration

Zielserver für DNS-Abfragen, die von localDNS weitergeleitet werden sollen.

Wert	Beschreibung
ClusterCoreDNS	Leiten Sie DNS-Abfragen von localDNS an den CoreDNS-Cluster weiter.
VnetDNS	Leiten Sie DNS-Abfragen von localDNS an den im VNET konfigurierten DNS-Server weiter. Für ein VNET können mehrere DNS-Server konfiguriert sein.

LocalDNSForwardPolicy

Enumeration

Forward-Richtlinie für die Auswahl des Upstream-DNS-Servers. Weitere Informationen finden Sie unter Forward-Plugin .

Wert	Beschreibung
Sequential	Implementiert die sequenzielle Auswahl von Upstream-DNS-Servern. Weitere Informationen finden Sie unter Forward-Plugin .
RoundRobin	Implementiert die Roundrobin-Auswahl von Upstream-DNS-Servern. Weitere Informationen finden Sie unter Forward-Plugin .
Random	Implementiert die zufällige Auswahl von Upstream-DNS-Servern. Weitere Informationen finden Sie unter Forward-Plugin .

LocalDNSMode

Enumeration

Aktivierungsmodus für localDNS.

Wert	Beschreibung
Preferred	Wenn die aktuelle Orchestrator-Version dieses Feature unterstützt, sollten Sie localDNS aktivieren.
Required	Aktivieren Sie localDNS.
Disabled	Deaktivieren Sie localDNS.

LocalDNSOverride

Objekt

Außerkraftsetzungen für localDNS-Profil.

Name	Typ	Standardwert	Beschreibung
cacheDurationInSeconds	integer (int32)	3600	Maximale Cache-TTL in Sekunden. Weitere Informationen finden Sie unter Cache-Plugin .
forwardDestination	LocalDNSForwardDestination	ClusterCoreDNS	Zielserver für DNS-Abfragen, die von localDNS weitergeleitet werden sollen.
forwardPolicy	LocalDNSForwardPolicy	Sequential	Forward-Richtlinie für die Auswahl des Upstream-DNS-Servers. Weitere Informationen finden Sie unter Forward-Plugin .
maxConcurrent	integer (int32)	1000	Maximale Anzahl gleichzeitiger Abfragen. Weitere Informationen finden Sie unter Forward-Plugin .
protocol	LocalDNSProtocol	PreferUDP	Erzwingen Sie TCP oder bevorzugen Sie das UDP-Protokoll für Verbindungen von localDNS zum Upstream-DNS-Server.
queryLogging	LocalDNSQueryLogging	Error	Protokollebene für DNS-Abfragen in localDNS.
serveStale	LocalDNSServeStale	Immediate	Richtlinie für die Bereitstellung veralteter Daten. Weitere Informationen finden Sie unter Cache-Plugin .
serveStaleDurationInSeconds	integer (int32)	3600	Veraltete Dauer in Sekunden bereitstellen. Weitere Informationen finden Sie unter Cache-Plugin .

LocalDNSProfile

Objekt

Konfiguriert das lokale DNS pro Knoten mit VnetDNS- und KubeDNS-Außerkraftsetzungen. LocalDNS trägt dazu bei, die Leistung und Zuverlässigkeit der DNS-Auflösung in einem AKS-Cluster zu verbessern. Weitere Informationen finden Sie unter aka.ms/aks/localdns.

Name	Typ	Standardwert	Beschreibung
kubeDNSOverrides	<string, LocalDNSOverride>		KubeDNS-Außerkraftsetzungen gelten für DNS-Datenverkehr von Pods mit dnsPolicy:ClusterFirst (als KubeDNS-Datenverkehr bezeichnet).
mode	LocalDNSMode	Preferred	Aktivierungsmodus für localDNS.
state	LocalDNSState		Vom System generierter Zustand von localDNS.
vnetDNSOverrides	<string, LocalDNSOverride>		VnetDNS-Außerkraftsetzungen gelten für DNS-Datenverkehr von Pods mit dnsPolicy:default oder Kubelet (als VnetDNS-Datenverkehr bezeichnet).

LocalDNSProtocol

Enumeration

Erzwingen Sie TCP oder bevorzugen Sie das UDP-Protokoll für Verbindungen von localDNS zum Upstream-DNS-Server.

Wert	Beschreibung
PreferUDP	Bevorzugen Sie das UDP-Protokoll für Verbindungen von localDNS zu einem Upstream-DNS-Server.
ForceTCP	Erzwingen Sie das TCP-Protokoll für Verbindungen von localDNS zu einem Upstream-DNS-Server.

LocalDNSQueryLogging

Enumeration

Protokollebene für DNS-Abfragen in localDNS.

Wert	Beschreibung
Error	Aktiviert die Fehlerprotokollierung in localDNS. Weitere Informationen finden Sie unter Fehler-Plugin .
Log	Aktiviert die Abfrageprotokollierung in localDNS. Weitere Informationen finden Sie unter Log-Plugin .

LocalDNSServeStale

Enumeration

Richtlinie für die Bereitstellung veralteter Daten. Weitere Informationen finden Sie unter Cache-Plugin .

Wert	Beschreibung
Verify	Bereitstellen veralteter Daten mit Verifizierung. Stellen Sie zunächst sicher, dass ein Eintrag in der Quelle immer noch nicht verfügbar ist, bevor Sie den abgelaufenen Eintrag an den Client senden. Weitere Informationen finden Sie unter Cache-Plugin .
Immediate	Bereitstellen veralteter Daten sofort. Senden Sie den abgelaufenen Eintrag an den Client, bevor Sie überprüfen, ob der Eintrag von der Quelle verfügbar ist. Weitere Informationen finden Sie unter Cache-Plugin .
Disable	Deaktivieren Sie die Bereitstellung veralteter Daten.

LocalDNSState

Enumeration

Vom System generierter Zustand von localDNS.

Wert	Beschreibung
Enabled	localDNS ist aktiviert.
Disabled	localDNS ist deaktiviert.

ManualScaleProfile

Objekt

Spezifikationen für die Anzahl der Maschinen.

Name	Typ	Beschreibung
count	integer (int32)	Anzahl der Knoten.
size	string	VM-Größe, die AKS beim Erstellen und Skalieren verwendet, z. B. "Standard_E4s_v3", "Standard_E16s_v3" oder "Standard_D16s_v5".

OSDiskType

Enumeration

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll. Der Standardwert ist "Ephemeral", wenn die VM sie unterstützt und über einen Cachedatenträger verfügt, der größer als die angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" verwendet. Kann nach der Erstellung nicht mehr geändert werden. Weitere Informationen finden Sie unter Ephemeral OS.

Wert	Beschreibung
Managed	Azure repliziert den Betriebssystemdatenträger für einen virtuellen Computer in Azure Storage, um Datenverluste zu vermeiden, falls die VM auf einen anderen Host verschoben werden muss. Da Container nicht so konzipiert sind, dass der lokale Zustand beibehalten wird, bietet dieses Verhalten einen begrenzten Wert, während einige Nachteile bereitgestellt werden, einschließlich langsamerer Knotenbereitstellung und höherer Lese-/Schreiblatenz.
Ephemeral	Kurzlebige Betriebssystemdatenträger werden nur auf dem Hostcomputer gespeichert, genau wie ein temporärer Datenträger. Dies bietet geringere Lese-/Schreiblatenz sowie schnellere Knotenskalierung und Clusterupgrades.

Wert

Beschreibung

Managed

Azure repliziert den Betriebssystemdatenträger für einen virtuellen Computer in Azure Storage, um Datenverluste zu vermeiden, falls die VM auf einen anderen Host verschoben werden muss. Da Container nicht so konzipiert sind, dass der lokale Zustand beibehalten wird, bietet dieses Verhalten einen begrenzten Wert, während einige Nachteile bereitgestellt werden, einschließlich langsamerer Knotenbereitstellung und höherer Lese-/Schreiblatenz.

Ephemeral

Kurzlebige Betriebssystemdatenträger werden nur auf dem Hostcomputer gespeichert, genau wie ein temporärer Datenträger. Dies bietet geringere Lese-/Schreiblatenz sowie schnellere Knotenskalierung und Clusterupgrades.

OSSKU

Enumeration

Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.

Wert	Beschreibung
AzureLinux	Verwenden Sie AzureLinux als Betriebssystem für Knotenimages. Azure Linux ist eine containeroptimierte Linux-Distribution, die von Microsoft erstellt wurde, besuchen Sie https://aka.ms/azurelinux, um weitere Informationen zu finden.
AzureLinux3	Verwenden Sie AzureLinux3 als Betriebssystem für Knotenimages. Azure Linux ist eine containeroptimierte Linux-Distribution, die von Microsoft erstellt wurde, besuchen Sie https://aka.ms/azurelinux, um weitere Informationen zu finden. Informationen zu Einschränkungen finden Sie unter https://aka.ms/aks/node-images. Eine Anleitung zur Betriebssystemmigration finden Sie unter https://aka.ms/aks/upgrade-os-version.
CBLMariner	Veraltete OSSKU. Microsoft empfiehlt, stattdessen neue Bereitstellungen "AzureLinux" auszuwählen.
Ubuntu	Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
Ubuntu2204	Verwenden Sie Ubuntu2204 als Betriebssystem für Knotenimages, Ubuntu 22.04 wird jedoch möglicherweise nicht für alle Knotenpools unterstützt. Informationen zu Einschränkungen und unterstützten Kubernetes-Versionen finden Sie unter https://aka.ms/aks/supported-ubuntu-versions
Ubuntu2404	Verwenden Sie Ubuntu2404 als Betriebssystem für Knotenimages, Ubuntu 24.04 wird jedoch möglicherweise nicht für alle Knotenpools unterstützt. Informationen zu Einschränkungen und unterstützten Kubernetes-Versionen finden Sie unter https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Verwenden Sie Windows2019 als Betriebssystem für Knotenimages. Nicht unterstützt für Systemknotenpools. Windows2019 unterstützt nur Windows2019-Container; Sie kann Keine Windows2022-Container ausführen und umgekehrt.
Windows2022	Verwenden Sie Windows2022 als Betriebssystem für Knotenimages. Nicht unterstützt für Systemknotenpools. Windows2022 unterstützt nur Windows2022-Container; Sie kann Keine Windows2019-Container ausführen und umgekehrt.

OSType

Enumeration

Der Betriebssystemtyp. Der Standardwert ist Linux.

Wert	Beschreibung
Linux	Verwenden Sie Linux.
Windows	Verwenden Sie Windows.

PodIPAllocationMode

Enumeration

Pod-IP-Zuordnungsmodus. Der IP-Zuordnungsmodus für Pods im Agentpool. Muss mit podSubnetId verwendet werden. Der Standardwert ist "DynamicIndividual".

Wert	Beschreibung
DynamicIndividual	Jedem Knoten wird eine nicht zusammenhängende Liste von IP-Adressen zugeordnet, die Pods zugewiesen werden können. Dies ist besser, um ein kleines bis mittleres Subnetz der Größe /16 oder kleiner zu maximieren. Der Azure CNI-Cluster mit dynamischer IP-Zuordnung verwendet standardmäßig diesen Modus, wenn der Kunde nicht explizit einen podIPAllocationMode angibt
StaticBlock	Jedem Knoten werden statisch CIDR-Blöcke der Größe /28 = 16 IPs pro Block zugewiesen, um die maxPods pro Knoten zu erfüllen. Anzahl der CIDR-Blöcke >= (maxPods / 16). Der Block zählt anstelle einer einzelnen IP-Adresse mit dem Azure Vnet Private IP-Grenzwert von 65K. Daher eignet sich der Blockmodus für die Ausführung größerer Workloads mit mehr als dem aktuellen Grenzwert von 65K-Pods in einem Cluster. Dieser Modus eignet sich besser für die Skalierung mit größeren Subnetzen von /15 oder größer

Wert

Beschreibung

DynamicIndividual

Jedem Knoten wird eine nicht zusammenhängende Liste von IP-Adressen zugeordnet, die Pods zugewiesen werden können. Dies ist besser, um ein kleines bis mittleres Subnetz der Größe /16 oder kleiner zu maximieren. Der Azure CNI-Cluster mit dynamischer IP-Zuordnung verwendet standardmäßig diesen Modus, wenn der Kunde nicht explizit einen podIPAllocationMode angibt

StaticBlock

Jedem Knoten werden statisch CIDR-Blöcke der Größe /28 = 16 IPs pro Block zugewiesen, um die maxPods pro Knoten zu erfüllen. Anzahl der CIDR-Blöcke >= (maxPods / 16). Der Block zählt anstelle einer einzelnen IP-Adresse mit dem Azure Vnet Private IP-Grenzwert von 65K. Daher eignet sich der Blockmodus für die Ausführung größerer Workloads mit mehr als dem aktuellen Grenzwert von 65K-Pods in einem Cluster. Dieser Modus eignet sich besser für die Skalierung mit größeren Subnetzen von /15 oder größer

PortRange

Objekt

Der Portbereich.

Name	Typ	Beschreibung
portEnd	integer (int32) minimum: 1 maximum: 65535	Der maximale Port, der im Bereich enthalten ist. Er sollte zwischen 1 und 65535 liegen und größer als oder gleich PortStart sein.
portStart	integer (int32) minimum: 1 maximum: 65535	Der minimale Port, der im Bereich enthalten ist. Es sollte zwischen 1 und 65535 liegen und kleiner als oder gleich portEnd sein.
protocol	Protocol	Das Netzwerkprotokoll des Ports.

PowerState

Objekt

Beschreibt den Power State des Clusters.

Name	Typ	Beschreibung
code	code	Gibt an, ob der Cluster ausgeführt oder beendet wird.

Protocol

Enumeration

Das Netzwerkprotokoll des Ports.

Wert	Beschreibung
TCP	TCP-Protokoll.
UDP	UDP-Protokoll.

ScaleDownMode

Enumeration

Beschreibt, wie VMs zu Agentpools hinzugefügt oder daraus entfernt werden. Weitere Informationen finden Sie unter Abrechnungsstatus.

Wert	Beschreibung
Delete	Erstellen Sie neue Instanzen während des zentralen Hochskalierens, und entfernen Sie Instanzen während des zentralen Hochskalierens.
Deallocate	Versuchen Sie, freigegebene Instanzen (sofern vorhanden) während des zentralen Hochskalierens zu starten und die Zuordnung von Instanzen während des zentralen Hochskalierens aufzuheben.

ScaleProfile

Objekt

Spezifikationen zum Skalieren eines VirtualMachines-Agentpools.

Name	Typ	Beschreibung
manual	ManualScaleProfile[]	Spezifikationen zum Skalieren des VirtualMachines-Agentpools auf eine feste Größe.

ScaleSetEvictionPolicy

Enumeration

Die Richtlinie zum Entfernen von VM-Skalierungsgruppen. Die Entfernungsrichtlinie gibt an, was mit der VM geschehen soll, wenn sie entfernt wird. Der Standardwert ist Löschen. Weitere Informationen zur Entfernung finden Sie unter Spot-VMs.

Wert	Beschreibung
Delete	Knoten in der zugrunde liegenden Skalierungsgruppe des Knotenpools werden gelöscht, wenn sie entfernt werden.
Deallocate	Knoten in der zugrunde liegenden Skalierungsgruppe des Knotenpools werden bei der Entfernung auf den Status "Beendet/Zuordnung aufgehoben" festgelegt. Knoten im Zustand "Beendete Zuordnung" zählen zu Ihrem Computekontingent und können Probleme mit der Clusterskalierung oder einem Upgrade verursachen.

ScaleSetPriority

Enumeration

Priorität des Skalierungssatzes für virtuelle Computer.

Wert	Beschreibung
Spot	Es werden VMs mit Spot-Priorität verwendet. Für Spotknoten ist kein SLA vorhanden. Weitere Informationen finden Sie unter Spot auf AKS.
Regular	Es werden reguläre VMs verwendet.

SysctlConfig

Objekt

Sysctl-Einstellungen für Linux-Agentknoten.

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

UndrainableNodeBehavior

Enumeration

Definiert das Verhalten für nicht feststellbare Knoten während des Upgrades. Die häufigste Ursache für uneinnehmbare Knoten ist Pod Disruption Budgets (PDBs), aber andere Probleme, z. B. pod-Beendigungsfrist, überschreiten das verbleibende Zeitlimit pro Knoten entwässern, oder pod befindet sich weiterhin in einem laufenden Zustand, kann auch zu uneinschränkbaren Knoten führen.

Wert	Beschreibung
Schedule	AKS markiert die blockierten Knoten als planbar, aber die blockierten Knoten werden nicht aktualisiert. Es wird versucht, alle Überspannungsknoten zu löschen. Der Upgradevorgang und der verwaltete Cluster befinden sich im Fehlerhaften Zustand, wenn blockierte Knoten vorhanden sind.
Cordon	AKS sperrt die blockierten Knoten und ersetzt sie während des Upgrades durch Surge Nodes. Die blockierten Knoten werden abgekabelt und durch Überspannungsknoten ersetzt. Die blockierten Knoten haben die Bezeichnung "kubernetes.azure.com/upgrade-status:Quarantined". Für jeden blockierten Knoten wird ein Überspannungsknoten beibehalten. Es wird versucht, alle anderen Überspannungsknoten zu löschen. Wenn genügend Überspannungsknoten vorhanden sind, um blockierte Knoten zu ersetzen, befindet sich der Upgradevorgang und der verwaltete Cluster im Fehlerhaften Zustand. Andernfalls wird der Upgradevorgang und der verwaltete Cluster abgebrochen.

Wert

Beschreibung

Schedule

AKS markiert die blockierten Knoten als planbar, aber die blockierten Knoten werden nicht aktualisiert. Es wird versucht, alle Überspannungsknoten zu löschen. Der Upgradevorgang und der verwaltete Cluster befinden sich im Fehlerhaften Zustand, wenn blockierte Knoten vorhanden sind.

Cordon

AKS sperrt die blockierten Knoten und ersetzt sie während des Upgrades durch Surge Nodes. Die blockierten Knoten werden abgekabelt und durch Überspannungsknoten ersetzt. Die blockierten Knoten haben die Bezeichnung "kubernetes.azure.com/upgrade-status:Quarantined". Für jeden blockierten Knoten wird ein Überspannungsknoten beibehalten. Es wird versucht, alle anderen Überspannungsknoten zu löschen. Wenn genügend Überspannungsknoten vorhanden sind, um blockierte Knoten zu ersetzen, befindet sich der Upgradevorgang und der verwaltete Cluster im Fehlerhaften Zustand. Andernfalls wird der Upgradevorgang und der verwaltete Cluster abgebrochen.

VirtualMachineNodes

Objekt

Aktueller Status für eine Gruppe von Knoten derselben VM-Größe.

Name	Typ	Beschreibung
count	integer (int32)	Anzahl der Knoten.
size	string	Die VM-Größe der Agents, die zum Hosten dieser Gruppe von Knoten verwendet werden.

VirtualMachinesProfile

Objekt

Spezifikationen für den VirtualMachines-Agentpool.

Name	Typ	Beschreibung
scale	ScaleProfile	Spezifikationen zum Skalieren eines VirtualMachines-Agentpools.

WorkloadRuntime

Enumeration

Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

Wert	Beschreibung
OCIContainer	Knoten verwenden Kubelet zum Ausführen standardmäßiger OCI-Containerarbeitslasten.
WasmWasi	Knoten verwenden Krustlet zum Ausführen von WASM-Workloads mithilfe des WASI-Anbieters (Vorschau).
KataVmIsolation	Knoten können (Kata + Cloud Hypervisor + Hyper-V) verwenden, um geschachtelte VM-basierte Pods zu aktivieren. Aufgrund der Verwendung von Hyper-V ist das AKS-Knotenbetriebssystem selbst eine geschachtelte VM (das Stammbetriebssystem) von Hyper-V. Daher kann es nur mit VM-Reihen verwendet werden, die geschachtelte Virtualisierung wie dv3-Serie unterstützen.

Freigeben über

Agent Pools - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get Agent Pool

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AgentPool

AgentPoolGatewayProfile

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolSSHAccess

AgentPoolStatus

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

code

CreationData

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GPUDriver

GPUInstanceProfile

GPUProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

LocalDNSForwardDestination

LocalDNSForwardPolicy

LocalDNSMode

LocalDNSOverride

LocalDNSProfile

LocalDNSProtocol

LocalDNSQueryLogging

LocalDNSServeStale

LocalDNSState

ManualScaleProfile

OSDiskType

OSSKU

OSType

PodIPAllocationMode

PortRange

PowerState

Protocol

ScaleDownMode

ScaleProfile

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

UndrainableNodeBehavior

VirtualMachineNodes

VirtualMachinesProfile

WorkloadRuntime