Microsoft.ContainerService (stable:2025-01-01)

2025/03/16 • 59 new methods

Operations_List (new)
Description :  Gets a list of operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations ,
Required: False ,
}
[
{
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Describes the properties of a Operation Value Display. ,
Required: False ,
}
{
operation:
{
Description: The display name of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListKubernetesVersions (new)
Description :  Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
values:
{
Description: Array of AKS supported Kubernetes versions. ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
capabilities:
{
Description: Capabilities on this Kubernetes version. ,
Required: False ,
}
{
supportPlan:
{
Required: False ,
}
[
string ,
]
,
}
,
isDefault:
{
Description: Whether this version is default. ,
Required: False ,
}
boolean ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_List (new)
Description :  Gets a list of managed clusters in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of managed clusters. ,
Required: False ,
}
[
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of managed cluster results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListByResourceGroup (new)
Description :  Lists managed clusters in the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of managed clusters. ,
Required: False ,
}
[
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of managed cluster results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_GetUpgradeProfile (new)
Description :  Gets the upgrade profile of a managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the upgrade profile. ,
Required: False ,
}
string ,
name:
{
Description: The name of the upgrade profile. ,
Required: False ,
}
string ,
type:
{
Description: The type of the upgrade profile. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the upgrade profile. ,
Required: True ,
}
{
controlPlaneProfile:
{
Description: The list of available upgrade versions for the control plane. ,
Required: True ,
}
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: True ,
}
string ,
name:
{
Description: The Agent Pool name. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: True ,
}
enum ,
upgrades:
{
Description: List of orchestrator types and versions available for upgrade. ,
Required: False ,
}
[
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether the Kubernetes version is currently in preview. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
agentPoolProfiles:
{
Description: The list of available upgrade versions for agent pools. ,
Required: True ,
}
[
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: True ,
}
string ,
name:
{
Description: The Agent Pool name. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: True ,
}
enum ,
upgrades:
{
Description: List of orchestrator types and versions available for upgrade. ,
Required: False ,
}
[
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether the Kubernetes version is currently in preview. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_GetAccessProfile (new)
Description :  **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the role for managed cluster accessProfile resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AccessProfile of a managed cluster. ,
Required: False ,
}
{
kubeConfig:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListClusterAdminCredentials (new)
Description :  Lists the admin credentials of a managed cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
server-fqdn:
{
Description: server fqdn type for credentials to be returned ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListClusterUserCredentials (new)
Description :  Lists the user credentials of a managed cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
server-fqdn:
{
Description: server fqdn type for credentials to be returned ,
Required: False ,
}
string ,
format:
{
Description: Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListClusterMonitoringUserCredentials (new)
Description :  Lists the cluster monitoring user credentials of a managed cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
server-fqdn:
{
Description: server fqdn type for credentials to be returned ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_Get (new)
Description :  Gets a managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_CreateOrUpdate (new)
Description :  Creates or updates a managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed cluster to create or update. ,
Required: True ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_UpdateTags (new)
Description :  Updates tags on a managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Managed Cluster Tags operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
sku:
{
Description: The managed cluster SKU. ,
Required: False ,
}
{
name:
{
Description: The name of a managed cluster SKU. ,
Enum:
{
Base: Base option for the AKS control plane. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. ,
Enum:
{
Standard: Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. ,
Free: The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases. ,
Premium: Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the managed cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity which is used by master components. ,
Required: False ,
}
string ,
type:
{
Description: For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). ,
Enum:
{
SystemAssigned: Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources. ,
UserAssigned: Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources. ,
None: Do not use a managed identity for the Managed Cluster, service principal will be used instead. ,
}
,
Required: False ,
}
enum ,
delegatedResources:
{
Description: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. ,
Required: False ,
}
object ,
userAssignedIdentities:
{
Description: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of a managed cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: The Power State of the cluster. ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
maxAgentPools:
{
Description: The max number of agent pools for the managed cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
kubernetesVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. ,
Required: False ,
}
string ,
currentKubernetesVersion:
{
Description: If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used. ,
Required: False ,
}
string ,
dnsPrefix:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdnSubdomain:
{
Description: This cannot be updated once the Managed Cluster has been created. ,
Required: False ,
}
string ,
fqdn:
{
Description: The FQDN of the master pool. ,
Required: False ,
}
string ,
privateFQDN:
{
Description: The FQDN of private cluster. ,
Required: False ,
}
string ,
azurePortalFQDN:
{
Description: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. ,
Required: False ,
}
string ,
agentPoolProfiles:
{
Description: The agent pool properties. ,
Required: False ,
}
[
{
name:
{
Description: Windows agent pool names must be 6 characters or less. ,
Required: True ,
}
string ,
}
,
]
,
linuxProfile:
{
Description: The profile for Linux VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: The administrator username to use for Linux VMs. ,
Required: True ,
}
string ,
ssh:
{
Description: The SSH configuration for Linux-based VMs running on Azure. ,
Required: True ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. ,
Required: True ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
windowsProfile:
{
Description: The profile for Windows VMs in the Managed Cluster. ,
Required: False ,
}
{
adminUsername:
{
Description: Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters ,
Required: True ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. ,
Enum:
{
None: No additional licensing is applied. ,
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs. ,
}
,
Required: False ,
}
enum ,
enableCSIProxy:
{
Description: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). ,
Required: False ,
}
boolean ,
gmsaProfile:
{
Description: The Windows gMSA Profile in the Managed Cluster. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether to enable Windows gMSA in the managed cluster. ,
Required: False ,
}
boolean ,
dnsServer:
{
Description: Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
rootDomainName:
{
Description: Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. ,
Required: False ,
}
string ,
}
,
}
,
servicePrincipalProfile:
{
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ,
Required: False ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
addonProfiles:
{
Description: The profile of managed cluster add-on. ,
Required: False ,
}
object ,
podIdentityProfile:
{
Description: See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the pod identity addon is enabled. ,
Required: False ,
}
boolean ,
allowNetworkPluginKubenet:
{
Description: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. ,
Required: False ,
}
boolean ,
userAssignedIdentities:
{
Description: The pod identities to use in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity. ,
Required: True ,
}
string ,
bindingSelector:
{
Description: The binding selector to use for the AzureIdentityBinding resource. ,
Required: False ,
}
string ,
identity:
{
Description: The user assigned identity details. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The current provisioning state of the pod identity. ,
Enum:
{
Assigned: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Required: False ,
}
{
error:
{
Description: Pod identity assignment error (if any). ,
Required: False ,
}
{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
userAssignedIdentityExceptions:
{
Description: The pod identity exceptions to allow. ,
Required: False ,
}
[
{
name:
{
Description: The name of the pod identity exception. ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the pod identity exception. ,
Required: True ,
}
string ,
podLabels:
{
Description: The pod labels to match. ,
Required: True ,
}
object ,
}
,
]
,
}
,
oidcIssuerProfile:
{
Description: The OIDC issuer profile of the Managed Cluster. ,
Required: False ,
}
{
issuerURL:
{
Description: The OIDC issuer url of the Managed Cluster. ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the OIDC issuer is enabled. ,
Required: False ,
}
boolean ,
}
,
nodeResourceGroup:
{
Description: The name of the resource group containing agent pool nodes. ,
Required: False ,
}
string ,
nodeResourceGroupProfile:
{
Description: Profile of the node resource group configuration. ,
Required: False ,
}
{
restrictionLevel:
{
Description: The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' ,
Enum:
{
Unrestricted: All RBAC permissions are allowed on the managed node resource group ,
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group ,
}
,
Required: False ,
}
enum ,
}
,
enableRBAC:
{
Description: Whether to enable Kubernetes Role-Based Access Control. ,
Required: False ,
}
boolean ,
supportPlan:
{
Description: The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. ,
Enum:
{
KubernetesOfficial: Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release. ,
AKSLongTermSupport: Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support. ,
}
,
Required: False ,
}
enum ,
enablePodSecurityPolicy:
{
Description: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp. ,
Required: False ,
}
boolean ,
networkProfile:
{
Description: The network configuration profile. ,
Required: False ,
}
{
networkPlugin:
{
Description: Network plugin used for building the Kubernetes network. ,
Enum:
{
azure: Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information. ,
kubenet: Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information. ,
none: No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information. ,
}
,
Required: False ,
}
enum ,
networkPluginMode:
{
Description: The mode the network plugin should use. ,
Enum:
{
overlay: Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay. ,
}
,
Required: False ,
}
enum ,
networkPolicy:
{
Description: Network policy used for building the Kubernetes network. ,
Enum:
{
none: Network policies will not be enforced. This is the default value when NetworkPolicy is not specified. ,
calico: Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
azure: Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information. ,
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'. ,
}
,
Required: False ,
}
enum ,
networkMode:
{
Description: This cannot be specified if networkPlugin is anything other than 'azure'. ,
Enum:
{
transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information. ,
bridge: This is no longer supported ,
}
,
Required: False ,
}
enum ,
networkDataplane:
{
Description: Network dataplane used in the Kubernetes cluster. ,
Enum:
{
azure: Use Azure network dataplane. ,
cilium: Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information. ,
}
,
Required: False ,
}
enum ,
advancedNetworking:
{
Description: Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. ,
Required: False ,
}
boolean ,
observability:
{
Description: Observability profile to enable advanced network metrics and flow logs with historical contexts. ,
Required: False ,
}
{
enabled:
{
Description: Indicates the enablement of Advanced Networking observability functionalities on clusters. ,
Required: False ,
}
boolean ,
}
,
security:
{
Description: Security profile to enable security features on cilium based cluster. ,
Required: False ,
}
{
enabled:
{
Description: This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
podCidr:
{
Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. ,
Required: False ,
}
string ,
dnsServiceIP:
{
Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. ,
Required: False ,
}
string ,
outboundType:
{
Description: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). ,
Enum:
{
loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer). ,
userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting). ,
managedNATGateway: The AKS-managed NAT gateway is used for egress. ,
userAssignedNATGateway: The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration. ,
none: The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/ ,
}
,
Required: False ,
}
enum ,
loadBalancerSku:
{
Description: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. ,
Enum:
{
standard: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article. ,
basic: Use a basic Load Balancer with limited functionality. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: Profile of the cluster load balancer. ,
Required: False ,
}
{
managedOutboundIPs:
{
Description: Desired managed outbound IPs for the cluster load balancer. ,
Required: False ,
}
{
count:
{
Description: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
countIPv6:
{
Description: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outboundIPPrefixes:
{
Description: Desired outbound IP Prefix resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPPrefixes:
{
Description: A list of public IP prefix resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIPs:
{
Description: Desired outbound IP resources for the cluster load balancer. ,
Required: False ,
}
{
publicIPs:
{
Description: A list of public IP resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allocatedOutboundPorts:
{
Description: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
enableMultipleStandardLoadBalancers:
{
Description: Enable multiple standard load balancers per AKS cluster or not. ,
Required: False ,
}
boolean ,
backendPoolType:
{
Description: The type of the managed inbound Load Balancer BackendPool. ,
Enum:
{
NodeIPConfiguration: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
NodeIP: The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend. ,
}
,
Required: False ,
}
enum ,
}
,
natGatewayProfile:
{
Description: Profile of the cluster NAT gateway. ,
Required: False ,
}
{
managedOutboundIPProfile:
{
Description: Profile of the managed outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
{
count:
{
Description: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIPs:
{
Description: The effective outbound IP resources of the cluster NAT gateway. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
idleTimeoutInMinutes:
{
Description: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
podCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
}
,
aadProfile:
{
Description: The Azure Active Directory configuration. ,
Required: False ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: The auto upgrade configuration. ,
Required: False ,
}
{
upgradeChannel:
{
Description: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). ,
Enum:
{
rapid: Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1. ,
stable: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6. ,
patch: Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9. ,
node-image: Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching ,
none: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. ,
}
,
Required: False ,
}
enum ,
nodeOSUpgradeChannel:
{
Description: Manner in which the OS on your nodes is updated. The default is NodeImage. ,
Enum:
{
Unmanaged: OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice ,
None: No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates ,
NodeImage: AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images. ,
SecurityPatch: AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeSettings:
{
Description: Settings for upgrading a cluster. ,
Required: False ,
}
{
overrideSettings:
{
Description: Settings for overrides. ,
Required: False ,
}
{
forceUpgrade:
{
Description: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. ,
Required: False ,
}
boolean ,
until:
{
Description: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when enabled ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
daemonset-eviction-for-empty-nodes:
{
Description: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
daemonset-eviction-for-occupied-nodes:
{
Description: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. ,
Required: False ,
}
boolean ,
ignore-daemonsets-utilization:
{
Description: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. ,
Required: False ,
}
boolean ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. ,
most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
apiServerAccessProfile:
{
Description: The access profile for managed cluster API server. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). ,
Required: False ,
}
[
string ,
]
,
enablePrivateCluster:
{
Description: For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). ,
Required: False ,
}
boolean ,
privateDNSZone:
{
Description: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. ,
Required: False ,
}
string ,
enablePrivateClusterPublicFQDN:
{
Description: Whether to create additional public FQDN for private cluster or not. ,
Required: False ,
}
boolean ,
disableRunCommand:
{
Description: Whether to disable run command for the cluster or not. ,
Required: False ,
}
boolean ,
}
,
diskEncryptionSetID:
{
Description: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' ,
Format: arm-id ,
Required: False ,
}
string ,
identityProfile:
{
Description: The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ,
Required: False ,
}
object ,
privateLinkResources:
{
Description: Private link resources associated with the cluster. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAccounts:
{
Description: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). ,
Required: False ,
}
boolean ,
httpProxyConfig:
{
Description: Configurations for provisioning the cluster with HTTP proxy servers. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the managed cluster. ,
Required: False ,
}
{
defender:
{
Description: Microsoft Defender settings for the security profile. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
securityMonitoring:
{
Description: Microsoft Defender threat detection for Cloud settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Defender threat detection ,
Required: False ,
}
boolean ,
}
,
}
,
azureKeyVaultKms:
{
Description: Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Azure Key Vault key management service. The default is false. ,
Required: False ,
}
boolean ,
keyId:
{
Description: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. ,
Required: False ,
}
string ,
keyVaultNetworkAccess:
{
Description: Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultResourceId:
{
Description: Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
workloadIdentity:
{
Description: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable workload identity. ,
Required: False ,
}
boolean ,
}
,
imageCleaner:
{
Description: Image Cleaner settings for the security profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Image Cleaner on AKS cluster. ,
Required: False ,
}
boolean ,
intervalHours:
{
Description: Image Cleaner scanning interval in hours. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customCATrustCertificates:
{
Description: A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). ,
Required: False ,
}
[
string ,
]
,
}
,
storageProfile:
{
Description: Storage profile for the managed cluster. ,
Required: False ,
}
{
diskCSIDriver:
{
Description: AzureDisk CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureDisk CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
fileCSIDriver:
{
Description: AzureFile CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureFile CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
snapshotController:
{
Description: Snapshot Controller settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable Snapshot Controller. The default value is true. ,
Required: False ,
}
boolean ,
}
,
blobCSIDriver:
{
Description: AzureBlob CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable AzureBlob CSI Driver. The default value is false. ,
Required: False ,
}
boolean ,
}
,
}
,
ingressProfile:
{
Description: Ingress profile for the managed cluster. ,
Required: False ,
}
{
webAppRouting:
{
Description: App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable the Application Routing add-on. ,
Required: False ,
}
boolean ,
dnsZoneResourceIds:
{
Description: Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the user assigned identity. ,
Format: arm-id ,
Required: False ,
}
string ,
clientId:
{
Description: The client ID of the user assigned identity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object ID of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Allow or deny public network access for AKS ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
workloadAutoScalerProfile:
{
Description: Workload Auto-scaler profile for the managed cluster. ,
Required: False ,
}
{
keda:
{
Description: KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable KEDA. ,
Required: True ,
}
boolean ,
}
,
verticalPodAutoscaler:
{
Description: VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable VPA. Default value is false. ,
Required: True ,
}
boolean ,
}
,
}
,
azureMonitorProfile:
{
Description: Azure Monitor addon profiles for monitoring the managed cluster. ,
Required: False ,
}
{
metrics:
{
Description: Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. ,
Required: True ,
}
boolean ,
kubeStateMetrics:
{
Description: Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. ,
Required: False ,
}
{
metricLabelsAllowlist:
{
Description: Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
metricAnnotationsAllowList:
{
Description: Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceMeshProfile:
{
Description: Service mesh profile for a managed cluster. ,
Required: False ,
}
{
mode:
{
Description: Mode of the service mesh. ,
Enum:
{
Istio: Istio deployed as an AKS addon. ,
Disabled: Mesh is disabled. ,
}
,
Required: True ,
}
enum ,
istio:
{
Description: Istio service mesh configuration. ,
Required: False ,
}
{
components:
{
Description: Istio components configuration. ,
Required: False ,
}
{
ingressGateways:
{
Description: Istio ingress gateways. ,
Required: False ,
}
[
{
mode:
{
Description: Mode of an ingress gateway. ,
Enum:
{
External: The ingress gateway is assigned a public IP address and is publicly accessible. ,
Internal: The ingress gateway is assigned an internal IP address and cannot is accessed publicly. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: Whether to enable the ingress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
egressGateways:
{
Description: Istio egress gateways. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether to enable the egress gateway. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
certificateAuthority:
{
Description: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca ,
Required: False ,
}
{
plugin:
{
Description: Plugin certificates information for Service Mesh. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the Key Vault. ,
Format: arm-id ,
Required: False ,
}
string ,
certObjectName:
{
Description: Intermediate certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
keyObjectName:
{
Description: Intermediate certificate private key object name in Azure Key Vault. ,
Required: False ,
}
string ,
rootCertObjectName:
{
Description: Root certificate object name in Azure Key Vault. ,
Required: False ,
}
string ,
certChainObjectName:
{
Description: Certificate chain object name in Azure Key Vault. ,
Required: False ,
}
string ,
}
,
}
,
revisions:
{
Description: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceUID:
{
Description: The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) ,
Required: False ,
}
string ,
metricsProfile:
{
Description: Optional cluster metrics configuration. ,
Required: False ,
}
{
costAnalysis:
{
Description: The cost analysis configuration for the cluster ,
Required: False ,
}
{
enabled:
{
Description: The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. ,
Required: False ,
}
boolean ,
}
,
}
,
bootstrapProfile:
{
Description: Profile of the cluster bootstrap configuration. ,
Required: False ,
}
{
artifactSource:
{
Description: The source where the artifacts are downloaded from. ,
Enum:
{
Direct: pull images from Microsoft Artifact Registry ,
Cache: pull images from Azure Container Registry with cache ,
}
,
Required: False ,
}
enum ,
containerRegistryId:
{
Description: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_Delete (new)
Description :  Deletes a managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MaintenanceConfigurations_ListByManagedCluster (new)
Description :  Gets a list of maintenance configurations in the specified managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of maintenance configurations. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a default maintenance configuration. ,
Required: False ,
}
{
timeInWeek:
{
Description: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
hourSlots:
{
Description: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
notAllowedTime:
{
Description: Time slots on which upgrade is not allowed. ,
Required: False ,
}
[
{
start:
{
Description: The start of a time span ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end of a time span ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window for the maintenance configuration. ,
Required: False ,
}
{
schedule:
{
Description: Recurrence schedule for the maintenance window. ,
Required: True ,
}
{
daily:
{
Description: For schedules like: 'recur every day' or 'recur every 3 days'. ,
Required: False ,
}
{
intervalDays:
{
Description: Specifies the number of days between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
weekly:
{
Description: For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. ,
Required: False ,
}
{
intervalWeeks:
{
Description: Specifies the number of weeks between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
absoluteMonthly:
{
Description: For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfMonth:
{
Description: The date of the month. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
relativeMonthly:
{
Description: For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
weekIndex:
{
Description: Specifies on which week of the month the dayOfWeek applies. ,
Enum:
{
First: First week of the month. ,
Second: Second week of the month. ,
Third: Third week of the month. ,
Fourth: Fourth week of the month. ,
Last: Last week of the month. ,
}
,
Required: True ,
}
enum ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
durationHours:
{
Description: Length of maintenance window range from 4 to 24 hours. ,
Format: int32 ,
Required: True ,
}
integer ,
utcOffset:
{
Description: The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. ,
Required: False ,
}
string ,
startDate:
{
Description: The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. ,
Format: date ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ,
Required: True ,
}
string ,
notAllowedDates:
{
Description: Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ,
Required: False ,
}
[
{
start:
{
Description: The start date of the date span. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: The end date of the date span. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of maintenance configuration results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MaintenanceConfigurations_Get (new)
Description :  Gets the specified maintenance configuration of a managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
configName:
{
Description: The name of the maintenance configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a default maintenance configuration. ,
Required: False ,
}
{
timeInWeek:
{
Description: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
hourSlots:
{
Description: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
notAllowedTime:
{
Description: Time slots on which upgrade is not allowed. ,
Required: False ,
}
[
{
start:
{
Description: The start of a time span ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end of a time span ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window for the maintenance configuration. ,
Required: False ,
}
{
schedule:
{
Description: Recurrence schedule for the maintenance window. ,
Required: True ,
}
{
daily:
{
Description: For schedules like: 'recur every day' or 'recur every 3 days'. ,
Required: False ,
}
{
intervalDays:
{
Description: Specifies the number of days between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
weekly:
{
Description: For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. ,
Required: False ,
}
{
intervalWeeks:
{
Description: Specifies the number of weeks between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
absoluteMonthly:
{
Description: For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfMonth:
{
Description: The date of the month. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
relativeMonthly:
{
Description: For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
weekIndex:
{
Description: Specifies on which week of the month the dayOfWeek applies. ,
Enum:
{
First: First week of the month. ,
Second: Second week of the month. ,
Third: Third week of the month. ,
Fourth: Fourth week of the month. ,
Last: Last week of the month. ,
}
,
Required: True ,
}
enum ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
durationHours:
{
Description: Length of maintenance window range from 4 to 24 hours. ,
Format: int32 ,
Required: True ,
}
integer ,
utcOffset:
{
Description: The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. ,
Required: False ,
}
string ,
startDate:
{
Description: The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. ,
Format: date ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ,
Required: True ,
}
string ,
notAllowedDates:
{
Description: Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ,
Required: False ,
}
[
{
start:
{
Description: The start date of the date span. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: The end date of the date span. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MaintenanceConfigurations_CreateOrUpdate (new)
Description :  Creates or updates a maintenance configuration in the specified managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
configName:
{
Description: The name of the maintenance configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The maintenance configuration to create or update. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a default maintenance configuration. ,
Required: False ,
}
{
timeInWeek:
{
Description: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
hourSlots:
{
Description: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
notAllowedTime:
{
Description: Time slots on which upgrade is not allowed. ,
Required: False ,
}
[
{
start:
{
Description: The start of a time span ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end of a time span ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window for the maintenance configuration. ,
Required: False ,
}
{
schedule:
{
Description: Recurrence schedule for the maintenance window. ,
Required: True ,
}
{
daily:
{
Description: For schedules like: 'recur every day' or 'recur every 3 days'. ,
Required: False ,
}
{
intervalDays:
{
Description: Specifies the number of days between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
weekly:
{
Description: For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. ,
Required: False ,
}
{
intervalWeeks:
{
Description: Specifies the number of weeks between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
absoluteMonthly:
{
Description: For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfMonth:
{
Description: The date of the month. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
relativeMonthly:
{
Description: For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
weekIndex:
{
Description: Specifies on which week of the month the dayOfWeek applies. ,
Enum:
{
First: First week of the month. ,
Second: Second week of the month. ,
Third: Third week of the month. ,
Fourth: Fourth week of the month. ,
Last: Last week of the month. ,
}
,
Required: True ,
}
enum ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
durationHours:
{
Description: Length of maintenance window range from 4 to 24 hours. ,
Format: int32 ,
Required: True ,
}
integer ,
utcOffset:
{
Description: The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. ,
Required: False ,
}
string ,
startDate:
{
Description: The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. ,
Format: date ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ,
Required: True ,
}
string ,
notAllowedDates:
{
Description: Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ,
Required: False ,
}
[
{
start:
{
Description: The start date of the date span. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: The end date of the date span. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a default maintenance configuration. ,
Required: False ,
}
{
timeInWeek:
{
Description: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
hourSlots:
{
Description: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
notAllowedTime:
{
Description: Time slots on which upgrade is not allowed. ,
Required: False ,
}
[
{
start:
{
Description: The start of a time span ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end of a time span ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window for the maintenance configuration. ,
Required: False ,
}
{
schedule:
{
Description: Recurrence schedule for the maintenance window. ,
Required: True ,
}
{
daily:
{
Description: For schedules like: 'recur every day' or 'recur every 3 days'. ,
Required: False ,
}
{
intervalDays:
{
Description: Specifies the number of days between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
weekly:
{
Description: For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. ,
Required: False ,
}
{
intervalWeeks:
{
Description: Specifies the number of weeks between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
absoluteMonthly:
{
Description: For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfMonth:
{
Description: The date of the month. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
relativeMonthly:
{
Description: For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
weekIndex:
{
Description: Specifies on which week of the month the dayOfWeek applies. ,
Enum:
{
First: First week of the month. ,
Second: Second week of the month. ,
Third: Third week of the month. ,
Fourth: Fourth week of the month. ,
Last: Last week of the month. ,
}
,
Required: True ,
}
enum ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
durationHours:
{
Description: Length of maintenance window range from 4 to 24 hours. ,
Format: int32 ,
Required: True ,
}
integer ,
utcOffset:
{
Description: The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. ,
Required: False ,
}
string ,
startDate:
{
Description: The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. ,
Format: date ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ,
Required: True ,
}
string ,
notAllowedDates:
{
Description: Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ,
Required: False ,
}
[
{
start:
{
Description: The start date of the date span. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: The end date of the date span. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a default maintenance configuration. ,
Required: False ,
}
{
timeInWeek:
{
Description: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
hourSlots:
{
Description: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
notAllowedTime:
{
Description: Time slots on which upgrade is not allowed. ,
Required: False ,
}
[
{
start:
{
Description: The start of a time span ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: The end of a time span ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window for the maintenance configuration. ,
Required: False ,
}
{
schedule:
{
Description: Recurrence schedule for the maintenance window. ,
Required: True ,
}
{
daily:
{
Description: For schedules like: 'recur every day' or 'recur every 3 days'. ,
Required: False ,
}
{
intervalDays:
{
Description: Specifies the number of days between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
weekly:
{
Description: For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. ,
Required: False ,
}
{
intervalWeeks:
{
Description: Specifies the number of weeks between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
absoluteMonthly:
{
Description: For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
dayOfMonth:
{
Description: The date of the month. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
relativeMonthly:
{
Description: For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. ,
Required: False ,
}
{
intervalMonths:
{
Description: Specifies the number of months between each set of occurrences. ,
Format: int32 ,
Required: True ,
}
integer ,
weekIndex:
{
Description: Specifies on which week of the month the dayOfWeek applies. ,
Enum:
{
First: First week of the month. ,
Second: Second week of the month. ,
Third: Third week of the month. ,
Fourth: Fourth week of the month. ,
Last: Last week of the month. ,
}
,
Required: True ,
}
enum ,
dayOfWeek:
{
Description: Specifies on which day of the week the maintenance occurs. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
durationHours:
{
Description: Length of maintenance window range from 4 to 24 hours. ,
Format: int32 ,
Required: True ,
}
integer ,
utcOffset:
{
Description: The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. ,
Required: False ,
}
string ,
startDate:
{
Description: The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. ,
Format: date ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ,
Required: True ,
}
string ,
notAllowedDates:
{
Description: Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ,
Required: False ,
}
[
{
start:
{
Description: The start date of the date span. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: The end date of the date span. ,
Format: date ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MaintenanceConfigurations_Delete (new)
Description :  Deletes a maintenance configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
configName:
{
Description: The name of the maintenance configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_AbortLatestOperation (new)
Description :  Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_List (new)
Description :  Gets a list of agent pools in the specified managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of agent pools. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of agent pool results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_Get (new)
Description :  Gets the specified managed cluster agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_CreateOrUpdate (new)
Description :  Creates or updates an agent pool in the specified managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
parameters:
{
Description: The agent pool to create or update. ,
Required: True ,
}
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_Delete (new)
Description :  Deletes an agent pool in the specified managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
ignore-pod-disruption-budget:
{
Description: ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget ,
Required: False ,
}
boolean ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_GetUpgradeProfile (new)
Description :  Gets the upgrade profile for an agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the agent pool upgrade profile. ,
Required: False ,
}
string ,
name:
{
Description: The name of the agent pool upgrade profile. ,
Required: False ,
}
string ,
type:
{
Description: The type of the agent pool upgrade profile. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the agent pool upgrade profile. ,
Required: True ,
}
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: True ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: True ,
}
enum ,
upgrades:
{
Description: List of orchestrator types and versions available for upgrade. ,
Required: False ,
}
[
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether the Kubernetes version is currently in preview. ,
Required: False ,
}
boolean ,
}
,
]
,
latestNodeImageVersion:
{
Description: The latest AKS supported node image version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_DeleteMachines (new)
Description :  Deletes specific machines in an agent pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
machines:
{
Description: A list of machines from the agent pool to be deleted. ,
Required: True ,
}
{
machineNames:
{
Description: The agent pool machine names. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_GetAvailableAgentPoolVersions (new)
Description :  See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the agent pool version list. ,
Required: False ,
}
string ,
name:
{
Description: The name of the agent pool version list. ,
Required: False ,
}
string ,
type:
{
Description: Type of the agent pool version list. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of agent pool available versions. ,
Required: True ,
}
{
agentPoolVersions:
{
Description: List of versions available for agent pool. ,
Required: False ,
}
[
{
default:
{
Description: Whether this version is the default agent pool version. ,
Required: False ,
}
boolean ,
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether Kubernetes version is currently in preview. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ResetServicePrincipalProfile (new)
Description :  This action cannot be performed on a cluster that is not using a service principal
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The service principal profile to set on the managed cluster. ,
Required: True ,
}
{
clientId:
{
Description: The ID for the service principal. ,
Required: True ,
}
string ,
secret:
{
Description: The secret password associated with the service principal in plain text. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ResetAADProfile (new)
Description :  **WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The AAD profile to set on the Managed Cluster ,
Required: True ,
}
{
managed:
{
Description: Whether to enable managed AAD. ,
Required: False ,
}
boolean ,
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
clientAppID:
{
Description: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppID:
{
Description: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
serverAppSecret:
{
Description: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. ,
Required: False ,
}
string ,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_RotateClusterCertificates (new)
Description :  See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_AbortLatestOperation (new)
Description :  Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_RotateServiceAccountSigningKeys (new)
Description :  Rotates the service account signing keys of a managed cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_Stop (new)
Description :  This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_Start (new)
Description :  See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private endpoint connection. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the private endpoint connection. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Update (new)
Description :  Updates a private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The updated private endpoint connection. ,
Required: True ,
}
{
id:
{
Description: The ID of the private endpoint connection. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the private endpoint connection. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The ID of the private endpoint connection. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private endpoint connection. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_UpgradeNodeImageVersion (new)
Description :  Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Agent Pool. ,
}
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: 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 ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: 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 ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: 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 ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
gpuProfile:
{
Description: GPU settings for the Agent Pool. ,
Required: False ,
}
{
driver:
{
Description: Whether to install GPU drivers. When it's not specified, default is Install. ,
Enum:
{
Install: Install driver. ,
None: Skip driver install. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResources_List (new)
Description :  To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResolvePrivateLinkServiceId_POST (new)
Description :  Gets the private link service ID for the specified managed cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required in order to resolve a private link service ID. ,
Required: True ,
}
{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the private link resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the private link resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
groupId:
{
Description: The group ID of the resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The RequiredMembers of the resource ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceID:
{
Description: The private link service ID of the resource, this field is exposed only to NRP internally. ,
Format: arm-id ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_RunCommand (new)
Description :  AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
requestPayload:
{
Description: The run command request ,
Required: True ,
}
{
command:
{
Description: The command to run. ,
Required: True ,
}
string ,
context:
{
Description: A base64 encoded zip file containing the files required by the command. ,
Required: False ,
}
string ,
clusterToken:
{
Description: AuthToken issued for AKS AAD Server App. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The command id. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of command result. ,
Required: False ,
}
{
provisioningState:
{
Description: provisioning State ,
Required: False ,
}
string ,
exitCode:
{
Description: The exit code of the command ,
Format: int32 ,
Required: False ,
}
integer ,
startedAt:
{
Description: The time when the command started. ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: The time when the command finished. ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: The command output. ,
Required: False ,
}
string ,
reason:
{
Description: An explanation of why provisioningState is set to failed (if so). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_GetCommandResult (new)
Description :  Gets the results of a command which has been run on the Managed Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
commandId:
{
Description: Id of the command. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The command id. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of command result. ,
Required: False ,
}
{
provisioningState:
{
Description: provisioning State ,
Required: False ,
}
string ,
exitCode:
{
Description: The exit code of the command ,
Format: int32 ,
Required: False ,
}
integer ,
startedAt:
{
Description: The time when the command started. ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: The time when the command finished. ,
Format: date-time ,
Required: False ,
}
string ,
logs:
{
Description: The command output. ,
Required: False ,
}
string ,
reason:
{
Description: An explanation of why provisioningState is set to failed (if so). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
category:
{
Description: The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that AKS agent nodes connect to ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The Ports and Protocols used when connecting to domainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used for connection ,
Required: False ,
}
string ,
description:
{
Description: Description of the detail ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_List (new)
Description :  Gets a list of snapshots in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of snapshots. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of snapshot results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_ListByResourceGroup (new)
Description :  Lists snapshots in the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of snapshots. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of snapshot results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_Get (new)
Description :  Gets a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_CreateOrUpdate (new)
Description :  Creates or updates a snapshot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The snapshot to create or update. ,
Required: True ,
}
{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_UpdateTags (new)
Description :  Updates tags on a snapshot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update snapshot Tags operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a snapshot. ,
Required: False ,
}
{
creationData:
{
Description: CreationData to be used to specify the source agent pool resource ID to create this snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshotType:
{
Description: The type of a snapshot. The default is NodePool. ,
Enum:
{
NodePool: The snapshot is a snapshot of a node pool. ,
}
,
Required: False ,
}
enum ,
kubernetesVersion:
{
Description: The version of Kubernetes. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image. ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: 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. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: The size of the VM. ,
Required: False ,
}
string ,
enableFIPS:
{
Description: Whether to use a FIPS-enabled OS. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Snapshots_Delete (new)
Description :  Deletes a snapshot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListMeshRevisionProfiles (new)
Description :  Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of service mesh add-on revision profiles for all supported mesh modes. ,
Required: False ,
}
[
{
properties:
{
Description: Mesh revision profile properties for a mesh ,
Required: False ,
}
{
meshRevisions:
{
Required: False ,
}
[
{
revision:
{
Description: The revision of the mesh release. ,
Required: False ,
}
string ,
upgrades:
{
Description: List of revisions available for upgrade of a specific mesh revision ,
Required: False ,
}
[
string ,
]
,
compatibleWith:
{
Description: List of items this revision of service mesh is compatible with, and their associated versions. ,
Required: False ,
}
[
{
name:
{
Description: The product/service name. ,
Required: False ,
}
string ,
versions:
{
Description: Product/service versions compatible with a service mesh add-on revision. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of mesh revision profile. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_GetMeshRevisionProfile (new)
Description :  Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
mode:
{
Description: The mode of the mesh. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mesh revision profile properties for a mesh ,
Required: False ,
}
{
meshRevisions:
{
Required: False ,
}
[
{
revision:
{
Description: The revision of the mesh release. ,
Required: False ,
}
string ,
upgrades:
{
Description: List of revisions available for upgrade of a specific mesh revision ,
Required: False ,
}
[
string ,
]
,
compatibleWith:
{
Description: List of items this revision of service mesh is compatible with, and their associated versions. ,
Required: False ,
}
[
{
name:
{
Description: The product/service name. ,
Required: False ,
}
string ,
versions:
{
Description: Product/service versions compatible with a service mesh add-on revision. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_ListMeshUpgradeProfiles (new)
Description :  Lists available upgrades for all service meshes in a specific cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of supported service mesh add-on upgrade profiles. ,
Required: False ,
}
[
{
properties:
{
Description: Mesh upgrade profile properties for a major.minor release. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of mesh upgrade profile. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ManagedClusters_GetMeshUpgradeProfile (new)
Description :  Gets available upgrades for a service mesh in a cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
mode:
{
Description: The mode of the mesh. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mesh upgrade profile properties for a major.minor release. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrustedAccessRoleBindings_List (new)
Description :  List trusted access role bindings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Role binding list ,
Required: False ,
}
[
{
properties:
{
Description: Properties for trusted access role binding ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of trusted access role binding. ,
Enum:
{
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ARM resource ID of source resource that trusted access is configured for. ,
Format: arm-id ,
Required: True ,
}
string ,
roles:
{
Description: A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrustedAccessRoleBindings_Get (new)
Description :  Get a trusted access role binding.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
trustedAccessRoleBindingName:
{
Description: The name of trusted access role binding. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for trusted access role binding ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of trusted access role binding. ,
Enum:
{
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ARM resource ID of source resource that trusted access is configured for. ,
Format: arm-id ,
Required: True ,
}
string ,
roles:
{
Description: A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrustedAccessRoleBindings_CreateOrUpdate (new)
Description :  Create or update a trusted access role binding
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
trustedAccessRoleBindingName:
{
Description: The name of trusted access role binding. ,
Required: True ,
}
string ,
trustedAccessRoleBinding:
{
Description: A trusted access role binding ,
Required: True ,
}
{
properties:
{
Description: Properties for trusted access role binding ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of trusted access role binding. ,
Enum:
{
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ARM resource ID of source resource that trusted access is configured for. ,
Format: arm-id ,
Required: True ,
}
string ,
roles:
{
Description: A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for trusted access role binding ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of trusted access role binding. ,
Enum:
{
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ARM resource ID of source resource that trusted access is configured for. ,
Format: arm-id ,
Required: True ,
}
string ,
roles:
{
Description: A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties for trusted access role binding ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of trusted access role binding. ,
Enum:
{
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ARM resource ID of source resource that trusted access is configured for. ,
Format: arm-id ,
Required: True ,
}
string ,
roles:
{
Description: A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrustedAccessRoleBindings_Delete (new)
Description :  Delete a trusted access role binding.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
trustedAccessRoleBindingName:
{
Description: The name of trusted access role binding. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrustedAccessRoles_List (new)
Description :  List supported trusted access roles.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Role list ,
Required: False ,
}
[
{
sourceResourceType:
{
Description: Resource type of Azure resource ,
Required: False ,
}
string ,
name:
{
Description: Name of role, name is unique under a source resource type ,
Required: False ,
}
string ,
rules:
{
Description: List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole). ,
Required: False ,
}
[
{
verbs:
{
Description: List of allowed verbs ,
Required: False ,
}
[
string ,
]
,
apiGroups:
{
Description: List of allowed apiGroups ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: List of allowed resources ,
Required: False ,
}
[
string ,
]
,
resourceNames:
{
Description: List of allowed names ,
Required: False ,
}
[
string ,
]
,
nonResourceURLs:
{
Description: List of allowed nonResourceURLs ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_List (new)
Description :  Gets a list of machines in the specified agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to get the next set of machine results. ,
Format: uri ,
Required: False ,
}
string ,
value:
{
Description: The list of Machines in cluster. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the machine ,
Required: False ,
}
{
network:
{
Description: network properties of the machine ,
Required: False ,
}
{
ipAddresses:
{
Description: IPv4, IPv6 addresses of the machine ,
Required: False ,
}
[
{
family:
{
Description: To determine if address belongs IPv4 or IPv6 family ,
Enum:
{
IPv4: IPv4 family ,
IPv6: IPv6 family ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: IPv4 or IPv6 address of the machine ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceId:
{
Description: Azure resource id of the machine. It can be used to GET underlying VM Instance ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Get (new)
Description :  Get a specific machine in the specified agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
machineName:
{
Description: host name of the machine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the machine ,
Required: False ,
}
{
network:
{
Description: network properties of the machine ,
Required: False ,
}
{
ipAddresses:
{
Description: IPv4, IPv6 addresses of the machine ,
Required: False ,
}
[
{
family:
{
Description: To determine if address belongs IPv4 or IPv6 family ,
Enum:
{
IPv4: IPv4 family ,
IPv6: IPv6 family ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: IPv4 or IPv6 address of the machine ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceId:
{
Description: Azure resource id of the machine. It can be used to GET underlying VM Instance ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}