Agent Pools - Get

Referenz

Dienst:: AKS

API-Version:: 2024-09-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=2024-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
agentPoolName	path	True	string	Der Name des Agentpools. RegEx-Muster: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der verwalteten Clusterressource. RegEx-Muster: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AgentPool	OKAY
Other Status Codes	CloudError	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=2024-09-01


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

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

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


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

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


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

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

package armcontainerservice_test

import (
	"context"
	"log"

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

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

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

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

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

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

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	Agentpool.
AgentPoolMode	Der Modus eines Agentpools.
AgentPoolNetworkProfile	Netzwerkeinstellungen eines Agentpools.
AgentPoolSecurityProfile	Die Sicherheitseinstellungen eines Agentpools.
AgentPoolType	Der Typ des Agentpools.
AgentPoolUpgradeSettings	Einstellungen für das Upgrade eines Agentpools
AgentPoolWindowsProfile	Das spezifische Profil des Windows-Agentpools.
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
code	Gibt an, ob der Cluster ausgeführt oder beendet wird.
CreationData	Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
GPUInstanceProfile	GPUInstanceProfile, das zum Angeben des GPU-MIG-Instanzprofils 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, Containerlaufzeitdatenstamm und Kubelet-Kurzspeicher.
LinuxOSConfig	Betriebssystemkonfigurationen von Linux-Agentknoten.
OSDiskType	Der Betriebssystemdatenträgertyp, der für Computer im Agentpool verwendet werden soll.
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.
PortRange	Der Portbereich.
PowerState	Beschreibt den Power State des Clusters.
Protocol	Das Netzwerkprotokoll des Ports.
ScaleDownMode	Beschreibt, wie VMs zu Agentpools hinzugefügt oder aus diesen entfernt werden. Siehe Abrechnungsstatus.
ScaleSetEvictionPolicy	Die Richtlinie für die Skalierungsgruppe des virtuellen Computers.
ScaleSetPriority	Priorität des Skalierungssatzes für virtuelle Computer.
SysctlConfig	Sysctl-Einstellungen für Linux-Agentknoten.
WorkloadRuntime	Bestimmt den Typ der Workload, die ein Knoten ausführen kann.

AgentPool

Agentpool.

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 virtueller Computer 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 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 eine optimistische Parallelität gemäß der normalen etag-Konvention zu ermöglichen.
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.gpuInstanceProfile	GPUInstanceProfile		GPUInstanceProfile, das zum Angeben des GPU-MIG-Instanzprofils für unterstützte GPU-VM-SKU verwendet werden soll.
properties.hostGroupID	string		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		Kubelet-Konfigurationen von Agentknoten. Die Kubelet-Konfiguration auf den Agentpoolknoten.
properties.kubeletDiskType	KubeletDiskType		Bestimmt die Platzierung von emptyDir-Volumes, Containerlaufzeitdatenstamm und Kubelet-Kurzspeicher.
properties.linuxOSConfig	LinuxOSConfig		Betriebssystemkonfigurationen von Linux-Agentknoten. Die Betriebssystemkonfiguration von Linux-Agentknoten.
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 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		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		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.podSubnetID	string		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		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.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.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		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

AgentPoolMode

Der Modus eines Agentpools.

Name	Typ	Beschreibung
System	string	System-Agent-Pools dienen in erster Linie zum Hosten kritischer System pods wie CoreDNS und Metrikserver. 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	string	Benutzer-Agent-Pools dienen in erster Linie zum Hosten Ihrer Anwendungs pods.

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 Instanzebene.

AgentPoolSecurityProfile

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".

AgentPoolType

Der Typ des Agentpools.

Name	Typ	Beschreibung
AvailabilitySet	string	Die Verwendung dieses Vorgangs wird dringend abgeraten.
VirtualMachineScaleSets	string	Erstellen Sie einen Agentpool, der von einem Skalierungssatz für virtuelle Computer unterstützt wird.

AgentPoolUpgradeSettings

Einstellungen für das Upgrade eines Agentpools

Name	Typ	Beschreibung
drainTimeoutInMinutes	integer	Timeout für den Abfluss 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. Wenn nicht angegeben, beträgt 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 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 1. 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 Einweichdauer 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.

AgentPoolWindowsProfile

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.

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 sollen programmgesteuert genutzt 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 ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

code

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

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

KubeletConfig

Kubelet-Konfigurationen von Agentknoten.

Name	Typ	Beschreibung
allowedUnsafeSysctls	string[]	Liste zulässiger unsicherer Sysctls oder unsicherer Sysctl-Muster (endend in `*`).
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 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	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	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	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

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

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-Agentknoten.

Name	Typ	Beschreibung
swapFileSizeMB	integer	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.

OSDiskType

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

Name	Typ	Beschreibung
Ephemeral	string	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.
Managed	string	Azure repliziert den Betriebssystemdatenträger für einen virtuellen Computer in Azure Storage, um Datenverluste zu vermeiden, wenn 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.

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.

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, besuchen Sie https://aka.ms/azurelinux, um weitere Informationen zu finden.
CBLMariner	string	Veraltete OSSKU. Microsoft empfiehlt, stattdessen neue Bereitstellungen "AzureLinux" auszuwählen.
Ubuntu	string	Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
Windows2019	string	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	string	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

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. Er sollte zwischen 1 und 65535 liegen und größer als oder gleich PortStart sein.
portStart	integer	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

Beschreibt den Power State des Clusters.

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

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 aus diesen entfernt werden. Siehe Abrechnungsstatus.

Name	Typ	Beschreibung
Deallocate	string	Versuchen Sie, deallocated Instances (sofern vorhanden) während der Skalierung zu starten und Instanzen während der Skalierung nach unten zu ordnen.
Delete	string	Erstellen Sie während der Skalierung neue Instanzen, und entfernen Sie Instanzen während der Skalierung nach unten.

ScaleSetEvictionPolicy

Die Richtlinie für die Skalierungsgruppe des virtuellen Computers.

Name	Typ	Beschreibung
Deallocate	string	Knoten im zugrunde liegenden Skalierungssatz des Knotenpools werden bei Derentlassung auf den Zustand "beendeter Deallocated" festgelegt. Knoten im Zustand "Beendete Zuordnung" zählen zu Ihrem Computekontingent und können Probleme mit der Clusterskalierung oder einem Upgrade verursachen.
Delete	string	Knoten im zugrunde liegenden Skalierungssatz des Knotenpools werden gelöscht, wenn sie entfernt werden.

ScaleSetPriority

Priorität des Skalierungssatzes für virtuelle Computer.

Name	Typ	Beschreibung
Regular	string	Normale virtuelle Computer werden verwendet.
Spot	string	VMs mit Spotpriorität werden verwendet. Für Spotknoten ist kein SLA vorhanden. Weitere Informationen finden Sie unter Spot auf AKS.

SysctlConfig

Sysctl-Einstellungen für Linux-Agentknoten.

Name	Typ	Beschreibung
fsAioMaxNr	integer	Sysctl setting fs.aio-max-nr.
fsFileMax	integer	Sysctl setting fs.file-max.
fsInotifyMaxUserWatches	integer	Sysctl-Einstellung fs.inotify.max_user_watches.
fsNrOpen	integer	Sysctl-Einstellung fs.nr_open.
kernelThreadsMax	integer	Sysctl setting 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 setting 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 standardmäßiger OCI-Containerarbeitslasten.
WasmWasi	string	Knoten verwenden Krustlet zum Ausführen von WASM-Workloads mithilfe des WASI-Anbieters (Vorschau).

Freigeben über

Agent Pools - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get Agent Pool

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AgentPool

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUInstanceProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

OSDiskType

OSSKU

OSType

PortRange

PowerState

Protocol

ScaleDownMode

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

WorkloadRuntime

Zusätzliche Ressourcen