Azure.ResourceManager.ContainerService.Models Namespace

Specifications on auto-scaling.

Available version information for an agent pool.

The list of available versions for an agent pool.

Settings for blue-green upgrade on an agentpool.

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

GPU settings for the Agent Pool.

The port range.

Network settings of an agent pool.

NVIDIA-specific GPU settings.

A historical version that can be used for rollback operations.

Specifications on how to scale a VirtualMachines agent pool.

The security settings of an agent pool.

Available upgrades for an AgentPool.

Settings for upgrading an agentpool.

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

Model factory for models.

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

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

A domain name that AKS agent nodes are reaching at.

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

Contains the IPTag associated with the object.

Profile for Linux VMs in the container service cluster.

The hardware and GPU settings of the machine.

The machine IP address details.

The Kubernetes configurations used by the machine.

The Linux machine's specific profile.

network properties of the machine.

The operating system and disk used by the machine.

The properties of the machine.

The security settings of the machine.

Contains read-only information about the machine.

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

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

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

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

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

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

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

A private link resource.

The state of a private link service connection.

SSH configuration for Linux-based VMs running on Azure.

Contains information about SSH certificate public key data.

Tags object for patch operations.

Time in a week.

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

Trusted access role definition.

Rule for trusted access role.

Details about a user assigned identity.

Describes an available Compute SKU.

Describes The SKU capabilities object.

Describes scaling information of a SKU.

Describes metadata for retrieving price info.

Describes an available Compute SKU Location Information.

Describes an available Compute SKU Restriction Information.

Describes scaling information of a SKU.

Describes The zonal capabilities of a SKU.

Whether the version is default or not and support info.

Managed identity profile for the identity binding.

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.

Kubelet configurations of agent nodes. See AKS custom node configuration for more details.

Kubernetes patch version profile.

Kubernetes version profile for given major.minor release.

Component information for a Kubernetes version.

components of given Kubernetes version.

Hold values properties, which is array of KubernetesVersion.

OS configurations of Linux agent nodes. See AKS custom node configuration for more details.

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.

AADProfile specifies attributes for Azure Active Directory integration. For more details see managed AAD on AKS.

Managed cluster Access Profile.

A Kubernetes add-on profile for a managed cluster.

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

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

Security profile to enable security features on cilium based cluster.

Profile for the container service agent pool.

Properties for the container service agent pool profile. Serialized Name: ManagedClusterAgentPoolProfileProperties

Access profile for managed cluster API server.

Parameters to be applied to the cluster-autoscaler when enabled.

Auto upgrade profile for a managed cluster.

Azure Monitor addon profiles for monitoring the managed 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 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.

The bootstrap profile.

The credential result response.

The list credential result response.

Delegated resource properties - internal use only.

Health monitor profile for the managed cluster.

Cluster HTTP proxy configuration.

Identity for the managed cluster.

IdentityBinding properties.

Default domain profile for the managed cluster ingress profile.

Ingress profile for the container service cluster.

Application Load Balancer settings for the ingress profile.

Application Routing add-on settings for the ingress profile.

The claim mappings for JWTAuthenticator.

The extra claim mapping expression for JWTAuthenticator.

The OIDC issuer details for JWTAuthenticator.

The properties of JWTAuthenticator. For details on how to configure the properties of a JWT authenticator, please refer to the Kubernetes documentation: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration. Please note that not all fields available in the Kubernetes documentation are supported by AKS. For troubleshooting, please see https://aka.ms/aks-external-issuers-docs.

The validation rule for JWTAuthenticator.

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.

Profile of the managed cluster load balancer.

Desired managed outbound IPs for the cluster load balancer.

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

Mesh membership properties of a managed cluster.

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.

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.

Properties of a namespace managed by ARM.

Profile of the managed cluster NAT gateway.

Node provisioning profile for the managed cluster.

The OIDC issuer profile of the Managed Cluster.

Details about the pod identity assigned to the Managed Cluster.

A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server. See disable AAD Pod Identity for a specific Pod/Application for more details.

The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on pod identity integration.

An error response from the pod identity provisioning.

The list of available upgrade versions.

Available upgrades for an AgentPool.

A run command request.

run command result.

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.

Identity information used by Defender security gating to access container registries.

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.

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

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

The SKU of a Managed Cluster.

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

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

Storage profile for the container service cluster.

AzureDisk CSI Driver settings for the storage profile.

VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.

Profile for Windows VMs in the managed cluster.

Workload Auto-scaler profile for the managed cluster.

Specifications on number of machines.

Private connect profile for mesh membership.

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

Mesh upgrade profile properties for a major.minor release.

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

Resource quota for the namespace.

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

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

Whether the version is default or not and support info.

Profile for configuring image pull authentication to use service account scoped managed identities for authentication instead of node scoped managed identity (kubelet identity) for authentication to Azure Container Registry. For more information, refer to https://aka.ms/aks/identity-binding/acr-image-pull/docs.

Service mesh profile for a managed cluster.

Sysctl settings for Linux agent nodes.

Settings for overrides when upgrading a cluster.

Windows gMSA Profile in the managed cluster.

Whether to install GPU drivers. When it's not specified, default is Install.

Specify the type of GPU driver to install when creating Windows agent pools. If not provided, AKS selects the driver based on system compatibility. This cannot be changed once the AgentPool has been created. This cannot be set on Linux AgentPools. For Linux AgentPools, the driver is selected based on system compatibility.

The mode of an agent pool. 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.

The network protocol of the port.

SSH access method of an agent pool.

The type of Agent Pool.

Defines the upgrade strategy for the agent pool. The default is Rolling.

The expander to use when scaling up. If not specified, the default is 'random'. See expanders for more information.

The health probing behavior for External Traffic Policy Cluster services.

Configures container network logs ingestion with Azure Monitor. Which network logs to ingest is controlled by the CRD found in the following links. No network logs are ingested by default. More information on container network logs can be found at https://aka.ms/ContainerNetworkLogsDoc. More information on configuring container network log can be found at https://aka.ms/acns/howtoenablecnl. If not specified, the default is Disabled.

The artifact source. The source where the artifacts are downloaded from.

The type of extendedLocation.

To determine if address belongs IPv4 or IPv6 family.

The load balancer sku for the managed cluster. The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

The drift action of the machine. Indicates whether a machine has deviated from its expected state due to changes in managed cluster properties, requiring corrective action.

Virtual machine state. Indicates the current state of the underlying virtual machine.

The week index. Specifies on which week of the month the dayOfWeek applies.

IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

Specify which proxy mode to use ('IPTABLES', 'IPVS' or 'NFTABLES').

The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'.

Network plugin used for building the Kubernetes network.

The mode the network plugin should use.

Network policy used for building the Kubernetes network.

The OS disk type to be used for machines in the agent pool. 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.

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.

The operating system type. The default is Linux.

The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

The current provisioning state.

The private link service connection status.

PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS.

Tells whether the cluster is Running or Stopped.

The current provisioning state of trusted access role binding.

The weekday enum.

Whether to enable Istio as a Gateway API implementation for managed ingress with App Routing.

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

The Managed GPU experience installs additional components, such as the Data Center GPU Manager (DCGM) metrics for monitoring, on top of the GPU driver for you. For more details of what is installed, check out aka.ms/aks/managed-gpu.

Whether the version is preview or stable.

Mode of an ingress gateway.

The format of the kubeconfig credential.

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

Whether to enable encryption at rest of Kubernetes resource objects using service-managed keys. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption.

Different support tiers for AKS managed clusters.

Destination server for DNS queries to be forwarded from localDNS.

Forward policy for selecting upstream DNS server. See forward plugin for more information.

Mode of enablement for localDNS.

Enforce TCP or prefer UDP protocol for connections from localDNS to upstream DNS server.

Log level for DNS queries in localDNS.

Policy for serving stale data. See cache plugin for more information.

System-generated state of localDNS.

Whether VPA add-on is enabled and configured to scale AKS-managed add-ons.

Enable advanced network acceleration options. This allows users to configure acceleration using BPF host routing. This can be enabled only with Cilium dataplane. If not specified, the default value is None (no acceleration). The acceleration mode can be changed on a pre-existing cluster. See https://aka.ms/acnsperformance for a detailed explanation.

Enable advanced network policies. This allows users to configure Layer 7 network policies (FQDN, HTTP, Kafka). Policies themselves must be configured via the Cilium Network Policy resources, see https://docs.cilium.io/en/latest/security/policy/index.html. This can be enabled only on cilium-based clusters. If not specified, the default value is FQDN if security.enabled is set to true.

The provisioning state of the last accepted operation.

The provisioning state of the last accepted operation.

Network access of the key vault. 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.

The type of the managed inbound Load Balancer BackendPool.

The current provisioning state of the namespace.

Node OS Upgrade Channel. Manner in which the OS on your nodes is updated. The default is NodeImage.

The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'.

The current provisioning state of the pod identity.

The name of a managed cluster SKU.

The tier of a managed cluster SKU. If not specified, the default is 'Free'. See AKS Pricing Tier for more details.

Configuration for the managed Gateway API installation. If not specified, the default is 'Disabled'. See https://aka.ms/k8s-gateway-api for more details.

The provisioning state of the last accepted operation.

Sets the MIG (Multi-Instance GPU) strategy that will be used for managed MIG support. For more information about the different strategies, visit aka.ms/aks/managed-gpu. When not specified, the default is None.

Action if Kubernetes namespace with same name already exists.

Delete options of a namespace.

Enum representing different network policy rules.

Network dataplane used in the Kubernetes cluster.

Ingress type for the default NginxIngressController custom resource.

The set of default Karpenter NodePools (CRDs) configured for node provisioning. This field has no effect unless mode is 'Auto'. Warning: Changing this from Auto to None on an existing cluster will cause the default Karpenter NodePools to be deleted, which will drain and delete the nodes associated with those pools. It is strongly recommended to not do this unless there are idle nodes ready to take the pods evicted by that action. If not specified, the default is Auto. For more information see aka.ms/aks/nap#node-pools.

The node provisioning mode. If not specified, the default is Manual.

operator represents a key's relationship to a set of values. Valid operators are In and NotIn.

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.

Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. If not specified, the default is 'IMDS'.

Mode of traffic redirection.

The scale type applicable to the sku.

The reason for restriction.

The type of restrictions.

Whether the version is preview or stable.

Describes how VMs are added to or removed from Agent Pools. See billing states.

The Virtual Machine Scale Set eviction policy. The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see spot VMs.

The Virtual Machine Scale Set priority.

The config customization mode for this scheduler instance.

Specifies the default seccomp profile applied to all workloads. If not specified, 'Unconfined' will be used by default.

Mode of the service mesh.

The type of a snapshot. The default is NodePool.

Configures pod-to-pod encryption. This can be enabled only on Cilium-based clusters. If not specified, the default value is None.

Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

The upgrade channel for auto upgrade. The default is 'none'. For more information see setting the AKS cluster auto-upgrade channel.

The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details.

Determines the type of workload a node can run.