containerservice.azure.com/v1api20230201
containerservice.azure.com/v1api20230201
Package v1api20230201 contains API Schema definitions for the containerservice v1api20230201 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2023-02-01" |
AgentPoolMode
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"System" |
|
"User" |
AgentPoolMode_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"System" |
|
"User" |
AgentPoolType
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"AvailabilitySet" |
|
"VirtualMachineScaleSets" |
AgentPoolType_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"AvailabilitySet" |
|
"VirtualMachineScaleSets" |
AgentPoolUpgradeSettings
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Field | Description |
---|---|
maxSurge string |
AgentPoolUpgradeSettings_STATUS
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Field | Description |
---|---|
maxSurge string |
AzureKeyVaultKms
(Appears on:ManagedClusterSecurityProfile)
Field | Description |
---|---|
enabled bool |
|
keyId string |
|
keyVaultNetworkAccess AzureKeyVaultKms_KeyVaultNetworkAccess |
|
keyVaultResourceReference genruntime.ResourceReference |
AzureKeyVaultKms_KeyVaultNetworkAccess
(string
alias)
(Appears on:AzureKeyVaultKms)
Value | Description |
---|---|
"Private" |
|
"Public" |
AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS
(string
alias)
(Appears on:AzureKeyVaultKms_STATUS)
Value | Description |
---|---|
"Private" |
|
"Public" |
AzureKeyVaultKms_STATUS
(Appears on:ManagedClusterSecurityProfile_STATUS)
Field | Description |
---|---|
enabled bool |
|
keyId string |
|
keyVaultNetworkAccess AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS |
|
keyVaultResourceId string |
ContainerServiceLinuxProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
adminUsername string |
|
ssh ContainerServiceSshConfiguration |
ContainerServiceLinuxProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
adminUsername string |
|
ssh ContainerServiceSshConfiguration_STATUS |
ContainerServiceNetworkProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
dnsServiceIP string |
|
dockerBridgeCidr string |
|
ipFamilies []ContainerServiceNetworkProfile_IpFamilies |
|
loadBalancerProfile ManagedClusterLoadBalancerProfile |
|
loadBalancerSku ContainerServiceNetworkProfile_LoadBalancerSku |
|
natGatewayProfile ManagedClusterNATGatewayProfile |
|
networkDataplane ContainerServiceNetworkProfile_NetworkDataplane |
|
networkMode ContainerServiceNetworkProfile_NetworkMode |
|
networkPlugin ContainerServiceNetworkProfile_NetworkPlugin |
|
networkPluginMode ContainerServiceNetworkProfile_NetworkPluginMode |
|
networkPolicy ContainerServiceNetworkProfile_NetworkPolicy |
|
outboundType ContainerServiceNetworkProfile_OutboundType |
|
podCidr string |
|
podCidrs []string |
|
serviceCidr string |
|
serviceCidrs []string |
ContainerServiceNetworkProfile_IpFamilies
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"IPv4" |
|
"IPv6" |
ContainerServiceNetworkProfile_IpFamilies_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"IPv4" |
|
"IPv6" |
ContainerServiceNetworkProfile_LoadBalancerSku
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"basic" |
|
"standard" |
ContainerServiceNetworkProfile_LoadBalancerSku_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"basic" |
|
"standard" |
ContainerServiceNetworkProfile_NetworkDataplane
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"azure" |
|
"cilium" |
ContainerServiceNetworkProfile_NetworkDataplane_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"azure" |
|
"cilium" |
ContainerServiceNetworkProfile_NetworkMode
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"bridge" |
|
"transparent" |
ContainerServiceNetworkProfile_NetworkMode_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"bridge" |
|
"transparent" |
ContainerServiceNetworkProfile_NetworkPlugin
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"azure" |
|
"kubenet" |
|
"none" |
ContainerServiceNetworkProfile_NetworkPluginMode
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"overlay" |
ContainerServiceNetworkProfile_NetworkPluginMode_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"overlay" |
ContainerServiceNetworkProfile_NetworkPlugin_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"azure" |
|
"kubenet" |
|
"none" |
ContainerServiceNetworkProfile_NetworkPolicy
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"azure" |
|
"calico" |
|
"cilium" |
ContainerServiceNetworkProfile_NetworkPolicy_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"azure" |
|
"calico" |
|
"cilium" |
ContainerServiceNetworkProfile_OutboundType
(string
alias)
(Appears on:ContainerServiceNetworkProfile)
Value | Description |
---|---|
"loadBalancer" |
|
"managedNATGateway" |
|
"userAssignedNATGateway" |
|
"userDefinedRouting" |
ContainerServiceNetworkProfile_OutboundType_STATUS
(string
alias)
(Appears on:ContainerServiceNetworkProfile_STATUS)
Value | Description |
---|---|
"loadBalancer" |
|
"managedNATGateway" |
|
"userAssignedNATGateway" |
|
"userDefinedRouting" |
ContainerServiceNetworkProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
dnsServiceIP string |
|
dockerBridgeCidr string |
|
ipFamilies []ContainerServiceNetworkProfile_IpFamilies_STATUS |
|
loadBalancerProfile ManagedClusterLoadBalancerProfile_STATUS |
|
loadBalancerSku ContainerServiceNetworkProfile_LoadBalancerSku_STATUS |
|
natGatewayProfile ManagedClusterNATGatewayProfile_STATUS |
|
networkDataplane ContainerServiceNetworkProfile_NetworkDataplane_STATUS |
|
networkMode ContainerServiceNetworkProfile_NetworkMode_STATUS |
|
networkPlugin ContainerServiceNetworkProfile_NetworkPlugin_STATUS |
|
networkPluginMode ContainerServiceNetworkProfile_NetworkPluginMode_STATUS |
|
networkPolicy ContainerServiceNetworkProfile_NetworkPolicy_STATUS |
|
outboundType ContainerServiceNetworkProfile_OutboundType_STATUS |
|
podCidr string |
|
podCidrs []string |
|
serviceCidr string |
|
serviceCidrs []string |
ContainerServiceOSDisk
(int
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
ContainerServiceSshConfiguration
(Appears on:ContainerServiceLinuxProfile)
Field | Description |
---|---|
publicKeys []ContainerServiceSshPublicKey |
ContainerServiceSshConfiguration_STATUS
(Appears on:ContainerServiceLinuxProfile_STATUS)
Field | Description |
---|---|
publicKeys []ContainerServiceSshPublicKey_STATUS |
ContainerServiceSshPublicKey
(Appears on:ContainerServiceSshConfiguration)
Field | Description |
---|---|
keyData string |
ContainerServiceSshPublicKey_STATUS
(Appears on:ContainerServiceSshConfiguration_STATUS)
Field | Description |
---|---|
keyData string |
CreationData
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Field | Description |
---|---|
sourceResourceReference genruntime.ResourceReference |
CreationData_STATUS
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Field | Description |
---|---|
sourceResourceId string |
ExtendedLocation
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
name string |
|
type ExtendedLocationType |
ExtendedLocationType
(string
alias)
(Appears on:ExtendedLocation)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_STATUS
(string
alias)
(Appears on:ExtendedLocation_STATUS)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocation_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
name string |
|
type ExtendedLocationType_STATUS |
GPUInstanceProfile
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"MIG1g" |
|
"MIG2g" |
|
"MIG3g" |
|
"MIG4g" |
|
"MIG7g" |
GPUInstanceProfile_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"MIG1g" |
|
"MIG2g" |
|
"MIG3g" |
|
"MIG4g" |
|
"MIG7g" |
KubeletConfig
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Field | Description |
---|---|
allowedUnsafeSysctls []string |
|
containerLogMaxFiles int |
|
containerLogMaxSizeMB int |
|
cpuCfsQuota bool |
|
cpuCfsQuotaPeriod string |
|
cpuManagerPolicy string |
|
failSwapOn bool |
|
imageGcHighThreshold int |
|
imageGcLowThreshold int |
|
podMaxPids int |
|
topologyManagerPolicy string |
KubeletConfig_STATUS
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Field | Description |
---|---|
allowedUnsafeSysctls []string |
|
containerLogMaxFiles int |
|
containerLogMaxSizeMB int |
|
cpuCfsQuota bool |
|
cpuCfsQuotaPeriod string |
|
cpuManagerPolicy string |
|
failSwapOn bool |
|
imageGcHighThreshold int |
|
imageGcLowThreshold int |
|
podMaxPids int |
|
topologyManagerPolicy string |
KubeletDiskType
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"OS" |
|
"Temporary" |
KubeletDiskType_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"OS" |
|
"Temporary" |
LinuxOSConfig
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Field | Description |
---|---|
swapFileSizeMB int |
|
sysctls SysctlConfig |
|
transparentHugePageDefrag string |
|
transparentHugePageEnabled string |
LinuxOSConfig_STATUS
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Field | Description |
---|---|
swapFileSizeMB int |
|
sysctls SysctlConfig_STATUS |
|
transparentHugePageDefrag string |
|
transparentHugePageEnabled string |
ManagedCluster
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spec ManagedCluster_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status ManagedCluster_STATUS |
ManagedClusterAADProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
adminGroupObjectIDs []string |
|
clientAppID string |
|
enableAzureRBAC bool |
|
managed bool |
|
serverAppID string |
|
serverAppSecret string |
|
tenantID string |
ManagedClusterAADProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
adminGroupObjectIDs []string |
|
clientAppID string |
|
enableAzureRBAC bool |
|
managed bool |
|
serverAppID string |
|
serverAppSecret string |
|
tenantID string |
ManagedClusterAPIServerAccessProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
authorizedIPRanges []string |
|
disableRunCommand bool |
|
enablePrivateCluster bool |
|
enablePrivateClusterPublicFQDN bool |
|
privateDNSZone string |
ManagedClusterAPIServerAccessProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
authorizedIPRanges []string |
|
disableRunCommand bool |
|
enablePrivateCluster bool |
|
enablePrivateClusterPublicFQDN bool |
|
privateDNSZone string |
ManagedClusterAddonProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
config map[string]string |
|
enabled bool |
ManagedClusterAddonProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
config map[string]string |
|
enabled bool |
|
identity UserAssignedIdentity_STATUS |
ManagedClusterAgentPoolProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
availabilityZones []string |
|
count int |
|
creationData CreationData |
|
enableAutoScaling bool |
|
enableEncryptionAtHost bool |
|
enableFIPS bool |
|
enableNodePublicIP bool |
|
enableUltraSSD bool |
|
gpuInstanceProfile GPUInstanceProfile |
|
hostGroupReference genruntime.ResourceReference |
|
kubeletConfig KubeletConfig |
|
kubeletDiskType KubeletDiskType |
|
linuxOSConfig LinuxOSConfig |
|
maxCount int |
|
maxPods int |
|
minCount int |
|
mode AgentPoolMode |
|
name string |
|
nodeLabels map[string]string |
|
nodePublicIPPrefixReference genruntime.ResourceReference |
|
nodeTaints []string |
|
orchestratorVersion string |
|
osDiskSizeGB ContainerServiceOSDisk |
|
osDiskType OSDiskType |
|
osSKU OSSKU |
|
osType OSType |
|
podSubnetReference genruntime.ResourceReference |
|
powerState PowerState |
|
proximityPlacementGroupReference genruntime.ResourceReference |
|
scaleDownMode ScaleDownMode |
|
scaleSetEvictionPolicy ScaleSetEvictionPolicy |
|
scaleSetPriority ScaleSetPriority |
|
spotMaxPrice float64 |
|
tags map[string]string |
|
type AgentPoolType |
|
upgradeSettings AgentPoolUpgradeSettings |
|
vmSize string |
|
vnetSubnetReference genruntime.ResourceReference |
|
workloadRuntime WorkloadRuntime |
ManagedClusterAgentPoolProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
availabilityZones []string |
|
count int |
|
creationData CreationData_STATUS |
|
currentOrchestratorVersion string |
|
enableAutoScaling bool |
|
enableEncryptionAtHost bool |
|
enableFIPS bool |
|
enableNodePublicIP bool |
|
enableUltraSSD bool |
|
gpuInstanceProfile GPUInstanceProfile_STATUS |
|
hostGroupID string |
|
kubeletConfig KubeletConfig_STATUS |
|
kubeletDiskType KubeletDiskType_STATUS |
|
linuxOSConfig LinuxOSConfig_STATUS |
|
maxCount int |
|
maxPods int |
|
minCount int |
|
mode AgentPoolMode_STATUS |
|
name string |
|
nodeImageVersion string |
|
nodeLabels map[string]string |
|
nodePublicIPPrefixID string |
|
nodeTaints []string |
|
orchestratorVersion string |
|
osDiskSizeGB int |
|
osDiskType OSDiskType_STATUS |
|
osSKU OSSKU_STATUS |
|
osType OSType_STATUS |
|
podSubnetID string |
|
powerState PowerState_STATUS |
|
provisioningState string |
|
proximityPlacementGroupID string |
|
scaleDownMode ScaleDownMode_STATUS |
|
scaleSetEvictionPolicy ScaleSetEvictionPolicy_STATUS |
|
scaleSetPriority ScaleSetPriority_STATUS |
|
spotMaxPrice float64 |
|
tags map[string]string |
|
type AgentPoolType_STATUS |
|
upgradeSettings AgentPoolUpgradeSettings_STATUS |
|
vmSize string |
|
vnetSubnetID string |
|
workloadRuntime WorkloadRuntime_STATUS |
ManagedClusterAutoUpgradeProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
upgradeChannel ManagedClusterAutoUpgradeProfile_UpgradeChannel |
ManagedClusterAutoUpgradeProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
upgradeChannel ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS |
ManagedClusterAutoUpgradeProfile_UpgradeChannel
(string
alias)
(Appears on:ManagedClusterAutoUpgradeProfile)
Value | Description |
---|---|
"node-image" |
|
"none" |
|
"patch" |
|
"rapid" |
|
"stable" |
ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS
(string
alias)
(Appears on:ManagedClusterAutoUpgradeProfile_STATUS)
Value | Description |
---|---|
"node-image" |
|
"none" |
|
"patch" |
|
"rapid" |
|
"stable" |
ManagedClusterAzureMonitorProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
metrics ManagedClusterAzureMonitorProfileMetrics |
ManagedClusterAzureMonitorProfileKubeStateMetrics
(Appears on:ManagedClusterAzureMonitorProfileMetrics)
Field | Description |
---|---|
metricAnnotationsAllowList string |
|
metricLabelsAllowlist string |
ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS
(Appears on:ManagedClusterAzureMonitorProfileMetrics_STATUS)
Field | Description |
---|---|
metricAnnotationsAllowList string |
|
metricLabelsAllowlist string |
ManagedClusterAzureMonitorProfileMetrics
(Appears on:ManagedClusterAzureMonitorProfile)
Field | Description |
---|---|
enabled bool |
|
kubeStateMetrics ManagedClusterAzureMonitorProfileKubeStateMetrics |
ManagedClusterAzureMonitorProfileMetrics_STATUS
(Appears on:ManagedClusterAzureMonitorProfile_STATUS)
Field | Description |
---|---|
enabled bool |
|
kubeStateMetrics ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS |
ManagedClusterAzureMonitorProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
metrics ManagedClusterAzureMonitorProfileMetrics_STATUS |
ManagedClusterHTTPProxyConfig
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
httpProxy string |
|
httpsProxy string |
|
noProxy []string |
|
trustedCa string |
ManagedClusterHTTPProxyConfig_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
httpProxy string |
|
httpsProxy string |
|
noProxy []string |
|
trustedCa string |
ManagedClusterIdentity
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
type ManagedClusterIdentity_Type |
|
userAssignedIdentities []UserAssignedIdentityDetails |
ManagedClusterIdentity_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
principalId string |
|
tenantId string |
|
type ManagedClusterIdentity_Type_STATUS |
|
userAssignedIdentities map[string]./api/containerservice/v1api20230201.ManagedClusterIdentity_UserAssignedIdentities_STATUS |
ManagedClusterIdentity_Type
(string
alias)
(Appears on:ManagedClusterIdentity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"UserAssigned" |
ManagedClusterIdentity_Type_STATUS
(string
alias)
(Appears on:ManagedClusterIdentity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"UserAssigned" |
ManagedClusterIdentity_UserAssignedIdentities_STATUS
(Appears on:ManagedClusterIdentity_STATUS)
Field | Description |
---|---|
clientId string |
|
principalId string |
ManagedClusterLoadBalancerProfile
(Appears on:ContainerServiceNetworkProfile)
Field | Description |
---|---|
allocatedOutboundPorts int |
|
effectiveOutboundIPs []ResourceReference |
|
enableMultipleStandardLoadBalancers bool |
|
idleTimeoutInMinutes int |
|
managedOutboundIPs ManagedClusterLoadBalancerProfile_ManagedOutboundIPs |
|
outboundIPPrefixes ManagedClusterLoadBalancerProfile_OutboundIPPrefixes |
|
outboundIPs ManagedClusterLoadBalancerProfile_OutboundIPs |
ManagedClusterLoadBalancerProfile_ManagedOutboundIPs
(Appears on:ManagedClusterLoadBalancerProfile)
Field | Description |
---|---|
count int |
|
countIPv6 int |
ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS
(Appears on:ManagedClusterLoadBalancerProfile_STATUS)
Field | Description |
---|---|
count int |
|
countIPv6 int |
ManagedClusterLoadBalancerProfile_OutboundIPPrefixes
(Appears on:ManagedClusterLoadBalancerProfile)
Field | Description |
---|---|
publicIPPrefixes []ResourceReference |
ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS
(Appears on:ManagedClusterLoadBalancerProfile_STATUS)
Field | Description |
---|---|
publicIPPrefixes []ResourceReference_STATUS |
ManagedClusterLoadBalancerProfile_OutboundIPs
(Appears on:ManagedClusterLoadBalancerProfile)
Field | Description |
---|---|
publicIPs []ResourceReference |
ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS
(Appears on:ManagedClusterLoadBalancerProfile_STATUS)
Field | Description |
---|---|
publicIPs []ResourceReference_STATUS |
ManagedClusterLoadBalancerProfile_STATUS
(Appears on:ContainerServiceNetworkProfile_STATUS)
Field | Description |
---|---|
allocatedOutboundPorts int |
|
effectiveOutboundIPs []ResourceReference_STATUS |
|
enableMultipleStandardLoadBalancers bool |
|
idleTimeoutInMinutes int |
|
managedOutboundIPs ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS |
|
outboundIPPrefixes ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS |
|
outboundIPs ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS |
ManagedClusterManagedOutboundIPProfile
(Appears on:ManagedClusterNATGatewayProfile)
Field | Description |
---|---|
count int |
ManagedClusterManagedOutboundIPProfile_STATUS
(Appears on:ManagedClusterNATGatewayProfile_STATUS)
Field | Description |
---|---|
count int |
ManagedClusterNATGatewayProfile
(Appears on:ContainerServiceNetworkProfile)
Field | Description |
---|---|
effectiveOutboundIPs []ResourceReference |
|
idleTimeoutInMinutes int |
|
managedOutboundIPProfile ManagedClusterManagedOutboundIPProfile |
ManagedClusterNATGatewayProfile_STATUS
(Appears on:ContainerServiceNetworkProfile_STATUS)
Field | Description |
---|---|
effectiveOutboundIPs []ResourceReference_STATUS |
|
idleTimeoutInMinutes int |
|
managedOutboundIPProfile ManagedClusterManagedOutboundIPProfile_STATUS |
ManagedClusterOIDCIssuerProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
enabled bool |
ManagedClusterOIDCIssuerProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
enabled bool |
|
issuerURL string |
ManagedClusterOperatorConfigMaps
(Appears on:ManagedClusterOperatorSpec)
Field | Description |
---|---|
oidcIssuerProfile genruntime.ConfigMapDestination |
OIDCIssuerProfile: indicates where the OIDCIssuerProfile config map should be placed. If omitted, no config map will be created. |
principalId genruntime.ConfigMapDestination |
PrincipalId: indicates where the PrincipalId config map should be placed. If omitted, no config map will be created. |
ManagedClusterOperatorSecrets
(Appears on:ManagedClusterOperatorSpec)
Field | Description |
---|---|
adminCredentials genruntime.SecretDestination |
AdminCredentials: indicates where the AdminCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. |
userCredentials genruntime.SecretDestination |
UserCredentials: indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. |
ManagedClusterOperatorSpec
(Appears on:ManagedCluster_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps ManagedClusterOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets ManagedClusterOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
ManagedClusterPodIdentity
(Appears on:ManagedClusterPodIdentityProfile)
Field | Description |
---|---|
bindingSelector string |
|
identity UserAssignedIdentity |
|
name string |
|
namespace string |
ManagedClusterPodIdentityException
(Appears on:ManagedClusterPodIdentityProfile)
Field | Description |
---|---|
name string |
|
namespace string |
|
podLabels map[string]string |
ManagedClusterPodIdentityException_STATUS
(Appears on:ManagedClusterPodIdentityProfile_STATUS)
Field | Description |
---|---|
name string |
|
namespace string |
|
podLabels map[string]string |
ManagedClusterPodIdentityProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
allowNetworkPluginKubenet bool |
|
enabled bool |
|
userAssignedIdentities []ManagedClusterPodIdentity |
|
userAssignedIdentityExceptions []ManagedClusterPodIdentityException |
ManagedClusterPodIdentityProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
allowNetworkPluginKubenet bool |
|
enabled bool |
|
userAssignedIdentities []ManagedClusterPodIdentity_STATUS |
|
userAssignedIdentityExceptions []ManagedClusterPodIdentityException_STATUS |
ManagedClusterPodIdentityProvisioningErrorBody_STATUS
(Appears on:ManagedClusterPodIdentityProvisioningError_STATUS)
Field | Description |
---|---|
code string |
|
details []ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled |
|
message string |
|
target string |
ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled
(Appears on:ManagedClusterPodIdentityProvisioningErrorBody_STATUS)
Field | Description |
---|---|
code string |
|
message string |
|
target string |
ManagedClusterPodIdentityProvisioningError_STATUS
(Appears on:ManagedClusterPodIdentity_ProvisioningInfo_STATUS)
Field | Description |
---|---|
error ManagedClusterPodIdentityProvisioningErrorBody_STATUS |
ManagedClusterPodIdentity_ProvisioningInfo_STATUS
(Appears on:ManagedClusterPodIdentity_STATUS)
Field | Description |
---|---|
error ManagedClusterPodIdentityProvisioningError_STATUS |
ManagedClusterPodIdentity_ProvisioningState_STATUS
(string
alias)
(Appears on:ManagedClusterPodIdentity_STATUS)
Value | Description |
---|---|
"Assigned" |
|
"Canceled" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
ManagedClusterPodIdentity_STATUS
(Appears on:ManagedClusterPodIdentityProfile_STATUS)
Field | Description |
---|---|
bindingSelector string |
|
identity UserAssignedIdentity_STATUS |
|
name string |
|
namespace string |
|
provisioningInfo ManagedClusterPodIdentity_ProvisioningInfo_STATUS |
|
provisioningState ManagedClusterPodIdentity_ProvisioningState_STATUS |
ManagedClusterProperties_AutoScalerProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
balance-similar-node-groups string |
|
expander ManagedClusterProperties_AutoScalerProfile_Expander |
|
max-empty-bulk-delete string |
|
max-graceful-termination-sec string |
|
max-node-provision-time string |
|
max-total-unready-percentage string |
|
new-pod-scale-up-delay string |
|
ok-total-unready-count string |
|
scale-down-delay-after-add string |
|
scale-down-delay-after-delete string |
|
scale-down-delay-after-failure string |
|
scale-down-unneeded-time string |
|
scale-down-unready-time string |
|
scale-down-utilization-threshold string |
|
scan-interval string |
|
skip-nodes-with-local-storage string |
|
skip-nodes-with-system-pods string |
ManagedClusterProperties_AutoScalerProfile_Expander
(string
alias)
(Appears on:ManagedClusterProperties_AutoScalerProfile)
Value | Description |
---|---|
"least-waste" |
|
"most-pods" |
|
"priority" |
|
"random" |
ManagedClusterProperties_AutoScalerProfile_Expander_STATUS
(string
alias)
(Appears on:ManagedClusterProperties_AutoScalerProfile_STATUS)
Value | Description |
---|---|
"least-waste" |
|
"most-pods" |
|
"priority" |
|
"random" |
ManagedClusterProperties_AutoScalerProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
balance-similar-node-groups string |
|
expander ManagedClusterProperties_AutoScalerProfile_Expander_STATUS |
|
max-empty-bulk-delete string |
|
max-graceful-termination-sec string |
|
max-node-provision-time string |
|
max-total-unready-percentage string |
|
new-pod-scale-up-delay string |
|
ok-total-unready-count string |
|
scale-down-delay-after-add string |
|
scale-down-delay-after-delete string |
|
scale-down-delay-after-failure string |
|
scale-down-unneeded-time string |
|
scale-down-unready-time string |
|
scale-down-utilization-threshold string |
|
scan-interval string |
|
skip-nodes-with-local-storage string |
|
skip-nodes-with-system-pods string |
ManagedClusterProperties_PublicNetworkAccess
(string
alias)
(Appears on:ManagedCluster_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ManagedClusterProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:ManagedCluster_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ManagedClusterSKU
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
name ManagedClusterSKU_Name |
|
tier ManagedClusterSKU_Tier |
ManagedClusterSKU_Name
(string
alias)
(Appears on:ManagedClusterSKU)
Value | Description |
---|---|
"Base" |
ManagedClusterSKU_Name_STATUS
(string
alias)
(Appears on:ManagedClusterSKU_STATUS)
Value | Description |
---|---|
"Base" |
ManagedClusterSKU_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
name ManagedClusterSKU_Name_STATUS |
|
tier ManagedClusterSKU_Tier_STATUS |
ManagedClusterSKU_Tier
(string
alias)
(Appears on:ManagedClusterSKU)
Value | Description |
---|---|
"Free" |
|
"Standard" |
ManagedClusterSKU_Tier_STATUS
(string
alias)
(Appears on:ManagedClusterSKU_STATUS)
Value | Description |
---|---|
"Free" |
|
"Standard" |
ManagedClusterSecurityProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
azureKeyVaultKms AzureKeyVaultKms |
|
defender ManagedClusterSecurityProfileDefender |
|
imageCleaner ManagedClusterSecurityProfileImageCleaner |
|
workloadIdentity ManagedClusterSecurityProfileWorkloadIdentity |
ManagedClusterSecurityProfileDefender
(Appears on:ManagedClusterSecurityProfile)
Field | Description |
---|---|
logAnalyticsWorkspaceResourceReference genruntime.ResourceReference |
|
securityMonitoring ManagedClusterSecurityProfileDefenderSecurityMonitoring |
ManagedClusterSecurityProfileDefenderSecurityMonitoring
(Appears on:ManagedClusterSecurityProfileDefender)
Field | Description |
---|---|
enabled bool |
ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS
(Appears on:ManagedClusterSecurityProfileDefender_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterSecurityProfileDefender_STATUS
(Appears on:ManagedClusterSecurityProfile_STATUS)
Field | Description |
---|---|
logAnalyticsWorkspaceResourceId string |
|
securityMonitoring ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS |
ManagedClusterSecurityProfileImageCleaner
(Appears on:ManagedClusterSecurityProfile)
Field | Description |
---|---|
enabled bool |
|
intervalHours int |
ManagedClusterSecurityProfileImageCleaner_STATUS
(Appears on:ManagedClusterSecurityProfile_STATUS)
Field | Description |
---|---|
enabled bool |
|
intervalHours int |
ManagedClusterSecurityProfileWorkloadIdentity
(Appears on:ManagedClusterSecurityProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterSecurityProfileWorkloadIdentity_STATUS
(Appears on:ManagedClusterSecurityProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterSecurityProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
azureKeyVaultKms AzureKeyVaultKms_STATUS |
|
defender ManagedClusterSecurityProfileDefender_STATUS |
|
imageCleaner ManagedClusterSecurityProfileImageCleaner_STATUS |
|
workloadIdentity ManagedClusterSecurityProfileWorkloadIdentity_STATUS |
ManagedClusterServicePrincipalProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
clientId string |
|
secret genruntime.SecretReference |
ManagedClusterServicePrincipalProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
clientId string |
ManagedClusterStorageProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
blobCSIDriver ManagedClusterStorageProfileBlobCSIDriver |
|
diskCSIDriver ManagedClusterStorageProfileDiskCSIDriver |
|
fileCSIDriver ManagedClusterStorageProfileFileCSIDriver |
|
snapshotController ManagedClusterStorageProfileSnapshotController |
ManagedClusterStorageProfileBlobCSIDriver
(Appears on:ManagedClusterStorageProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileBlobCSIDriver_STATUS
(Appears on:ManagedClusterStorageProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileDiskCSIDriver
(Appears on:ManagedClusterStorageProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileDiskCSIDriver_STATUS
(Appears on:ManagedClusterStorageProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileFileCSIDriver
(Appears on:ManagedClusterStorageProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileFileCSIDriver_STATUS
(Appears on:ManagedClusterStorageProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileSnapshotController
(Appears on:ManagedClusterStorageProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfileSnapshotController_STATUS
(Appears on:ManagedClusterStorageProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterStorageProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
blobCSIDriver ManagedClusterStorageProfileBlobCSIDriver_STATUS |
|
diskCSIDriver ManagedClusterStorageProfileDiskCSIDriver_STATUS |
|
fileCSIDriver ManagedClusterStorageProfileFileCSIDriver_STATUS |
|
snapshotController ManagedClusterStorageProfileSnapshotController_STATUS |
ManagedClusterWindowsProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
adminPassword genruntime.SecretReference |
|
adminUsername string |
|
enableCSIProxy bool |
|
gmsaProfile WindowsGmsaProfile |
|
licenseType ManagedClusterWindowsProfile_LicenseType |
ManagedClusterWindowsProfile_LicenseType
(string
alias)
(Appears on:ManagedClusterWindowsProfile)
Value | Description |
---|---|
"None" |
|
"Windows_Server" |
ManagedClusterWindowsProfile_LicenseType_STATUS
(string
alias)
(Appears on:ManagedClusterWindowsProfile_STATUS)
Value | Description |
---|---|
"None" |
|
"Windows_Server" |
ManagedClusterWindowsProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
adminUsername string |
|
enableCSIProxy bool |
|
gmsaProfile WindowsGmsaProfile_STATUS |
|
licenseType ManagedClusterWindowsProfile_LicenseType_STATUS |
ManagedClusterWorkloadAutoScalerProfile
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
keda ManagedClusterWorkloadAutoScalerProfileKeda |
ManagedClusterWorkloadAutoScalerProfileKeda
(Appears on:ManagedClusterWorkloadAutoScalerProfile)
Field | Description |
---|---|
enabled bool |
ManagedClusterWorkloadAutoScalerProfileKeda_STATUS
(Appears on:ManagedClusterWorkloadAutoScalerProfile_STATUS)
Field | Description |
---|---|
enabled bool |
ManagedClusterWorkloadAutoScalerProfile_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
keda ManagedClusterWorkloadAutoScalerProfileKeda_STATUS |
ManagedCluster_STATUS
(Appears on:ManagedCluster)
ManagedCluster_Spec
(Appears on:ManagedCluster)
Field | Description |
---|---|
aadProfile ManagedClusterAADProfile |
|
addonProfiles map[string]./api/containerservice/v1api20230201.ManagedClusterAddonProfile |
|
agentPoolProfiles []ManagedClusterAgentPoolProfile |
|
apiServerAccessProfile ManagedClusterAPIServerAccessProfile |
|
autoScalerProfile ManagedClusterProperties_AutoScalerProfile |
|
autoUpgradeProfile ManagedClusterAutoUpgradeProfile |
|
azureMonitorProfile ManagedClusterAzureMonitorProfile |
|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
disableLocalAccounts bool |
|
diskEncryptionSetReference genruntime.ResourceReference |
|
dnsPrefix string |
|
enablePodSecurityPolicy bool |
|
enableRBAC bool |
|
extendedLocation ExtendedLocation |
|
fqdnSubdomain string |
|
httpProxyConfig ManagedClusterHTTPProxyConfig |
|
identity ManagedClusterIdentity |
|
identityProfile map[string]./api/containerservice/v1api20230201.UserAssignedIdentity |
|
kubernetesVersion string |
|
linuxProfile ContainerServiceLinuxProfile |
|
location string |
|
networkProfile ContainerServiceNetworkProfile |
|
nodeResourceGroup string |
|
oidcIssuerProfile ManagedClusterOIDCIssuerProfile |
|
operatorSpec ManagedClusterOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
podIdentityProfile ManagedClusterPodIdentityProfile |
|
privateLinkResources []PrivateLinkResource |
|
publicNetworkAccess ManagedClusterProperties_PublicNetworkAccess |
|
securityProfile ManagedClusterSecurityProfile |
|
servicePrincipalProfile ManagedClusterServicePrincipalProfile |
|
sku ManagedClusterSKU |
|
storageProfile ManagedClusterStorageProfile |
|
tags map[string]string |
|
windowsProfile ManagedClusterWindowsProfile |
|
workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfile |
ManagedClustersAgentPool
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-02-01/managedClusters.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spec ManagedClustersAgentPool_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status ManagedClustersAgentPool_STATUS |
ManagedClustersAgentPoolOperatorSpec
(Appears on:ManagedClustersAgentPool_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ManagedClustersAgentPool_STATUS
(Appears on:ManagedClustersAgentPool)
Field | Description |
---|---|
availabilityZones []string |
AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
count int |
Count: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. |
creationData CreationData_STATUS |
CreationData: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. |
currentOrchestratorVersion string |
CurrentOrchestratorVersion: If orchestratorVersion is a fully specified version |
enableAutoScaling bool |
EnableAutoScaling: Whether to enable auto-scaler |
enableEncryptionAtHost bool |
EnableEncryptionAtHost: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption |
enableFIPS bool |
EnableFIPS: See Add a FIPS-enabled node pool for more details. |
enableNodePublicIP bool |
EnableNodePublicIP: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. |
enableUltraSSD bool |
EnableUltraSSD: Whether to enable UltraSSD |
gpuInstanceProfile GPUInstanceProfile_STATUS |
GpuInstanceProfile: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. |
hostGroupID string |
HostGroupID: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. |
id string |
Id: Resource ID. |
kubeletConfig KubeletConfig_STATUS |
KubeletConfig: The Kubelet configuration on the agent pool nodes. |
kubeletDiskType KubeletDiskType_STATUS |
KubeletDiskType: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
linuxOSConfig LinuxOSConfig_STATUS |
LinuxOSConfig: The OS configuration of Linux agent nodes. |
maxCount int |
MaxCount: The maximum number of nodes for auto-scaling |
maxPods int |
MaxPods: The maximum number of pods that can run on a node. |
minCount int |
MinCount: The minimum number of nodes for auto-scaling |
mode AgentPoolMode_STATUS |
Mode: A cluster must have at least one ‘System’ Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
nodeImageVersion string |
NodeImageVersion: The version of node image |
nodeLabels map[string]string |
NodeLabels: The node labels to be persisted across all nodes in agent pool. |
nodePublicIPPrefixID string |
NodePublicIPPrefixID: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}p> |
nodeTaints []string |
NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
orchestratorVersion string |
OrchestratorVersion: Both patch version |
osDiskSizeGB int |
|
osDiskType OSDiskType_STATUS |
OsDiskType: The default is ‘Ephemeral’ if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to ‘Managed’. May not be changed after creation. For more information see Ephemeral OS. |
osSKU OSSKU_STATUS |
OsSKU: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. |
osType OSType_STATUS |
OsType: The operating system type. The default is Linux. |
podSubnetID string |
PodSubnetID: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}p> |
powerState PowerState_STATUS |
PowerState: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded |
properties_type AgentPoolType_STATUS |
PropertiesType: The type of Agent Pool. |
provisioningState string |
ProvisioningState: The current deployment or provisioning state. |
proximityPlacementGroupID string |
ProximityPlacementGroupID: The ID for Proximity Placement Group. |
scaleDownMode ScaleDownMode_STATUS |
ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. |
scaleSetEvictionPolicy ScaleSetEvictionPolicy_STATUS |
ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. |
scaleSetPriority ScaleSetPriority_STATUS |
ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. |
spotMaxPrice float64 |
SpotMaxPrice: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing |
tags map[string]string |
Tags: The tags to be persisted on the agent pool virtual machine scale set. |
type string |
Type: Resource type |
upgradeSettings AgentPoolUpgradeSettings_STATUS |
UpgradeSettings: Settings for upgrading the agentpool |
vmSize string |
VmSize: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions |
vnetSubnetID string |
VnetSubnetID: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}p> |
workloadRuntime WorkloadRuntime_STATUS |
WorkloadRuntime: Determines the type of workload a node can run. |
ManagedClustersAgentPool_Spec
(Appears on:ManagedClustersAgentPool)
Field | Description |
---|---|
availabilityZones []string |
AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
count int |
Count: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. |
creationData CreationData |
CreationData: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. |
enableAutoScaling bool |
EnableAutoScaling: Whether to enable auto-scaler |
enableEncryptionAtHost bool |
EnableEncryptionAtHost: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption |
enableFIPS bool |
EnableFIPS: See Add a FIPS-enabled node pool for more details. |
enableNodePublicIP bool |
EnableNodePublicIP: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. |
enableUltraSSD bool |
EnableUltraSSD: Whether to enable UltraSSD |
gpuInstanceProfile GPUInstanceProfile |
GpuInstanceProfile: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. |
hostGroupReference genruntime.ResourceReference |
HostGroupReference: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. |
kubeletConfig KubeletConfig |
KubeletConfig: The Kubelet configuration on the agent pool nodes. |
kubeletDiskType KubeletDiskType |
KubeletDiskType: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
linuxOSConfig LinuxOSConfig |
LinuxOSConfig: The OS configuration of Linux agent nodes. |
maxCount int |
MaxCount: The maximum number of nodes for auto-scaling |
maxPods int |
MaxPods: The maximum number of pods that can run on a node. |
minCount int |
MinCount: The minimum number of nodes for auto-scaling |
mode AgentPoolMode |
Mode: A cluster must have at least one ‘System’ Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools |
nodeLabels map[string]string |
NodeLabels: The node labels to be persisted across all nodes in agent pool. |
nodePublicIPPrefixReference genruntime.ResourceReference |
NodePublicIPPrefixReference: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}p> |
nodeTaints []string |
NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
operatorSpec ManagedClustersAgentPoolOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
orchestratorVersion string |
OrchestratorVersion: Both patch version |
osDiskSizeGB ContainerServiceOSDisk |
|
osDiskType OSDiskType |
OsDiskType: The default is ‘Ephemeral’ if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to ‘Managed’. May not be changed after creation. For more information see Ephemeral OS. |
osSKU OSSKU |
OsSKU: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. |
osType OSType |
OsType: The operating system type. The default is Linux. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/ManagedCluster resource |
podSubnetReference genruntime.ResourceReference |
PodSubnetReference: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}p> |
powerState PowerState |
PowerState: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded |
proximityPlacementGroupReference genruntime.ResourceReference |
ProximityPlacementGroupReference: The ID for Proximity Placement Group. |
scaleDownMode ScaleDownMode |
ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. |
scaleSetEvictionPolicy ScaleSetEvictionPolicy |
ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. |
scaleSetPriority ScaleSetPriority |
ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. |
spotMaxPrice float64 |
SpotMaxPrice: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing |
tags map[string]string |
Tags: The tags to be persisted on the agent pool virtual machine scale set. |
type AgentPoolType |
Type: The type of Agent Pool. |
upgradeSettings AgentPoolUpgradeSettings |
UpgradeSettings: Settings for upgrading the agentpool |
vmSize string |
VmSize: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions |
vnetSubnetReference genruntime.ResourceReference |
VnetSubnetReference: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}p> |
workloadRuntime WorkloadRuntime |
WorkloadRuntime: Determines the type of workload a node can run. |
OSDiskType
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"Ephemeral" |
|
"Managed" |
OSDiskType_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"Ephemeral" |
|
"Managed" |
OSSKU
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"CBLMariner" |
|
"Ubuntu" |
|
"Windows2019" |
|
"Windows2022" |
OSSKU_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"CBLMariner" |
|
"Ubuntu" |
|
"Windows2019" |
|
"Windows2022" |
OSType
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
OSType_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
PowerState
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Field | Description |
---|---|
code PowerState_Code |
PowerState_Code
(string
alias)
(Appears on:PowerState)
Value | Description |
---|---|
"Running" |
|
"Stopped" |
PowerState_Code_STATUS
(string
alias)
(Appears on:PowerState_STATUS)
Value | Description |
---|---|
"Running" |
|
"Stopped" |
PowerState_STATUS
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedCluster_STATUS, ManagedClustersAgentPool_STATUS)
Field | Description |
---|---|
code PowerState_Code_STATUS |
PrivateLinkResource
(Appears on:ManagedCluster_Spec)
Field | Description |
---|---|
groupId string |
|
name string |
|
reference genruntime.ResourceReference |
|
requiredMembers []string |
|
type string |
PrivateLinkResource_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
groupId string |
|
id string |
|
name string |
|
privateLinkServiceID string |
|
requiredMembers []string |
|
type string |
ResourceReference
(Appears on:ManagedClusterLoadBalancerProfile, ManagedClusterLoadBalancerProfile_OutboundIPPrefixes, ManagedClusterLoadBalancerProfile_OutboundIPs, ManagedClusterNATGatewayProfile)
Field | Description |
---|---|
reference genruntime.ResourceReference |
ResourceReference_STATUS
(Appears on:ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS, ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS, ManagedClusterLoadBalancerProfile_STATUS, ManagedClusterNATGatewayProfile_STATUS)
Field | Description |
---|---|
id string |
ScaleDownMode
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"Deallocate" |
|
"Delete" |
ScaleDownMode_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"Deallocate" |
|
"Delete" |
ScaleSetEvictionPolicy
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"Deallocate" |
|
"Delete" |
ScaleSetEvictionPolicy_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"Deallocate" |
|
"Delete" |
ScaleSetPriority
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"Regular" |
|
"Spot" |
ScaleSetPriority_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"Regular" |
|
"Spot" |
SysctlConfig
(Appears on:LinuxOSConfig)
Field | Description |
---|---|
fsAioMaxNr int |
|
fsFileMax int |
|
fsInotifyMaxUserWatches int |
|
fsNrOpen int |
|
kernelThreadsMax int |
|
netCoreNetdevMaxBacklog int |
|
netCoreOptmemMax int |
|
netCoreRmemDefault int |
|
netCoreRmemMax int |
|
netCoreSomaxconn int |
|
netCoreWmemDefault int |
|
netCoreWmemMax int |
|
netIpv4IpLocalPortRange string |
|
netIpv4NeighDefaultGcThresh1 int |
|
netIpv4NeighDefaultGcThresh2 int |
|
netIpv4NeighDefaultGcThresh3 int |
|
netIpv4TcpFinTimeout int |
|
netIpv4TcpKeepaliveProbes int |
|
netIpv4TcpKeepaliveTime int |
|
netIpv4TcpMaxSynBacklog int |
|
netIpv4TcpMaxTwBuckets int |
|
netIpv4TcpTwReuse bool |
|
netIpv4TcpkeepaliveIntvl int |
|
netNetfilterNfConntrackBuckets int |
|
netNetfilterNfConntrackMax int |
|
vmMaxMapCount int |
|
vmSwappiness int |
|
vmVfsCachePressure int |
SysctlConfig_STATUS
(Appears on:LinuxOSConfig_STATUS)
Field | Description |
---|---|
fsAioMaxNr int |
|
fsFileMax int |
|
fsInotifyMaxUserWatches int |
|
fsNrOpen int |
|
kernelThreadsMax int |
|
netCoreNetdevMaxBacklog int |
|
netCoreOptmemMax int |
|
netCoreRmemDefault int |
|
netCoreRmemMax int |
|
netCoreSomaxconn int |
|
netCoreWmemDefault int |
|
netCoreWmemMax int |
|
netIpv4IpLocalPortRange string |
|
netIpv4NeighDefaultGcThresh1 int |
|
netIpv4NeighDefaultGcThresh2 int |
|
netIpv4NeighDefaultGcThresh3 int |
|
netIpv4TcpFinTimeout int |
|
netIpv4TcpKeepaliveProbes int |
|
netIpv4TcpKeepaliveTime int |
|
netIpv4TcpMaxSynBacklog int |
|
netIpv4TcpMaxTwBuckets int |
|
netIpv4TcpTwReuse bool |
|
netIpv4TcpkeepaliveIntvl int |
|
netNetfilterNfConntrackBuckets int |
|
netNetfilterNfConntrackMax int |
|
vmMaxMapCount int |
|
vmSwappiness int |
|
vmVfsCachePressure int |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:ManagedCluster_STATUS)
Field | Description |
---|---|
createdAt string |
|
createdBy string |
|
createdByType SystemData_CreatedByType_STATUS |
|
lastModifiedAt string |
|
lastModifiedBy string |
|
lastModifiedByType SystemData_LastModifiedByType_STATUS |
UserAssignedIdentity
(Appears on:ManagedClusterPodIdentity, ManagedCluster_Spec)
Field | Description |
---|---|
clientId string |
|
objectId string |
|
resourceReference genruntime.ResourceReference |
UserAssignedIdentityDetails
(Appears on:ManagedClusterIdentity)
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentity_STATUS
(Appears on:ManagedClusterAddonProfile_STATUS, ManagedClusterPodIdentity_STATUS, ManagedCluster_STATUS)
Field | Description |
---|---|
clientId string |
|
objectId string |
|
resourceId string |
WindowsGmsaProfile
(Appears on:ManagedClusterWindowsProfile)
Field | Description |
---|---|
dnsServer string |
|
enabled bool |
|
rootDomainName string |
WindowsGmsaProfile_STATUS
(Appears on:ManagedClusterWindowsProfile_STATUS)
Field | Description |
---|---|
dnsServer string |
|
enabled bool |
|
rootDomainName string |
WorkloadRuntime
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPool_Spec)
Value | Description |
---|---|
"OCIContainer" |
|
"WasmWasi" |
WorkloadRuntime_STATUS
(string
alias)
(Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClustersAgentPool_STATUS)
Value | Description |
---|---|
"OCIContainer" |
|
"WasmWasi" |