Agent Pools - Get
Hämtar den angivna hanterade klusteragentpoolen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2024-09-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
agent
|
path | True |
string |
Namnet på agentpoolen. Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
resource
|
path | True |
string |
Namnet på den hanterade klusterresursen. Reguljärt uttrycksmönster: |
subscription
|
path | True |
string uuid |
ID för målprenumerationen. Värdet måste vara ett UUID. |
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OKEJ |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Get Agent Pool
Exempelbegäran
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
Exempelsvar
{
"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%"
}
}
}
Definitioner
Name | Description |
---|---|
Agent |
Agentpool. |
Agent |
Läget för en agentpool. |
Agent |
Nätverksinställningar för en agentpool. |
Agent |
Säkerhetsinställningarna för en agentpool. |
Agent |
Typ av agentpool. |
Agent |
Inställningar för att uppgradera en agentpool |
Agent |
Windows-agentpoolens specifika profil. |
Cloud |
Ett felsvar från containertjänsten. |
Cloud |
Ett felsvar från containertjänsten. |
code |
Anger om klustret körs eller stoppas |
Creation |
Data som används när du skapar en målresurs från en källresurs. |
GPUInstance |
GPUInstanceProfile som ska användas för att ange GPU MIG-instansprofil för GPU VM SKU som stöds. |
IPTag |
Innehåller DEN IPTag som är associerad med objektet. |
Kubelet |
Kubelet-konfigurationer av agentnoder. |
Kubelet |
Avgör placeringen av emptyDir-volymer, containerkörningsdatarot och tillfällig Kubelet-lagring. |
Linux |
OS-konfigurationer av Linux-agentnoder. |
OSDisk |
Den operativsystemdisktyp som ska användas för datorer i agentpoolen. |
OSSKU |
Anger os-SKU:n som används av agentpoolen. Standardvärdet är Ubuntu om OSType är Linux. Standardvärdet är Windows2019 när Kubernetes <= 1.24 eller Windows2022 när Kubernetes >= 1,25 om OSType är Windows. |
OSType |
Typ av operativsystem. Standardvärdet är Linux. |
Port |
Portintervallet. |
Power |
Beskriver klustrets energitillstånd |
Protocol |
Portens nätverksprotokoll. |
Scale |
Beskriver hur virtuella datorer läggs till eller tas bort från agentpooler. Se faktureringstillstånd. |
Scale |
Borttagningsprincipen för vm-skalningsuppsättning. |
Scale |
Prioritet för VM-skalningsuppsättning. |
Sysctl |
Sysctl-inställningar för Linux-agentnoder. |
Workload |
Avgör vilken typ av arbetsbelastning en nod kan köra. |
AgentPool
Agentpool.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Resurs-ID. |
|
name |
string |
Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen. |
|
properties.availabilityZones |
string[] |
Listan över tillgänglighetszoner som ska användas för noder. Detta kan bara anges om egenskapen AgentPoolType är "VirtualMachineScaleSets". |
|
properties.capacityReservationGroupID |
string |
Det fullständigt kvalificerade resurs-ID:t för kapacitetsreservationsgruppen för att tillhandahålla virtuella datorer från en reserverad grupp med virtuella datorer. |
|
properties.count |
integer |
Antal agenter (VIRTUELLA datorer) som ska vara värdar för Docker-containrar. Tillåtna värden måste ligga mellan 0 och 1 000 (inklusive) för användarpooler och i intervallet 1 till 1 000 (inklusive) för systempooler. Standardvärdet är 1. |
|
properties.creationData |
CreationData som ska användas för att ange källans ögonblicksbilds-ID om nodpoolen ska skapas/uppgraderas med hjälp av en ögonblicksbild. |
||
properties.currentOrchestratorVersion |
string |
Versionen av Kubernetes som agentpoolen körs. |
|
properties.eTag |
string |
Unik skrivskyddad sträng som används för att implementera optimistisk samtidighet. ETag-värdet ändras när resursen uppdateras. Ange ett if-match- eller if-none-match-huvud med eTag-värdet för en efterföljande begäran för att aktivera optimistisk samtidighet enligt den normala etag-konventionen. |
|
properties.enableAutoScaling |
boolean |
Om du vill aktivera automatisk skalning |
|
properties.enableEncryptionAtHost |
boolean |
Om värdbaserad os- och dataenhetskryptering ska aktiveras. |
|
properties.enableFIPS |
boolean |
Om du vill använda ett FIPS-aktiverat operativsystem. |
|
properties.enableNodePublicIP |
boolean |
Om varje nod allokeras sin egen offentliga IP-adress. |
|
properties.enableUltraSSD |
boolean |
Om du vill aktivera UltraSSD |
|
properties.gpuInstanceProfile |
GPUInstanceProfile som ska användas för att ange GPU MIG-instansprofil för GPU VM SKU som stöds. |
||
properties.hostGroupID |
string |
Det fullständigt kvalificerade resurs-ID:t för den dedikerade värdgruppen som ska etablera virtuella datorer från, som endast används i skapandescenariot och som inte tillåts ändras en gång. |
|
properties.kubeletConfig |
Kubelet-konfigurationer av agentnoder. |
||
properties.kubeletDiskType |
Avgör placeringen av emptyDir-volymer, containerkörningsdatarot och tillfällig Kubelet-lagring. |
||
properties.linuxOSConfig |
OS-konfigurationer av Linux-agentnoder. |
||
properties.maxCount |
integer |
Maximalt antal noder för automatisk skalning |
|
properties.maxPods |
integer |
Det maximala antalet poddar som kan köras på en nod. |
|
properties.minCount |
integer |
Det minsta antalet noder för automatisk skalning |
|
properties.mode |
Läget för en agentpool. |
||
properties.networkProfile |
Nätverksrelaterade inställningar för en agentpool. |
||
properties.nodeImageVersion |
string |
Version av nodbild |
|
properties.nodeLabels |
object |
Nodetiketterna som ska bevaras över alla noder i agentpoolen. |
|
properties.nodePublicIPPrefixID |
string |
Det offentliga IP-prefix-ID som vm-noder ska använda IP-adresser från. |
|
properties.nodeTaints |
string[] |
Tainterna som har lagts till i nya noder när nodpoolen skapas och skalas. Till exempel key=value:NoSchedule. |
|
properties.orchestratorVersion |
string |
Den version av Kubernetes som angetts av användaren. |
|
properties.osDiskSizeGB |
integer |
Operativsystemets diskstorlek i GB som ska användas för att ange diskstorleken för varje dator i huvud-/agentpoolen. Om du anger 0 tillämpas standardstorleken för osDisk enligt den angivna vmSize-storleken. |
|
properties.osDiskType |
Den operativsystemdisktyp som ska användas för datorer i agentpoolen. |
||
properties.osSKU |
Anger os-SKU:n som används av agentpoolen. Standardvärdet är Ubuntu om OSType är Linux. Standardvärdet är Windows2019 när Kubernetes <= 1.24 eller Windows2022 när Kubernetes >= 1,25 om OSType är Windows. |
||
properties.osType | Linux |
Typ av operativsystem. Standardvärdet är Linux. |
|
properties.podSubnetID |
string |
ID för det undernät som poddar ansluter till när de startas. |
|
properties.powerState |
Om agentpoolen körs eller stoppas. |
||
properties.provisioningState |
string |
Det aktuella distributions- eller etableringstillståndet. |
|
properties.proximityPlacementGroupID |
string |
ID för närhetsplaceringsgrupp. |
|
properties.scaleDownMode |
Nedskalningsläget som ska användas vid skalning av agentpoolen. |
||
properties.scaleSetEvictionPolicy | Delete |
Den borttagningsprincip för vm-skalningsuppsättning som ska användas. |
|
properties.scaleSetPriority | Regular |
Prioritet för VM-skalningsuppsättning. Om det inte anges är standardvärdet "Vanlig". |
|
properties.securityProfile |
Säkerhetsinställningarna för en agentpool. |
||
properties.spotMaxPrice |
number |
-1 |
Det högsta priset (i us-dollar) som du är villig att betala för spot-instanser. Möjliga värden är ett decimalvärde som är större än noll eller -1 vilket anger att standardpriset är up-to på begäran. |
properties.tags |
object |
Taggarna som ska sparas på vm-skalningsuppsättningen för agentpoolen. |
|
properties.type |
Typ av agentpool. |
||
properties.upgradeSettings |
Inställningar för att uppgradera agentpoolen |
||
properties.vmSize |
string |
Storleken på de virtuella datorerna i agentpoolen. |
|
properties.vnetSubnetID |
string |
ID:t för undernätet som agentpoolnoder och eventuellt poddar ansluter till vid start. |
|
properties.windowsProfile |
Windows-agentpoolens specifika profil. |
||
properties.workloadRuntime |
Avgör vilken typ av arbetsbelastning en nod kan köra. |
||
type |
string |
Resurstyp |
AgentPoolMode
Läget för en agentpool.
Name | Typ | Description |
---|---|---|
System |
string |
Systemagentpooler är främst till för att hantera kritiska systempoddar som CoreDNS och metrics-server. Systemagentpooler osType måste vara Linux. Systemagentpooler VM SKU måste ha minst 2vCPU:er och 4 GB minne. |
User |
string |
Användaragentpooler är främst till för att vara värd för dina programpoddar. |
AgentPoolNetworkProfile
Nätverksinställningar för en agentpool.
Name | Typ | Description |
---|---|---|
allowedHostPorts |
De portintervall som tillåts komma åt. De angivna intervallen får överlappa varandra. |
|
applicationSecurityGroups |
string[] |
ID:t för de programsäkerhetsgrupper som agentpoolen associerar när de skapas. |
nodePublicIPTags |
IPTag[] |
IPTags för offentliga IP-adresser på instansnivå. |
AgentPoolSecurityProfile
Säkerhetsinställningarna för en agentpool.
Name | Typ | Description |
---|---|---|
enableSecureBoot |
boolean |
Säker start är en funktion i Trusted Launch som säkerställer att endast signerade operativsystem och drivrutiner kan starta. Mer information finns i aka.ms/aks/trustedlaunch. Om det inte anges är standardvärdet falskt. |
enableVTPM |
boolean |
vTPM är en betrodd startfunktion för att konfigurera ett dedikerat säkert valv för nycklar och mått som lagras lokalt på noden. Mer information finns i aka.ms/aks/trustedlaunch. Om det inte anges är standardvärdet falskt. |
AgentPoolType
Typ av agentpool.
Name | Typ | Description |
---|---|---|
AvailabilitySet |
string |
Användning av detta rekommenderas starkt. |
VirtualMachineScaleSets |
string |
Skapa en agentpool som backas upp av en VM-skalningsuppsättning. |
AgentPoolUpgradeSettings
Inställningar för att uppgradera en agentpool
Name | Typ | Description |
---|---|---|
drainTimeoutInMinutes |
integer |
Tidsgränsen för tömning för en nod |
maxSurge |
string |
Det maximala antalet eller procentandelen noder som ökar under uppgraderingen. |
nodeSoakDurationInMinutes |
integer |
Den blöta varaktigheten för en nod |
AgentPoolWindowsProfile
Windows-agentpoolens specifika profil.
Name | Typ | Description |
---|---|---|
disableOutboundNat |
boolean |
Om du vill inaktivera OutboundNAT i Windows-noder |
CloudError
Ett felsvar från containertjänsten.
Name | Typ | Description |
---|---|---|
error |
Information om felet. |
CloudErrorBody
Ett felsvar från containertjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
details |
En lista med ytterligare information om felet. |
|
message |
string |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
target |
string |
Målet för det specifika felet. Till exempel namnet på egenskapen i fel. |
code
Anger om klustret körs eller stoppas
Name | Typ | Description |
---|---|---|
Running |
string |
Klustret körs. |
Stopped |
string |
Klustret stoppas. |
CreationData
Data som används när du skapar en målresurs från en källresurs.
Name | Typ | Description |
---|---|---|
sourceResourceId |
string |
Det här är ARM-ID:t för källobjektet som ska användas för att skapa målobjektet. |
GPUInstanceProfile
GPUInstanceProfile som ska användas för att ange GPU MIG-instansprofil för GPU VM SKU som stöds.
Name | Typ | Description |
---|---|---|
MIG1g |
string |
|
MIG2g |
string |
|
MIG3g |
string |
|
MIG4g |
string |
|
MIG7g |
string |
IPTag
Innehåller DEN IPTag som är associerad med objektet.
Name | Typ | Description |
---|---|---|
ipTagType |
string |
Typ av IP-tagg. Exempel: RoutingPreference. |
tag |
string |
Värdet för IP-taggen som är associerad med den offentliga IP-adressen. Exempel: Internet. |
KubeletConfig
Kubelet-konfigurationer av agentnoder.
Name | Typ | Description |
---|---|---|
allowedUnsafeSysctls |
string[] |
Tillåten lista över osäkra sysctls eller osäkra sysctl-mönster (slutar i |
containerLogMaxFiles |
integer |
Det maximala antalet containerloggfiler som kan finnas för en container. Talet måste vara ≥ 2. |
containerLogMaxSizeMB |
integer |
Maximal storlek (t.ex. 10Mi) för containerloggfilen innan den roteras. |
cpuCfsQuota |
boolean |
Om CPU CFS-kvottillämpning är aktiverat för containrar som anger CPU-gränser. |
cpuCfsQuotaPeriod |
string |
Värdet för CPU CFS-kvotperiod. |
cpuManagerPolicy |
string |
Cpu Manager-principen som ska användas. |
failSwapOn |
boolean |
Om värdet är sant kommer Kubelet inte att starta om växlingen är aktiverad på noden. |
imageGcHighThreshold |
integer |
Den procent av diskanvändningen varefter skräpinsamling av avbildningar alltid körs. |
imageGcLowThreshold |
integer |
Den procent av diskanvändningen innan avbildningens skräpinsamling aldrig körs. |
podMaxPids |
integer |
Maximalt antal processer per podd. |
topologyManagerPolicy |
string |
Topologihanterarens princip som ska användas. |
KubeletDiskType
Avgör placeringen av emptyDir-volymer, containerkörningsdatarot och tillfällig Kubelet-lagring.
Name | Typ | Description |
---|---|---|
OS |
string |
Kubelet använder OS-disken för sina data. |
Temporary |
string |
Kubelet använder den tillfälliga disken för sina data. |
LinuxOSConfig
OS-konfigurationer av Linux-agentnoder.
Name | Typ | Description |
---|---|---|
swapFileSizeMB |
integer |
Storleken i MB för en växlingsfil som skapas på varje nod. |
sysctls |
Sysctl-inställningar för Linux-agentnoder. |
|
transparentHugePageDefrag |
string |
Om kerneln ska använda minneskomprimering aggressivt för att göra fler stora sidor tillgängliga. |
transparentHugePageEnabled |
string |
Om transparenta enorma sidor är aktiverade. |
OSDiskType
Den operativsystemdisktyp som ska användas för datorer i agentpoolen.
Name | Typ | Description |
---|---|---|
Ephemeral |
string |
Tillfälliga OS-diskar lagras bara på värddatorn, precis som en tillfällig disk. Detta ger lägre svarstid för läsning/skrivning, tillsammans med snabbare nodskalning och klusteruppgraderingar. |
Managed |
string |
Azure replikerar operativsystemdisken för en virtuell dator till Azure Storage för att undvika dataförlust om den virtuella datorn behöver flyttas till en annan värd. Eftersom containrar inte är utformade för att ha kvar lokalt tillstånd ger det här beteendet ett begränsat värde samtidigt som vissa nackdelar, inklusive långsammare nodetablering och högre svarstid för läsning/skrivning. |
OSSKU
Anger os-SKU:n som används av agentpoolen. Standardvärdet är Ubuntu om OSType är Linux. Standardvärdet är Windows2019 när Kubernetes <= 1.24 eller Windows2022 när Kubernetes >= 1,25 om OSType är Windows.
Name | Typ | Description |
---|---|---|
AzureLinux |
string |
Använd AzureLinux som operativsystem för nodavbildningar. Azure Linux är en containeroptimerad Linux-distribution som skapats av Microsoft, besök https://aka.ms/azurelinux för mer information. |
CBLMariner |
string |
Inaktuell OSSKU. Microsoft rekommenderar att nya distributioner väljer "AzureLinux" i stället. |
Ubuntu |
string |
Använd Ubuntu som operativsystem för nodavbildningar. |
Windows2019 |
string |
Använd Windows2019 som operativsystem för nodavbildningar. Stöds inte för systemnodpooler. Windows2019 stöder endast Windows2019-containrar. Det går inte att köra Windows2022-containrar och vice versa. |
Windows2022 |
string |
Använd Windows2022 som operativsystem för nodavbildningar. Stöds inte för systemnodpooler. Windows2022 stöder endast Windows2022-containrar. Det går inte att köra Windows2019-containrar och vice versa. |
OSType
Typ av operativsystem. Standardvärdet är Linux.
Name | Typ | Description |
---|---|---|
Linux |
string |
Använd Linux. |
Windows |
string |
Använd Windows. |
PortRange
Portintervallet.
Name | Typ | Description |
---|---|---|
portEnd |
integer |
Den maximala port som ingår i intervallet. Den bör vara mellan 1 och 65535 och vara större än eller lika med portStart. |
portStart |
integer |
Den minsta port som ingår i intervallet. Den bör vara mellan 1 och 65535 och vara mindre än eller lika med portEnd. |
protocol |
Portens nätverksprotokoll. |
PowerState
Beskriver klustrets energitillstånd
Name | Typ | Description |
---|---|---|
code |
Anger om klustret körs eller stoppas |
Protocol
Portens nätverksprotokoll.
Name | Typ | Description |
---|---|---|
TCP |
string |
TCP-protokoll. |
UDP |
string |
UDP-protokoll. |
ScaleDownMode
Beskriver hur virtuella datorer läggs till eller tas bort från agentpooler. Se faktureringstillstånd.
Name | Typ | Description |
---|---|---|
Deallocate |
string |
Försök att starta frigjorda instanser (om de finns) under uppskalning och frigöra instanser under nedskalning. |
Delete |
string |
Skapa nya instanser under uppskalning och ta bort instanser under nedskalning. |
ScaleSetEvictionPolicy
Borttagningsprincipen för vm-skalningsuppsättning.
Name | Typ | Description |
---|---|---|
Deallocate |
string |
Noder i den underliggande skalningsuppsättningen för nodpoolen är inställda på tillståndet stoppad frigjord vid borttagning. Noder i det stoppade frigjorda tillståndet räknas mot din beräkningskvot och kan orsaka problem med klusterskalning eller uppgradering. |
Delete |
string |
Noder i den underliggande skalningsuppsättningen för nodpoolen tas bort när de avlägsnas. |
ScaleSetPriority
Prioritet för VM-skalningsuppsättning.
Name | Typ | Description |
---|---|---|
Regular |
string |
Vanliga virtuella datorer används. |
Spot |
string |
Virtuella datorer med platsprioritet används. Det finns inget serviceavtal för skalningsnoder för oanvänd kapacitet. Mer information finns i plats på AKS-. |
SysctlConfig
Sysctl-inställningar för Linux-agentnoder.
Name | Typ | Description |
---|---|---|
fsAioMaxNr |
integer |
Sysctl-inställning fs.aio-max-nr. |
fsFileMax |
integer |
Sysctl-inställning fs.file-max. |
fsInotifyMaxUserWatches |
integer |
Sysctl-inställning fs.inotify.max_user_watches. |
fsNrOpen |
integer |
Sysctl-inställning fs.nr_open. |
kernelThreadsMax |
integer |
Sysctl-inställning kernel.threads-max. |
netCoreNetdevMaxBacklog |
integer |
Sysctl-inställning net.core.netdev_max_backlog. |
netCoreOptmemMax |
integer |
Sysctl-inställning net.core.optmem_max. |
netCoreRmemDefault |
integer |
Sysctl-inställning net.core.rmem_default. |
netCoreRmemMax |
integer |
Sysctl-inställning net.core.rmem_max. |
netCoreSomaxconn |
integer |
Sysctl-inställning net.core.somaxconn. |
netCoreWmemDefault |
integer |
Sysctl-inställning net.core.wmem_default. |
netCoreWmemMax |
integer |
Sysctl-inställning net.core.wmem_max. |
netIpv4IpLocalPortRange |
string |
Sysctl-inställning net.ipv4.ip_local_port_range. |
netIpv4NeighDefaultGcThresh1 |
integer |
Sysctl-inställning net.ipv4.neigh.default.gc_thresh1. |
netIpv4NeighDefaultGcThresh2 |
integer |
Sysctl-inställning net.ipv4.neigh.default.gc_thresh2. |
netIpv4NeighDefaultGcThresh3 |
integer |
Sysctl-inställning net.ipv4.neigh.default.gc_thresh3. |
netIpv4TcpFinTimeout |
integer |
Sysctl-inställning net.ipv4.tcp_fin_timeout. |
netIpv4TcpKeepaliveProbes |
integer |
Sysctl-inställning net.ipv4.tcp_keepalive_probes. |
netIpv4TcpKeepaliveTime |
integer |
Sysctl-inställning net.ipv4.tcp_keepalive_time. |
netIpv4TcpMaxSynBacklog |
integer |
Sysctl-inställning net.ipv4.tcp_max_syn_backlog. |
netIpv4TcpMaxTwBuckets |
integer |
Sysctl-inställning net.ipv4.tcp_max_tw_buckets. |
netIpv4TcpTwReuse |
boolean |
Sysctl-inställning net.ipv4.tcp_tw_reuse. |
netIpv4TcpkeepaliveIntvl |
integer |
Sysctl-inställning net.ipv4.tcp_keepalive_intvl. |
netNetfilterNfConntrackBuckets |
integer |
Sysctl-inställning net.netfilter.nf_conntrack_buckets. |
netNetfilterNfConntrackMax |
integer |
Sysctl-inställning net.netfilter.nf_conntrack_max. |
vmMaxMapCount |
integer |
Sysctl-inställning vm.max_map_count. |
vmSwappiness |
integer |
Sysctl-inställning vm.swappiness. |
vmVfsCachePressure |
integer |
Sysctl-inställning vm.vfs_cache_pressure. |
WorkloadRuntime
Avgör vilken typ av arbetsbelastning en nod kan köra.
Name | Typ | Description |
---|---|---|
OCIContainer |
string |
Noder använder Kubelet för att köra standardarbetsbelastningar för OCI-container. |
WasmWasi |
string |
Noder använder Krustlet för att köra WASM-arbetsbelastningar med WASI-providern (förhandsversion). |