Agent Pools - Get

Referenz

Service:: AKS

API Version:: 2024-02-01

Ruft den angegebenen Pool des verwalteten Cluster-Agents ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
agentPoolName	path	True	string	Der Name des Agentpools. Regex pattern: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der verwalteten Clusterressource. Regex pattern: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AgentPool	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get Agent Pool

Sample Request

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


/**
 * Samples for AgentPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-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-02-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-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"),
	// 		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-02-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

Sample Response

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",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
    "upgradeSettings": {
      "maxSurge": "33%"
    }
  }
}

Definitionen

Name	Beschreibung
AgentPool	Agent-Pool.
AgentPoolMode	Der Modus eines Agentpools.
AgentPoolNetworkProfile	Netzwerkeinstellungen eines Agentpools.
AgentPoolType	Der Typ des Agentpools.
AgentPoolUpgradeSettings	Einstellungen für das Upgrade eines Agentpools
AgentPoolWindowsProfile	Das spezifische Profil des Windows-Agent-Pools.
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
code	Gibt an, ob der Cluster ausgeführt oder beendet ist.
CreationData	Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
GPUInstanceProfile	GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für unterstützte GPU-VM-SKU verwendet werden soll.
IPTag	Enthält das dem -Objekt zugeordnete IPTag.
KubeletConfig	Kubelet-Konfigurationen von Agentknoten.
KubeletDiskType	Bestimmt die Platzierung von emptyDir-Volumes, Containerruntime-Datenstamm und kurzlebigem Kubelet-Speicher.
LinuxOSConfig	Betriebssystemkonfigurationen von Linux-Agent-Knoten.
OSDiskType	Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.
OSSKU	Gibt die betriebssystem-SKU an, die vom Agentpool verwendet wird. 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.
PortRange	Der Portbereich.
PowerState	Beschreibt den Energiezustand 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.
ScaleSetEvictionPolicy	Die Richtlinie zum Entfernen der VM-Skalierungsgruppe.
ScaleSetPriority	Die Priorität der VM-Skalierungsgruppe.
SysctlConfig	Sysctl-Einstellungen für Linux-Agent-Knoten.
WorkloadRuntime	Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

AgentPool

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		Die vollqualifizierte Ressourcen-ID der Kapazitätsreservierungsgruppe, um virtuelle Computer aus einer reservierten Gruppe von Virtual Machines bereitzustellen. AKS ordnet den angegebenen Agentpool der Kapazitätsreservierungsgruppe zu.
properties.count	integer		Anzahl der Agents (VMs) zum Hosten von Docker-Containern. Zulässige Werte müssen im Bereich von 0 bis 1000 (einschließlich) für Benutzerpools und im Bereich von 1 bis 1000 (einschließlich) für Systempools liegen. Der Standardwert ist 1.
properties.creationData	CreationData		CreationData, die zum Angeben der Quellmomentaufnahme-ID verwendet werden soll, wenn der Knotenpool mithilfe eines Momentaufnahme erstellt/aktualisiert wird.
properties.currentOrchestratorVersion	string		Die Version von Kubernetes, die der Agentpool ausführt. 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 die vollständige <verwendete "major.minor.patch>"-Version.
properties.enableAutoScaling	boolean		Ob die automatische Skalierung aktiviert werden soll
properties.enableEncryptionAtHost	boolean		Gibt an, ob die hostbasierte Betriebssystem- und Datenlaufwerkverschlüsselung aktiviert werden soll. 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-Adresse zugewiesen wird. Einige Szenarien erfordern möglicherweise, dass Knoten in einem Knotenpool ihre eigenen dedizierten öffentlichen IP-Adressen erhalten. Ein häufiges Szenario hierfür sind Gamingworkloads, 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-Adresse pro Knoten. Die Standardeinstellung ist „false“.
properties.enableUltraSSD	boolean		Ob UltraSSD aktiviert werden soll
properties.gpuInstanceProfile	GPUInstanceProfile		GPUInstanceProfile, das zum Angeben des GPU-MIG-instance-Profils für unterstützte GPU-VM-SKU verwendet werden soll.
properties.hostGroupID	string		Die vollqualifizierte Ressourcen-ID der Dedizierten Hostgruppe zum Bereitstellen von virtuellen Computern, die nur im Erstellungsszenario verwendet wird und nach dem Festlegen nicht geändert werden darf. Dies hat die Form :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. Weitere Informationen finden Sie unter Dedizierte Azure-Hosts.
properties.kubeletConfig	KubeletConfig		Kubeletkonfigurationen von Agentknoten. Die Kubelet-Konfiguration auf den Agentpoolknoten.
properties.kubeletDiskType	KubeletDiskType		Bestimmt die Platzierung von emptyDir-Volumes, Container Runtime-Datenstamm und kurzlebigem Kubelet-Speicher.
properties.linuxOSConfig	LinuxOSConfig		Betriebssystemkonfigurationen von Linux-Agent-Knoten. Die Betriebssystemkonfiguration von Linux-Agent-Knoten.
properties.maxCount	integer		Die maximale Anzahl von Knoten für die automatische Skalierung
properties.maxPods	integer		Die maximale Anzahl von Pods, die auf einem Knoten ausgeführt werden können.
properties.minCount	integer		Die Mindestanzahl von Knoten für die automatische Skalierung
properties.mode	AgentPoolMode		Der Modus eines Agentpools. Ein Cluster muss jederzeit über mindestens einen System-Agent-Pool verfügen. Weitere Informationen zu Einschränkungen und bewährten Methoden für Agentpools 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 Knotenbezeichnungen, die auf allen Knoten im Agentpool beibehalten werden sollen.
properties.nodePublicIPPrefixID	string		Die öffentliche IP-Präfix-ID, von der VM-Knoten IP-Adressen verwenden sollten. Dies hat die Form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints	string[]		Die beim Erstellen und Skalieren des Knotenpools neuen Knoten hinzugefügten Taints. Beispiel: key=value:NoSchedule.
properties.orchestratorVersion	string		Die vom Benutzer angegebene Kubernetes-Version. Sowohl die 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, selbst 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 die gleiche Hauptversion haben wie die Steuerungsebene. Die Nebenversion des Knotenpools muss innerhalb von zwei Nebenversionen der Version der Steuerungsebene liegen. Die Knotenpoolversion darf nicht größer als die Version der Steuerungsebene sein. Weitere Informationen finden Sie unter Aktualisieren eines Knotenpools.
properties.osDiskSizeGB	integer		Betriebssystemdatenträgergröße in GB, die zum Angeben der Datenträgergröße für jeden Computer im master-/Agent-Pool verwendet werden soll. Wenn Sie 0 angeben, wird die standardmäßige osDisk-Größe gemäß dem angegebenen vmSize-Wert angewendet.
properties.osDiskType	OSDiskType		Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll. Der Standardwert ist "Ephemeral", wenn die VM dies unterstützt und über einen Cachedatenträger verfügt, der größer als der angeforderte OSDiskSizeGB ist. Andernfalls wird standardmäßig "Verwaltet" festgelegt. Kann nach der Erstellung nicht geändert werden. Weitere Informationen finden Sie unter Kurzlebiges Betriebssystem.
properties.osSKU	OSSKU		Gibt die Betriebssystem-SKU an, die vom Agentpool verwendet wird. 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.podSubnetID	string		Die ID des Subnetzes, dem pods beim Start beitreten werden. Wenn nicht angegeben, werden Pod-IPs statisch im Knotensubnetz zugewiesen (weitere Details finden Sie unter vnetSubnetID). Dies hat die Form: /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 zunächst ausgeführt. Der Agentpool kann beendet werden, indem Sie dieses Feld auf Beendet festlegen. Ein beendeter Agentpool beendet alle VMs und fallen keine Abrechnungsgebühren an. Ein Agentpool kann nur beendet werden, wenn er ausgeführt ist und der Bereitstellungsstatus erfolgreich ist.
properties.provisioningState	string		Der aktuelle Bereitstellungs- oder Bereitstellungsstatus.
properties.proximityPlacementGroupID	string		Die ID für näherungsplatzierungsgruppe.
properties.scaleDownMode	ScaleDownMode		Der Herunterskalierungsmodus, der beim Skalieren des Agentpools verwendet werden soll. Dies wirkt sich auch auf das Verhalten der automatischen Clusterskalierung aus. Wenn nicht angegeben, wird standardmäßig "Löschen" verwendet.
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	Die zu verwendende Richtlinie zum Entfernen von VM-Skalierungsgruppen. Dies kann nur angegeben werden, wenn scaleSetPriority "Spot" lautet. Wenn nicht angegeben, lautet der Standardwert "Löschen".
properties.scaleSetPriority	ScaleSetPriority	Regular	Die Vm-Skalierungssatzpriorität. Wenn nicht angegeben, lautet der Standardwert "Regular".
properties.spotMaxPrice	number	-1	Der maximale Preis (in US-Dollar), den Sie für Spot-Instanzen bezahlen möchten. Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der angibt, dass der Standardpreis bei Bedarf bis zu hoch ist. Mögliche Werte sind ein beliebiger Dezimalwert größer als 0 oder -1, der die Bereitschaft angibt, einen Beliebigen On-Demand-Preis zu zahlen. Weitere Informationen zu Spotpreisen finden Sie unter Preise für Spot-VMs.
properties.tags	object		Die Tags, die im VM-Skalierungssatz des Agentpools beibehalten werden sollen.
properties.type	AgentPoolType		Der Typ des Agentpools.
properties.upgradeSettings	AgentPoolUpgradeSettings		Einstellungen für das Upgrade des Agentpools
properties.vmSize	string		Die Größe der VMs des Agentpools. Die Verfügbarkeit der VM-Größe 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		Die ID des Subnetzes, dem agentpoolknoten und optional Pods beim Start beitreten. Wenn dies nicht angegeben ist, werden ein VNET und ein Subnetz generiert und verwendet. Wenn keine podSubnetID angegeben ist, gilt dies für Knoten und Pods, andernfalls gilt dies nur für Knoten. Dies hat die Form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile	AgentPoolWindowsProfile		Das spezifische Profil des Windows-Agent-Pools.
properties.workloadRuntime	WorkloadRuntime		Bestimmt den Typ der Workload, die ein Knoten ausführen kann.
type	string		Ressourcentyp

AgentPoolMode

Der Modus eines Agentpools.

Name	Typ	Beschreibung
System	string	System-Agent-Pools dienen in erster Linie zum Hosten kritischer Systempods wie CoreDNS und metrics-server. OsType für System-Agent-Pools muss Linux sein. Die VM-SKU für System-Agent-Pools muss mindestens 2 vCPUs und 4 GB Arbeitsspeicher aufweisen.
User	string	Benutzer-Agent-Pools dienen in erster Linie zum Hosten Ihrer Anwendungspods.

AgentPoolNetworkProfile

Netzwerkeinstellungen eines Agentpools.

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

AgentPoolType

Der Typ des Agentpools.

Name	Typ	Beschreibung
AvailabilitySet	string	Davon wird dringend abgeraten.
VirtualMachineScaleSets	string	Erstellen Sie einen Agentpool, der von einer VM-Skalierungsgruppe unterstützt wird.

AgentPoolUpgradeSettings

Einstellungen für das Upgrade eines Agentpools

Name	Typ	Beschreibung
drainTimeoutInMinutes	integer	Das Timeout für die Entwässerung für einen Knoten Die Zeitspanne (in Minuten), die auf die Entfernung von Pods und die ordnungsgemäße Beendigung pro Knoten gewartet werden soll. Diese Entfernungswartezeit berücksichtigt das Warten auf Budgets für Podunterbrechungen. Wenn diese Zeit überschritten wird, schlägt das Upgrade fehl. Wenn nicht angegeben, ist der Standardwert 30 Minuten.
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 auf einen Prozentsatz (z. B. "50%") festgelegt werden. Wenn ein Prozentsatz angegeben wird, ist dies der Prozentsatz der Gesamtgröße des Agentpools zum Zeitpunkt des Upgrades. Für Prozentsätze werden Bruchknoten aufgerundet. Wenn nichts angegeben ist, wird der Standardwert 1 verwendet. Weitere Informationen, einschließlich bewährter Methoden, finden Sie unter: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes	integer	Die Dauer des Einweichens für einen Knoten Die Zeit (in Minuten), die nach dem Leeren eines Knotens und vor dem Erneuten Ändern des Knotens und dem Wechsel zum nächsten Knoten gewartet werden soll. Wenn nicht angegeben, ist der Standardwert 0 Minuten.

AgentPoolWindowsProfile

Das spezifische Profil des Windows-Agent-Pools.

Name	Typ	Beschreibung
disableOutboundNat	boolean	Ob OutboundNAT in Windows-Knoten deaktiviert werden soll Der Standardwert ist „FALSE“. Outbound NAT kann nur deaktiviert werden, wenn der Cluster outboundType NAT-Gateway ist und der Windows-Agent-Pool keine öffentliche Knoten-IP aktiviert hat.

CloudError

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

code

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

Name	Typ	Beschreibung
Running	string	Der Cluster wird ausgeführt.
Stopped	string	Der Cluster wird beendet.

CreationData

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

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

GPUInstanceProfile

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

Name	Typ	Beschreibung
MIG1g	string
MIG2g	string
MIG3g	string
MIG4g	string
MIG7g	string

IPTag

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-Adresse zugeordnet ist. Beispiel: Internet.

KubeletConfig

Kubelet-Konfigurationen von Agentknoten.

Name	Typ	Beschreibung
allowedUnsafeSysctls	string[]	Zulässige Liste unsicherer Sysctls oder unsicherer Sysctl-Muster (endet auf `*`).
containerLogMaxFiles	integer	Die maximale Anzahl von Containerprotokolldateien, die für einen Container vorhanden sein können Die Zahl muss ≥ 2 sein.
containerLogMaxSizeMB	integer	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 Wert des CPU-CFS-Kontingentzeitraums. Der Standardwert ist "100 ms". Gültige Werte sind eine Sequenz von Dezimalzahlen mit einem optionalen Bruch und einem Einheitensuffix. Beispiel: '300ms', '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, kann das Kubelet nicht gestartet werden, wenn der Austausch auf dem Knoten aktiviert ist.
imageGcHighThreshold	integer	Der Prozentsatz der Datenträgerauslastung, nach der die Image-Garbage Collection immer ausgeführt wird. Legen Sie den Wert zum Deaktivieren von Image-Garbage Collection auf 100 fest. Der Standardwert ist 85 %.
imageGcLowThreshold	integer	Der Prozentsatz der Datenträgerauslastung, vor der die Image-Garbage Collection nie ausgeführt wird. Dies kann nicht höher als imageGcHighThreshold festgelegt werden. Der Standardwert ist 80 %.
podMaxPids	integer	Die maximale Anzahl von Prozessen pro Pod.
topologyManagerPolicy	string	Die zu verwendende Topologie-Manager-Richtlinie. Weitere Informationen finden Sie unter Kubernetes-Topologie-Manager. Der Standardwert ist "none". Zulässige Werte sind "none", "best-effort", "restricted" und "single-numa-node".

KubeletDiskType

Bestimmt die Platzierung von emptyDir-Volumes, Containerruntime-Datenstamm und kurzlebigem Kubelet-Speicher.

Name	Typ	Beschreibung
OS	string	Kubelet verwendet den Betriebssystemdatenträger für seine Daten.
Temporary	string	Kubelet verwendet den temporären Datenträger für seine Daten.

LinuxOSConfig

Betriebssystemkonfigurationen von Linux-Agent-Knoten.

Name	Typ	Beschreibung
swapFileSizeMB	integer	Die Größe einer Auslagerungsdatei in MB, die auf jedem Knoten erstellt wird.
sysctls	SysctlConfig	Sysctl-Einstellungen für Linux-Agent-Knoten.
transparentHugePageDefrag	string	Gibt an, ob der Kernel die Speicherkomprimierung aggressiv nutzen sollte, um mehr riesige Seiten verfügbar zu machen. 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.

OSDiskType

Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.

Name	Typ	Beschreibung
Ephemeral	string	Kurzlebige Betriebssystemdatenträger werden wie ein temporärer Datenträger nur auf dem Hostcomputer gespeichert. Dies führt zu einer geringeren Wartezeit bei Lese-/Schreibvorgängen und ermöglicht eine schnellere Knotenskalierung sowie schnellere Clusterupgrades.
Managed	string	Azure repliziert den Betriebssystemdatenträger für einen virtuellen Computer in Azure Storage, um Datenverluste zu vermeiden, wenn der virtuelle Computer 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, bietet jedoch einige Nachteile, z. B. eine langsamere Knotenbereitstellung und eine höhere Lese-/Schreiblatenz.

OSSKU

Gibt die betriebssystem-SKU an, die vom Agentpool verwendet wird. 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.

Name	Typ	Beschreibung
AzureLinux	string	Verwenden Sie AzureLinux als Betriebssystem für Knotenimages. Azure Linux ist eine containeroptimierte Linux-Distribution, die von Microsoft erstellt wurde. Weitere Informationen finden Sie unter https://aka.ms/azurelinux .
CBLMariner	string	Veraltete OSSKU. Microsoft empfiehlt, dass neue Bereitstellungen stattdessen "AzureLinux" auswählen.
Ubuntu	string	Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
Windows2019	string	Verwenden Sie Windows2019 als Betriebssystem für Knotenimages. Für Systemknotenpools nicht unterstützt. Windows2019 unterstützt nur Windows2019-Container. Windows2022-Container können nicht ausgeführt werden und umgekehrt.
Windows2022	string	Verwenden Sie Windows2022 als Betriebssystem für Knotenimages. Für Systemknotenpools nicht unterstützt. Windows2022 unterstützt nur Windows2022-Container. Windows2019-Container können nicht ausgeführt werden und umgekehrt.

OSType

Der Betriebssystemtyp. Der Standardwert ist Linux.

Name	Typ	Beschreibung
Linux	string	Verwenden Sie Linux.
Windows	string	Verwenden Sie Windows.

PortRange

Der Portbereich.

Name	Typ	Beschreibung
portEnd	integer	Der maximale Port, der im Bereich enthalten ist. Sie sollte zwischen 1 und 65535 liegen und größer oder gleich portStart sein.
portStart	integer	Der Mindestport, der im Bereich enthalten ist. Sie sollte zwischen 1 und 65535 liegen und kleiner oder gleich portEnd sein.
protocol	Protocol	Das Netzwerkprotokoll des Ports.

PowerState

Beschreibt den Energiezustand des Clusters.

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

Protocol

Das Netzwerkprotokoll des Ports.

Name	Typ	Beschreibung
TCP	string	TCP-Protokoll.
UDP	string	UDP-Protokoll.

ScaleDownMode

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

Name	Typ	Beschreibung
Deallocate	string	Versuchen Sie, die Zuordnung aufgehobener Instanzen (sofern vorhanden) beim Hochskalieren und Aufheben der Zuordnung von Instanzen während des Herunterskalierens zu starten.
Delete	string	Erstellen Sie während des Hochskalierens neue Instanzen, und entfernen Sie Instanzen während des Herunterskalierens.

ScaleSetEvictionPolicy

Die Richtlinie zum Entfernen der VM-Skalierungsgruppe.

Name	Typ	Beschreibung
Deallocate	string	Knoten in der zugrunde liegenden Skalierungsgruppe des Knotenpools werden beim Entfernen auf den Status beendet-zuordnung festgelegt. Knoten im Zustand „Beendet/Zuordnung aufgehoben“ werden auf Ihr Computekontingent angerechnet und können Probleme bei der Skalierung oder dem Upgrade von Clustern verursachen.
Delete	string	Knoten in der zugrunde liegenden Skalierungsgruppe des Knotenpools werden gelöscht, wenn sie entfernt werden.

ScaleSetPriority

Die Priorität der VM-Skalierungsgruppe.

Name	Typ	Beschreibung
Regular	string	Reguläre VMs werden verwendet.
Spot	string	VMs mit Spotpriorität werden verwendet. Es gibt keine SLA für Spotknoten. Weitere Informationen finden Sie unter spot on AKS .

SysctlConfig

Sysctl-Einstellungen für Linux-Agent-Knoten.

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

WorkloadRuntime

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

Name	Typ	Beschreibung
OCIContainer	string	Knoten verwenden Kubelet zum Ausführen von OCI-Standardcontainerworkloads.
WasmWasi	string	Knoten verwenden Krustlet zum Ausführen von WASM-Workloads mithilfe des WASI-Anbieters (Vorschau).

Agent Pools - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Get Agent Pool

Sample Request

Sample Response

Definitionen

AgentPool

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUInstanceProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

OSDiskType

OSSKU

OSType

PortRange

PowerState

Protocol

ScaleDownMode

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

WorkloadRuntime

Zusätzliche Ressourcen