@azure/arm-containerservice package

For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.

Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.

Observability profile to enable advanced network metrics and flow logs with historical contexts.

Security profile to enable security features on cilium-based cluster.

Agent Pool.

The list of available versions for an agent pool.

Specifies a list of machine names from the agent pool to be deleted.

Profile of the managed cluster gateway agent pool.

The response from the List Agent Pools operation.

Network settings of an agent pool.

The security settings of an agent pool.

Contains read-only information about the Agent Pool.

The list of available upgrades for an agent pool.

Settings for upgrading an agentpool

The Windows agent pool's specific profile.

Interface representing a AgentPools.

Defines headers for AgentPools_abortLatestOperation operation.

Optional parameters.

Optional parameters.

Defines headers for AgentPools_delete operation.

Defines headers for AgentPools_deleteMachines operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for AgentPools_upgradeNodeImageVersion operation.

Optional parameters.

Specifications on auto-scaling.

Azure Key Vault key management service settings for the security profile.

An error response from the Container service.

An error response from the Container service.

Settings for upgrading a cluster.

Version information about a product/service that is compatible with a service mesh revision.

components of given Kubernetes version.

Interface representing a ContainerService.

Optional parameters.

Profile for Linux VMs in the container service cluster.

Optional parameters.

Optional parameters.

Profile of network configuration.

Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v<version>.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where <version> is represented by a <major version>-<minor version> string. Kubernetes version 1.23 would be '1-23'.

Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'.

SSH configuration for Linux-based VMs running on Azure.

Contains information about SSH certificate public key data.

Data used when creating a target resource from a source resource.

The credential result response.

The list credential result response.

For schedules like: 'recur every day' or 'recur every 3 days'.

For example, between '2022-12-23' and '2023-01-05'.

Delegated resource properties - internal use only.

A ___domain name that AKS agent nodes are reaching at.

connect information from the AKS agent nodes to a single endpoint.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

The complex type of the extended ___location.

Available Guardrails Version

Hold values properties, which is array of GuardrailsVersions

Whether the version is default or not and support info.

Contains the IPTag associated with the object.

Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca

Istio components configuration.

Istio egress gateway configuration.

Istio ingress gateway configuration. For now, we support up to one external ingress gateway named aks-istio-ingressgateway-external and one internal ingress gateway named aks-istio-ingressgateway-internal.

Plugin certificates information for Service Mesh.

Istio service mesh configuration.

See AKS custom node configuration for more details.

Kubernetes patch version profile

Kubernetes version profile for given major.minor release.

Capabilities on this Kubernetes version.

Hold values properties, which is array of KubernetesVersion

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

See AKS custom node configuration for more details.

The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named kubernetes. The name field will be the name of the corresponding public load balancer. There will be an internal load balancer created if needed, and the name will be <name>-internal. The internal lb shares the same configurations as the external one. The internal lbs are not needed to be included in LoadBalancer list.

The response from the List Load Balancers operation.

Interface representing a LoadBalancers.

Optional parameters.

Defines headers for LoadBalancers_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Overrides for localDNS profile.

Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.

A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.

The machine IP address details.

The response from the List Machines operation.

network properties of the machine

The properties of the machine

Interface representing a Machines.

Optional parameters.

Optional parameters.

Optional parameters.

See planned maintenance for more information about planned maintenance.

The response from the List maintenance configurations operation.

Interface representing a MaintenanceConfigurations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.

Managed cluster.

For more details see managed AAD on AKS.

When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.

Access profile for managed cluster API server.

Managed cluster Access Profile.

A Kubernetes add-on profile for a managed cluster.

Information of user assigned identity used by this add-on.

Profile for the container service agent pool.

Properties for the container service agent pool profile.

Auto upgrade profile for a managed cluster.

Prometheus addon profile for the container service cluster

Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.

Kube State Metrics for prometheus addon profile for the container service cluster

Metrics profile for the prometheus service addon

The bootstrap profile.

The cost analysis configuration for the cluster

Cluster HTTP proxy configuration.

Identity for the managed cluster.

Ingress profile for the container service cluster.

Web App Routing settings for the ingress profile.

The response from the List Managed Clusters operation.

Profile of the managed cluster load balancer.

Desired managed outbound IPs for the cluster load balancer.

Desired outbound IP Prefix resources for the cluster load balancer.

Desired outbound IP resources for the cluster load balancer.

Profile of the managed outbound IP resources of the managed cluster.

The metrics profile for the ManagedCluster.

Profile of the managed cluster NAT gateway.

Node resource group lockdown profile for a managed cluster.

The OIDC issuer profile of the Managed Cluster.

Details about the pod identity assigned to the Managed Cluster.

See disable AAD Pod Identity for a specific Pod/Application for more details.

See use AAD pod identity for more details on pod identity integration.

An error response from the pod identity provisioning.

An error response from the pod identity provisioning.

The list of available upgrade versions.

Parameters to be applied to the cluster-autoscaler when enabled

managed cluster properties for snapshot, these properties are read only.

The SKU of a Managed Cluster.

Security profile for the container service cluster.

Microsoft Defender settings for the security profile.

Microsoft Defender settings for security gating, validates container images eligibility for deployment based on Defender for Containers security findings. Using Admission Controller, it either audits or prevents the deployment of images that do not meet security standards.

Microsoft Defender settings for the security profile threat detection.

Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile.

Image integrity related settings for the security profile.

Node Restriction settings for the security profile.

Workload identity settings for the security profile.

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

A managed cluster snapshot resource.

The response from the List Managed Cluster Snapshots operation.

Interface representing a ManagedClusterSnapshots.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The Static Egress Gateway addon configuration for the cluster.

Contains read-only information about the Managed Cluster.

Storage profile for the container service cluster.

AzureBlob CSI Driver settings for the storage profile.

AzureDisk CSI Driver settings for the storage profile.

AzureFile CSI Driver settings for the storage profile.

Snapshot Controller settings for the storage profile.

The list of available upgrades for compute pools.

Profile for Windows VMs in the managed cluster.

Workload Auto-scaler profile for the managed cluster.

KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.

Interface representing a ManagedClusters.

Defines headers for ManagedClusters_abortLatestOperation operation.

Optional parameters.

Optional parameters.

Defines headers for ManagedClusters_delete operation.

Optional parameters.

Optional parameters.

Defines headers for ManagedClusters_getCommandResult operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for ManagedClusters_rebalanceLoadBalancers operation.

Optional parameters.

Defines headers for ManagedClusters_resetAADProfile operation.

Optional parameters.

Defines headers for ManagedClusters_resetServicePrincipalProfile operation.

Optional parameters.

Defines headers for ManagedClusters_rotateClusterCertificates operation.

Optional parameters.

Defines headers for ManagedClusters_rotateServiceAccountSigningKeys operation.

Optional parameters.

Defines headers for ManagedClusters_runCommand operation.

Optional parameters.

Defines headers for ManagedClusters_start operation.

Optional parameters.

Defines headers for ManagedClusters_stop operation.

Optional parameters.

Optional parameters.

Namespace managed by ARM.

The result of a request to list managed namespaces in a managed cluster.

Interface representing a ManagedNamespaces.

Optional parameters.

Defines headers for ManagedNamespaces_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Specifications on number of machines.

Holds information on upgrades and compatibility for given major.minor mesh release.

Mesh revision profile for a mesh.

Holds an array of MeshRevisionsProfiles

Mesh revision profile properties for a mesh

Upgrade profile for given mesh.

Holds an array of MeshUpgradeProfiles

Mesh upgrade profile properties for a major.minor release.

Properties of a namespace managed by ARM

Default network policy of the namespace, specifying ingress and egress rules.

network profile for managed cluster snapshot, these properties are read only.

node image version profile for given major.minor.patch release.

Holds an array NodeImageVersions

The List Operation response.

The current status of an async operation.

Optional parameters.

Optional parameters.

The operations list. It contains an URL link to get the next set of results.

Optional parameters.

Optional parameters.

Interface representing a OperationStatusResultOperations.

Describes the properties of a Operation value.

Interface representing a Operations.

Optional parameters.

Egress endpoints which AKS agent nodes connect to for common purpose.

Collection of OutboundEnvironmentEndpoint

The port range.

Describes the Power State of the cluster

Private endpoint which a connection belongs to.

A private endpoint connection

A list of private endpoint connections

Interface representing a PrivateEndpointConnections.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A private link resource

Interface representing a PrivateLinkResources.

Optional parameters.

A list of private link resources

The state of a private link service connection.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a ___location

The names of the load balancers to rebalance. If set to empty, all load balancers will be rebalanced.

For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.

Interface representing a ResolvePrivateLinkServiceId.

Optional parameters.

Common fields that are returned in the response for all Azure Resource Manager resources

Resource quota for the namespace.

A reference to an Azure resource.

A run command request

run command result.

Available Safeguards Version

Hold values properties, which is array of SafeguardsVersions

Whether the version is default or not and support info.

The Safeguards profile.

Specifications on how to scale a VirtualMachines agent pool.

One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule.

The scheduler profile for a single scheduler instance.

The pod scheduler profile for the cluster.

Mapping of each scheduler instance to its profile.

Service mesh profile for a managed cluster.

A node pool snapshot resource.

The response from the List Snapshots operation.

Interface representing a Snapshots.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Reference to another subresource.

Sysctl settings for Linux agent nodes.

Metadata pertaining to creation and last modification of the resource.

Tags object for patch operations.

Time in a week.

For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a '___location'

Trusted access role definition.

Defines binding between a resource and role

List of trusted access role bindings

Interface representing a TrustedAccessRoleBindings.

Optional parameters.

Defines headers for TrustedAccessRoleBindings_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

List of trusted access roles

Rule for trusted access role

Interface representing a TrustedAccessRoles.

Optional parameters.

Optional parameters.

Settings for overrides when upgrading a cluster.

Details about a user assigned identity.

Current status on a group of nodes of the same vm size.

Specifications on VirtualMachines agent pool.

For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.

Windows gMSA Profile in the managed cluster.

Defines values for AddonAutoscaling.
KnownAddonAutoscaling can be used interchangeably with AddonAutoscaling, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Feature to autoscale AKS-managed add-ons is enabled. The default VPA update mode is Initial mode.
Disabled: Feature to autoscale AKS-managed add-ons is disabled.

Defines values for AdoptionPolicy.
KnownAdoptionPolicy can be used interchangeably with AdoptionPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Never: If the namespace already exists in Kubernetes, attempts to create that same namespace in ARM will fail.
IfIdentical: Take over the existing namespace to be managed by ARM, if there is no difference.
Always: Always take over the existing namespace to be managed by ARM, some fields might be overwritten.

Defines values for AdvancedNetworkPolicies.
KnownAdvancedNetworkPolicies can be used interchangeably with AdvancedNetworkPolicies, this enum contains the known values that the service supports.

Known values supported by the service

L7: Enable Layer7 network policies (FQDN, HTTP/S, Kafka). This option is a superset of the FQDN option.
FQDN: Enable FQDN based network policies
None: Disable Layer 7 network policies (FQDN, HTTP/S, Kafka)

Defines values for AgentPoolMode.
KnownAgentPoolMode can be used interchangeably with AgentPoolMode, this enum contains the known values that the service supports.

Known values supported by the service

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.
Gateway: Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway.

Defines values for AgentPoolSSHAccess.
KnownAgentPoolSSHAccess can be used interchangeably with AgentPoolSSHAccess, this enum contains the known values that the service supports.

Known values supported by the service

LocalUser: Can SSH onto the node as a local user using private key.
Disabled: SSH service will be turned off on the node.

Defines values for AgentPoolType.
KnownAgentPoolType can be used interchangeably with AgentPoolType, this enum contains the known values that the service supports.

Known values supported by the service

VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set.
AvailabilitySet: Use of this is strongly discouraged.
VirtualMachines: Create an Agent Pool backed by a Single Instance VM orchestration mode.

Contains response data for the abortLatestOperation operation.

Contains response data for the createOrUpdate operation.

Contains response data for the deleteMachines operation.

Contains response data for the delete operation.

Contains response data for the getAvailableAgentPoolVersions operation.

Contains response data for the get operation.

Contains response data for the getUpgradeProfile operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for ArtifactSource.
KnownArtifactSource can be used interchangeably with ArtifactSource, this enum contains the known values that the service supports.

Known values supported by the service

Cache: pull images from Azure Container Registry with cache
Direct: pull images from Microsoft Artifact Registry

Defines values for BackendPoolType.
KnownBackendPoolType can be used interchangeably with BackendPoolType, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for ClusterServiceLoadBalancerHealthProbeMode.
KnownClusterServiceLoadBalancerHealthProbeMode can be used interchangeably with ClusterServiceLoadBalancerHealthProbeMode, this enum contains the known values that the service supports.

Known values supported by the service

ServiceNodePort: Each External Traffic Policy Cluster service will have its own health probe targeting service nodePort.
Shared: All External Traffic Policy Cluster services in a Standard Load Balancer will have a dedicated health probe targeting the backend nodes' kube-proxy health check port 10256.

Defines values for Code.
KnownCode can be used interchangeably with Code, this enum contains the known values that the service supports.

Known values supported by the service

Running: The cluster is running.
Stopped: The cluster is stopped.

Defines values for ConnectionStatus.
KnownConnectionStatus can be used interchangeably with ConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

Contains response data for the listNodeImageVersionsNext operation.

Contains response data for the listNodeImageVersions operation.

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for DeletePolicy.
KnownDeletePolicy can be used interchangeably with DeletePolicy, this enum contains the known values that the service supports.

Known values supported by the service

Keep: Only delete the ARM resource, keep the Kubernetes namespace. Also delete the ManagedByARM label.
Delete: Delete both the ARM resource and the Kubernetes namespace together.

Defines values for DriverType.
KnownDriverType can be used interchangeably with DriverType, this enum contains the known values that the service supports.

Known values supported by the service

GRID: Install the GRID driver for the GPU, suitable for applications requiring virtualization support.
CUDA: Install the CUDA driver for the GPU, optimized for computational tasks in scientific computing and data-intensive applications.

Defines values for Expander.
KnownExpander can be used interchangeably with Expander, this enum contains the known values that the service supports.

Known values supported by the service

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.
random: Used when you don't have a particular need for the node groups to scale differently.

Defines values for ExtendedLocationTypes.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone

Defines values for Format.
KnownFormat can be used interchangeably with Format, this enum contains the known values that the service supports.

Known values supported by the service

azure: Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26.
exec: Return exec format kubeconfig. This format requires kubelogin binary in the path.

Defines values for GPUDriver.
KnownGPUDriver can be used interchangeably with GPUDriver, this enum contains the known values that the service supports.

Known values supported by the service

Install: Install driver.
None: Skip driver install.

Defines values for GPUInstanceProfile.
KnownGPUInstanceProfile can be used interchangeably with GPUInstanceProfile, this enum contains the known values that the service supports.

Known values supported by the service

MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

Defines values for GuardrailsSupport.
KnownGuardrailsSupport can be used interchangeably with GuardrailsSupport, this enum contains the known values that the service supports.

Known values supported by the service

Preview: The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases.
Stable: The version is stable and can be used on critical production clusters.

Defines values for IpFamily.
KnownIpFamily can be used interchangeably with IpFamily, this enum contains the known values that the service supports.

Known values supported by the service

IPv4: IPv4 family
IPv6: IPv6 family

Defines values for IpvsScheduler.
KnownIpvsScheduler can be used interchangeably with IpvsScheduler, this enum contains the known values that the service supports.

Known values supported by the service

RoundRobin: Round Robin
LeastConnection: Least Connection

Defines values for IstioIngressGatewayMode.
KnownIstioIngressGatewayMode can be used interchangeably with IstioIngressGatewayMode, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for KeyVaultNetworkAccessTypes.
KnownKeyVaultNetworkAccessTypes can be used interchangeably with KeyVaultNetworkAccessTypes, this enum contains the known values that the service supports.

Known values supported by the service

Public
Private

Defines values for KubeletDiskType.
KnownKubeletDiskType can be used interchangeably with KubeletDiskType, this enum contains the known values that the service supports.

Known values supported by the service

OS: Kubelet will use the OS disk for its data.
Temporary: Kubelet will use the temporary disk for its data.

Defines values for KubernetesSupportPlan.
KnownKubernetesSupportPlan can be used interchangeably with KubernetesSupportPlan, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for Level.
KnownLevel can be used interchangeably with Level, this enum contains the known values that the service supports.

Known values supported by the service

Off
Warning
Enforcement

Defines values for LicenseType.
KnownLicenseType can be used interchangeably with LicenseType, this enum contains the known values that the service supports.

Known values supported by the service

None: No additional licensing is applied.
Windows_Server: Enables Azure Hybrid User Benefits for Windows VMs.

Defines values for LoadBalancerSku.
KnownLoadBalancerSku can be used interchangeably with LoadBalancerSku, this enum contains the known values that the service supports.

Known values supported by the service

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 article.
basic: Use a basic Load Balancer with limited functionality.

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByManagedClusterNext operation.

Contains response data for the listByManagedCluster operation.

Defines values for LocalDNSForwardDestination.
KnownLocalDNSForwardDestination can be used interchangeably with LocalDNSForwardDestination, this enum contains the known values that the service supports.

Known values supported by the service

ClusterCoreDNS: Forward DNS queries from localDNS to cluster CoreDNS.
VnetDNS: Forward DNS queries from localDNS to DNS server configured in the VNET. A VNET can have multiple DNS servers configured.

Defines values for LocalDNSForwardPolicy.
KnownLocalDNSForwardPolicy can be used interchangeably with LocalDNSForwardPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Sequential: Implements sequential upstream DNS server selection. See forward plugin for more information.
RoundRobin: Implements round robin upstream DNS server selection. See forward plugin for more information.
Random: Implements random upstream DNS server selection. See forward plugin for more information.

Defines values for LocalDNSMode.
KnownLocalDNSMode can be used interchangeably with LocalDNSMode, this enum contains the known values that the service supports.

Known values supported by the service

Preferred: If the current orchestrator version supports this feature, prefer enabling localDNS.
Required: Enable localDNS.
Disabled: Disable localDNS.

Defines values for LocalDNSProtocol.
KnownLocalDNSProtocol can be used interchangeably with LocalDNSProtocol, this enum contains the known values that the service supports.

Known values supported by the service

PreferUDP: Prefer UDP protocol for connections from localDNS to upstream DNS server.
ForceTCP: Enforce TCP protocol for connections from localDNS to upstream DNS server.

Defines values for LocalDNSQueryLogging.
KnownLocalDNSQueryLogging can be used interchangeably with LocalDNSQueryLogging, this enum contains the known values that the service supports.

Known values supported by the service

Error: Enables error logging in localDNS. See errors plugin for more information.
Log: Enables query logging in localDNS. See log plugin for more information.

Defines values for LocalDNSServeStale.
KnownLocalDNSServeStale can be used interchangeably with LocalDNSServeStale, this enum contains the known values that the service supports.

Known values supported by the service

Verify: Serve stale data with verification. First verify that an entry is still unavailable from the source before sending the expired entry to the client. See cache plugin for more information.
Immediate: Serve stale data immediately. Send the expired entry to the client before checking to see if the entry is available from the source. See cache plugin for more information.
Disable: Disable serving stale data.

Defines values for LocalDNSState.
KnownLocalDNSState can be used interchangeably with LocalDNSState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: localDNS is enabled.
Disabled: localDNS is disabled.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByManagedClusterNext operation.

Contains response data for the listByManagedCluster operation.

Defines values for ManagedClusterPodIdentityProvisioningState.
KnownManagedClusterPodIdentityProvisioningState can be used interchangeably with ManagedClusterPodIdentityProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Assigned
Canceled
Deleting
Failed
Succeeded
Updating

Defines values for ManagedClusterSKUName.
KnownManagedClusterSKUName can be used interchangeably with ManagedClusterSKUName, this enum contains the known values that the service supports.

Known values supported by the service

Base: Base option for the AKS control plane.
Automatic: Automatic clusters are optimized to run most production workloads with configuration that follows AKS best practices and recommendations for cluster and workload setup, scalability, and security. For more details about Automatic clusters see aka.ms/aks/automatic.

Defines values for ManagedClusterSKUTier.
KnownManagedClusterSKUTier can be used interchangeably with ManagedClusterSKUTier, this enum contains the known values that the service supports.

Known values supported by the service

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

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the updateTags operation.

Contains response data for the abortLatestOperation operation.

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the getAccessProfile operation.

Contains response data for the getCommandResult operation.

Contains response data for the getGuardrailsVersions operation.

Contains response data for the getMeshRevisionProfile operation.

Contains response data for the getMeshUpgradeProfile operation.

Contains response data for the get operation.

Contains response data for the getSafeguardsVersions operation.

Contains response data for the getUpgradeProfile operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listClusterAdminCredentials operation.

Contains response data for the listClusterMonitoringUserCredentials operation.

Contains response data for the listClusterUserCredentials operation.

Contains response data for the listGuardrailsVersionsNext operation.

Contains response data for the listGuardrailsVersions operation.

Contains response data for the listKubernetesVersions operation.

Contains response data for the listMeshRevisionProfilesNext operation.

Contains response data for the listMeshRevisionProfiles operation.

Contains response data for the listMeshUpgradeProfilesNext operation.

Contains response data for the listMeshUpgradeProfiles operation.

Contains response data for the listNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

Contains response data for the list operation.

Contains response data for the listSafeguardsVersionsNext operation.

Contains response data for the listSafeguardsVersions operation.

Contains response data for the rebalanceLoadBalancers operation.

Contains response data for the rotateClusterCertificates operation.

Contains response data for the rotateServiceAccountSigningKeys operation.

Contains response data for the runCommand operation.

Contains response data for the start operation.

Contains response data for the stop operation.

Contains response data for the updateTags operation.

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByManagedClusterNext operation.

Contains response data for the listByManagedCluster operation.

Contains response data for the listCredential operation.

Contains response data for the update operation.

Defines values for Mode.
KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports.

Known values supported by the service

IPTABLES: IPTables proxy mode
IPVS: IPVS proxy mode. Must be using Kubernetes version >= 1.22.

Defines values for NamespaceProvisioningState.
KnownNamespaceProvisioningState can be used interchangeably with NamespaceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Updating
Deleting
Creating
Succeeded
Failed
Canceled

Defines values for NetworkDataplane.
KnownNetworkDataplane can be used interchangeably with NetworkDataplane, this enum contains the known values that the service supports.

Known values supported by the service

azure: Use Azure network dataplane.
cilium: Use Cilium network dataplane. See Azure CNI Powered by Cilium for more information.

Defines values for NetworkMode.
KnownNetworkMode can be used interchangeably with NetworkMode, this enum contains the known values that the service supports.

Known values supported by the service

transparent: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See Transparent Mode for more information.
bridge: This is no longer supported

Defines values for NetworkPlugin.
KnownNetworkPlugin can be used interchangeably with NetworkPlugin, this enum contains the known values that the service supports.

Known values supported by the service

azure: Use the Azure CNI network plugin. See Azure CNI (advanced) networking for more information.
kubenet: Use the Kubenet network plugin. See Kubenet (basic) networking for more information.
none: Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality.

Defines values for NetworkPluginMode.
KnownNetworkPluginMode can be used interchangeably with NetworkPluginMode, this enum contains the known values that the service supports.

Known values supported by the service

overlay: Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge.

Defines values for NetworkPolicy.
KnownNetworkPolicy can be used interchangeably with NetworkPolicy, this enum contains the known values that the service supports.

Known values supported by the service

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 for more information.
azure: Use Azure network policies. See differences between Azure and Calico policies for more information.
cilium: Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'.

Defines values for NginxIngressControllerType.
KnownNginxIngressControllerType can be used interchangeably with NginxIngressControllerType, this enum contains the known values that the service supports.

Known values supported by the service

AnnotationControlled: The default NginxIngressController will be created. Users can edit the default NginxIngressController Custom Resource to configure load balancer annotations.
External: The default NginxIngressController will be created and the operator will provision an external loadbalancer with it. Any annotation to make the default loadbalancer internal will be overwritten.
Internal: The default NginxIngressController will be created and the operator will provision an internal loadbalancer with it. Any annotation to make the default loadbalancer external will be overwritten.
None: The default Ingress Controller will not be created. It will not be deleted by the system if it exists. Users should delete the default NginxIngressController Custom Resource manually if desired.

Defines values for NodeOSUpgradeChannel.
KnownNodeOSUpgradeChannel can be used interchangeably with NodeOSUpgradeChannel, this enum contains the known values that the service supports.

Known values supported by the service

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
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 later time 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
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.
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.

Defines values for NodeProvisioningDefaultNodePools.
KnownNodeProvisioningDefaultNodePools can be used interchangeably with NodeProvisioningDefaultNodePools, this enum contains the known values that the service supports.

Known values supported by the service

None: No Karpenter NodePools are provisioned automatically. Automatic scaling will not happen unless the user creates one or more NodePool instances.
Auto: A standard set of Karpenter NodePools are provisioned

Defines values for NodeProvisioningMode.
KnownNodeProvisioningMode can be used interchangeably with NodeProvisioningMode, this enum contains the known values that the service supports.

Known values supported by the service

Manual: Nodes are provisioned manually by the user
Auto: Nodes are provisioned automatically by AKS using Karpenter. Fixed size Node Pools can still be created, but autoscaling Node Pools cannot be. (See aka.ms/aks/nap for more details).

Defines values for OSDiskType.
KnownOSDiskType can be used interchangeably with OSDiskType, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for OSType.
KnownOSType can be used interchangeably with OSType, this enum contains the known values that the service supports.

Known values supported by the service

Linux: Use Linux.
Windows: Use Windows.

Contains response data for the getByAgentPool operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the list operation.

Defines values for Operator.
KnownOperator can be used interchangeably with Operator, this enum contains the known values that the service supports.

Known values supported by the service

In: The value of the key should be in the given list.
NotIn: The value of the key should not be in the given list.
Exists: The value of the key should exist.
DoesNotExist: The value of the key should not exist.

Defines values for Ossku.
KnownOssku can be used interchangeably with Ossku, this enum contains the known values that the service supports.

Known values supported by the service

Ubuntu: Use Ubuntu as the OS for node images.
Mariner: 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.
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.
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.
WindowsAnnual: Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details.
Ubuntu2204: Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions
Ubuntu2404: Use Ubuntu2404 as the OS for node images, however, Ubuntu 24.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions

Defines values for OutboundType.
KnownOutboundType can be used interchangeably with OutboundType, this enum contains the known values that the service supports.

Known values supported by the service

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

Defines values for PodIPAllocationMode.
KnownPodIPAllocationMode can be used interchangeably with PodIPAllocationMode, this enum contains the known values that the service supports.

Known values supported by the service

DynamicIndividual: Each pod gets a single IP address assigned. This is better for maximizing a small to medium subnet of size /16 or smaller. The Azure CNI cluster with dynamic IP allocation defaults to this mode if the customer does not explicitly specify a podIPAllocationMode
StaticBlock: Each node is statically allocated CIDR block(s) of size /28 = 16 IPs per block to satisfy the maxPods per node. Number of CIDR blocks >= (maxPods / 16). The block, rather than a single IP, counts against the Azure Vnet Private IP limit of 65K. Therefore block mode is suitable for running larger workloads with more than the current limit of 65K pods in a cluster. This mode is better suited to scale with larger subnets of /15 or bigger

Defines values for PodLinkLocalAccess.
KnownPodLinkLocalAccess can be used interchangeably with PodLinkLocalAccess, this enum contains the known values that the service supports.

Known values supported by the service

IMDS: Pods with hostNetwork=false can access Azure Instance Metadata Service (IMDS) without restriction.
None: Pods with hostNetwork=false cannot access Azure Instance Metadata Service (IMDS).

Defines values for PolicyRule.
KnownPolicyRule can be used interchangeably with PolicyRule, this enum contains the known values that the service supports.

Known values supported by the service

DenyAll: Deny all network traffic.
AllowAll: Allow all network traffic.
AllowSameNamespace: Allow traffic within the same namespace.

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Canceled
Creating
Deleting
Failed
Succeeded

Contains response data for the get operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the list operation.

Defines values for Protocol.
KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports.

Known values supported by the service

TCP: TCP protocol.
UDP: UDP protocol.

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Inbound/Outbound to the managedCluster is allowed.
Disabled: Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed.
SecuredByPerimeter: Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters.

Contains response data for the post operation.

Defines values for ResourceIdentityType.

Defines values for RestrictionLevel.
KnownRestrictionLevel can be used interchangeably with RestrictionLevel, this enum contains the known values that the service supports.

Known values supported by the service

Unrestricted: All RBAC permissions are allowed on the managed node resource group
ReadOnly: Only */read RBAC permissions allowed on the managed node resource group

Defines values for SafeguardsSupport.
KnownSafeguardsSupport can be used interchangeably with SafeguardsSupport, this enum contains the known values that the service supports.

Known values supported by the service

Preview: The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases.
Stable: The version is stable and can be used on critical production clusters.

Defines values for ScaleDownMode.
KnownScaleDownMode can be used interchangeably with ScaleDownMode, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for ScaleSetEvictionPolicy.
KnownScaleSetEvictionPolicy can be used interchangeably with ScaleSetEvictionPolicy, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for ScaleSetPriority.
KnownScaleSetPriority can be used interchangeably with ScaleSetPriority, this enum contains the known values that the service supports.

Known values supported by the service

Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See spot on AKS for more information.
Regular: Regular VMs will be used.

Defines values for SchedulerConfigMode.
KnownSchedulerConfigMode can be used interchangeably with SchedulerConfigMode, this enum contains the known values that the service supports.

Known values supported by the service

Default: No config customization. Use default configuration.
ManagedByCRD: Enable config customization. Customer can specify scheduler configuration via a CRD. See aka.ms/aks/scheduler-crd for details.

Defines values for SeccompDefault.
KnownSeccompDefault can be used interchangeably with SeccompDefault, this enum contains the known values that the service supports.

Known values supported by the service

Unconfined: No seccomp profile is applied, allowing all system calls.
RuntimeDefault: The default seccomp profile for container runtime is applied, which restricts certain system calls for enhanced security.

Defines values for ServiceMeshMode.
KnownServiceMeshMode can be used interchangeably with ServiceMeshMode, this enum contains the known values that the service supports.

Known values supported by the service

Istio: Istio deployed as an AKS addon.
Disabled: Mesh is disabled.

Defines values for SnapshotType.
KnownSnapshotType can be used interchangeably with SnapshotType, this enum contains the known values that the service supports.

Known values supported by the service

NodePool: The snapshot is a snapshot of a node pool.
ManagedCluster: The snapshot is a snapshot of a managed cluster.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the updateTags operation.

Defines values for TransitEncryptionType.
KnownTransitEncryptionType can be used interchangeably with TransitEncryptionType, this enum contains the known values that the service supports.

Known values supported by the service

WireGuard: Enable WireGuard encryption. Refer to https://docs.cilium.io/en/latest/security/network/encryption-wireguard/ on use cases and implementation details
None: Disable Transit encryption

Defines values for TrustedAccessRoleBindingProvisioningState.
KnownTrustedAccessRoleBindingProvisioningState can be used interchangeably with TrustedAccessRoleBindingProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Canceled
Deleting
Failed
Succeeded
Updating

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for Type.
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

First: First.
Second: Second.
Third: Third.
Fourth: Fourth.
Last: Last.

Defines values for UndrainableNodeBehavior.
KnownUndrainableNodeBehavior can be used interchangeably with UndrainableNodeBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Cordon: AKS will cordon the blocked nodes and replace them with surge nodes during upgrade. The blocked nodes will be cordoned and replaced by surge nodes. The blocked nodes will have label 'kubernetes.azure.com/upgrade-status:Quarantined'. A surge node will be retained for each blocked node. A best-effort attempt will be made to delete all other surge nodes. If there are enough surge nodes to replace blocked nodes, then the upgrade operation and the managed cluster will be in failed state. Otherwise, the upgrade operation and the managed cluster will be in canceled state.
Schedule: AKS will mark the blocked nodes schedulable, but the blocked nodes are not upgraded. A best-effort attempt will be made to delete all surge nodes. The upgrade operation and the managed cluster will be in failed state if there are any blocked nodes.

Defines values for UpgradeChannel.
KnownUpgradeChannel can be used interchangeably with UpgradeChannel, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for WeekDay.
KnownWeekDay can be used interchangeably with WeekDay, this enum contains the known values that the service supports.

Known values supported by the service

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

Defines values for WorkloadRuntime.
KnownWorkloadRuntime can be used interchangeably with WorkloadRuntime, this enum contains the known values that the service supports.

Known values supported by the service

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).
KataMshvVmIsolation: Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series.

Known values of AddonAutoscaling that the service accepts.

Known values of AdoptionPolicy that the service accepts.

Known values of AdvancedNetworkPolicies that the service accepts.

Known values of AgentPoolMode that the service accepts.

Known values of AgentPoolSSHAccess that the service accepts.

Known values of AgentPoolType that the service accepts.

Known values of ArtifactSource that the service accepts.

Known values of BackendPoolType that the service accepts.

Known values of ClusterServiceLoadBalancerHealthProbeMode that the service accepts.

Known values of Code that the service accepts.

Known values of ConnectionStatus that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of DeletePolicy that the service accepts.

Known values of DriverType that the service accepts.

Known values of Expander that the service accepts.

Known values of ExtendedLocationTypes that the service accepts.

Known values of Format that the service accepts.

Known values of GPUDriver that the service accepts.

Known values of GPUInstanceProfile that the service accepts.

Known values of GuardrailsSupport that the service accepts.

Known values of IpFamily that the service accepts.

Known values of IpvsScheduler that the service accepts.

Known values of IstioIngressGatewayMode that the service accepts.

Known values of KeyVaultNetworkAccessTypes that the service accepts.

Known values of KubeletDiskType that the service accepts.

Known values of KubernetesSupportPlan that the service accepts.

Known values of Level that the service accepts.

Known values of LicenseType that the service accepts.

Known values of LoadBalancerSku that the service accepts.

Known values of LocalDNSForwardDestination that the service accepts.

Known values of LocalDNSForwardPolicy that the service accepts.

Known values of LocalDNSMode that the service accepts.

Known values of LocalDNSProtocol that the service accepts.

Known values of LocalDNSQueryLogging that the service accepts.

Known values of LocalDNSServeStale that the service accepts.

Known values of LocalDNSState that the service accepts.

Known values of ManagedClusterPodIdentityProvisioningState that the service accepts.

Known values of ManagedClusterSKUName that the service accepts.

Known values of ManagedClusterSKUTier that the service accepts.

Known values of Mode that the service accepts.

Known values of NamespaceProvisioningState that the service accepts.

Known values of NetworkDataplane that the service accepts.

Known values of NetworkMode that the service accepts.

Known values of NetworkPlugin that the service accepts.

Known values of NetworkPluginMode that the service accepts.

Known values of NetworkPolicy that the service accepts.

Known values of NginxIngressControllerType that the service accepts.

Known values of NodeOSUpgradeChannel that the service accepts.

Known values of NodeProvisioningDefaultNodePools that the service accepts.

Known values of NodeProvisioningMode that the service accepts.

Known values of OSDiskType that the service accepts.

Known values of OSType that the service accepts.

Known values of Operator that the service accepts.

Known values of Ossku that the service accepts.

Known values of OutboundType that the service accepts.

Known values of PodIPAllocationMode that the service accepts.

Known values of PodLinkLocalAccess that the service accepts.

Known values of PolicyRule that the service accepts.

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

Known values of Protocol that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of RestrictionLevel that the service accepts.

Known values of SafeguardsSupport that the service accepts.

Known values of ScaleDownMode that the service accepts.

Known values of ScaleSetEvictionPolicy that the service accepts.

Known values of ScaleSetPriority that the service accepts.

Known values of SchedulerConfigMode that the service accepts.

Known values of SeccompDefault that the service accepts.

Known values of ServiceMeshMode that the service accepts.

Known values of SnapshotType that the service accepts.

Known values of TransitEncryptionType that the service accepts.

Known values of TrustedAccessRoleBindingProvisioningState that the service accepts.

Known values of Type that the service accepts.

Known values of UndrainableNodeBehavior that the service accepts.

Known values of UpgradeChannel that the service accepts.

Known values of WeekDay that the service accepts.

Known values of WorkloadRuntime that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.