Azure.Provisioning.ContainerService Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AgentPoolNetworkPortRange |
The port range. |
| AgentPoolNetworkProfile |
Network settings of an agent pool. |
| AgentPoolSecurityProfile |
The security settings of an agent pool. |
| AgentPoolSnapshot |
A node pool snapshot resource. |
| AgentPoolSnapshot.ResourceVersions | |
| AgentPoolUpgradeProfile |
The list of available upgrades for an agent pool. |
| AgentPoolUpgradeProfile.ResourceVersions | |
| AgentPoolUpgradeProfilePropertiesUpgradesItem |
Available upgrades for an AgentPool. |
| AgentPoolUpgradeSettings |
Settings for upgrading an agentpool. |
| AgentPoolVirtualMachineNodes |
Current status on a group of nodes of the same vm size. |
| CompatibleVersions |
Version information about a product/service that is compatible with a service mesh revision. |
| ContainerServiceAgentPool |
Agent Pool. |
| ContainerServiceAgentPool.ResourceVersions | |
| ContainerServiceDateSpan |
A date range. For example, between '2022-12-23' and '2023-01-05'. |
| ContainerServiceIPTag |
Contains the IPTag associated with the object. |
| ContainerServiceLinuxProfile |
Profile for Linux VMs in the container service cluster. |
| ContainerServiceMachine |
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. |
| ContainerServiceMachine.ResourceVersions | |
| ContainerServiceMachineIPAddress |
The machine IP address details. |
| ContainerServiceMachineProperties |
The properties of the machine. |
| ContainerServiceMaintenanceAbsoluteMonthlySchedule |
For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. |
| ContainerServiceMaintenanceConfiguration |
Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster. See planned maintenance for more information about planned maintenance. |
| ContainerServiceMaintenanceConfiguration.ResourceVersions | |
| ContainerServiceMaintenanceRelativeMonthlySchedule |
For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. |
| ContainerServiceMaintenanceSchedule |
One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule. |
| ContainerServiceMaintenanceWeeklySchedule |
For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. |
| ContainerServiceMaintenanceWindow |
Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster. |
| ContainerServiceManagedCluster |
Managed cluster. |
| ContainerServiceManagedCluster.ResourceVersions | |
| ContainerServiceNetworkProfile |
Profile of network configuration. |
| ContainerServicePrivateEndpointConnection |
A private endpoint connection. |
| ContainerServicePrivateEndpointConnection.ResourceVersions | |
| ContainerServicePrivateLinkResourceData |
A private link resource. |
| ContainerServicePrivateLinkServiceConnectionState |
The state of a private link service connection. |
| ContainerServiceSshPublicKey |
Contains information about SSH certificate public key data. |
| ContainerServiceTimeInWeek |
Time in a week. |
| ContainerServiceTimeSpan |
A time range. For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. |
| ContainerServiceTrustedAccessRoleBinding |
Defines binding between a resource and role. |
| ContainerServiceTrustedAccessRoleBinding.ResourceVersions | |
| ContainerServiceUserAssignedIdentity |
Details about a user assigned identity. |
| IstioComponents |
Istio components configuration. |
| IstioEgressGateway |
Istio egress gateway configuration. |
| IstioIngressGateway |
Istio ingress gateway configuration. For now, we support up to one external ingress gateway named |
| IstioPluginCertificateAuthority |
Plugin certificates information for Service Mesh. |
| IstioServiceMesh |
Istio service mesh configuration. |
| KubeletConfig |
Kubelet configurations of agent nodes. See AKS custom node configuration for more details. |
| LinuxOSConfig |
OS configurations of Linux agent nodes. See AKS custom node configuration for more details. |
| LocalDnsOverride |
Overrides for localDNS profile. |
| LocalDnsProfile |
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. |
| ManagedClusterAadProfile |
AADProfile specifies attributes for Azure Active Directory integration. For more details see managed AAD on AKS. |
| ManagedClusterAddonProfile |
A Kubernetes add-on profile for a managed cluster. |
| ManagedClusterAddonProfileIdentity |
Information of user assigned identity used by this add-on. |
| ManagedClusterAdvancedNetworking |
Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. |
| ManagedClusterAdvancedNetworkingSecurity |
Security profile to enable security features on cilium based cluster. |
| ManagedClusterAgentPoolProfile |
Profile for the container service agent pool. |
| ManagedClusterApiServerAccessProfile |
Access profile for managed cluster API server. |
| ManagedClusterAutoScalerProfile |
Parameters to be applied to the cluster-autoscaler when enabled. |
| ManagedClusterAutoUpgradeProfile |
Auto upgrade profile for a managed cluster. |
| ManagedClusterBootstrapProfile |
The bootstrap profile. |
| ManagedClusterDelegatedIdentity |
Delegated resource properties - internal use only. |
| ManagedClusterHttpProxyConfig |
Cluster HTTP proxy configuration. |
| ManagedClusterIdentity |
Identity for the managed cluster. |
| ManagedClusterIngressProfileWebAppRouting |
Application Routing add-on settings for the ingress profile. |
| ManagedClusterLoadBalancerProfile |
Profile of the managed cluster load balancer. |
| ManagedClusterLoadBalancerProfileManagedOutboundIPs |
Desired managed outbound IPs for the cluster load balancer. |
| ManagedClusterMonitorProfileKubeStateMetrics |
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. |
| ManagedClusterMonitorProfileMetrics |
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. |
| ManagedClusterNamespace |
Namespace managed by ARM. |
| ManagedClusterNamespace.ResourceVersions | |
| ManagedClusterNamespaceProperties |
Properties of a namespace managed by ARM. |
| ManagedClusterNatGatewayProfile |
Profile of the managed cluster NAT gateway. |
| ManagedClusterNodeProvisioningProfile |
Node provisioning profile for the managed cluster. |
| ManagedClusterOidcIssuerProfile |
The OIDC issuer profile of the Managed Cluster. |
| ManagedClusterPodIdentity |
Details about the pod identity assigned to the Managed Cluster. |
| ManagedClusterPodIdentityException |
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. |
| ManagedClusterPodIdentityProfile |
The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on pod identity integration. |
| ManagedClusterPodIdentityProvisioningErrorDetail |
An error response from the pod identity provisioning. |
| ManagedClusterPoolUpgradeProfile |
The list of available upgrade versions. |
| ManagedClusterPoolUpgradeProfileUpgradesItem |
Available upgrades for an AgentPool. |
| ManagedClusterSecurityProfile |
Security profile for the container service cluster. |
| ManagedClusterSecurityProfileDefender |
Microsoft Defender settings for the security profile. |
| ManagedClusterSecurityProfileImageCleaner |
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. |
| ManagedClusterSecurityProfileKeyVaultKms |
Azure Key Vault key management service settings for the security profile. |
| ManagedClusterServicePrincipalProfile |
Information about a service principal identity for the cluster to use for manipulating Azure APIs. |
| ManagedClusterSku |
The SKU of a Managed Cluster. |
| ManagedClusterStorageProfile |
Storage profile for the container service cluster. |
| ManagedClusterUpgradeProfile |
The list of available upgrades for compute pools. |
| ManagedClusterUpgradeProfile.ResourceVersions | |
| ManagedClusterWindowsProfile |
Profile for Windows VMs in the managed cluster. |
| ManagedClusterWorkloadAutoScalerProfile |
Workload Auto-scaler profile for the managed cluster. |
| ManagedServiceIdentityUserAssignedIdentitiesValue |
User assigned identity properties. |
| ManualScaleProfile |
Specifications on number of machines. |
| MeshRevision |
Holds information on upgrades and compatibility for given major.minor mesh release. |
| MeshRevisionProfile |
Mesh revision profile for a mesh. |
| MeshRevisionProfile.ResourceVersions | |
| MeshUpgradeProfile |
Upgrade profile for given mesh. |
| MeshUpgradeProfile.ResourceVersions | |
| MeshUpgradeProfileProperties |
Mesh upgrade profile properties for a major.minor release. |
| NamespaceNetworkPolicies |
Default network policy of the namespace, specifying ingress and egress rules. |
| NamespaceResourceQuota |
Resource quota for the namespace. |
| ServiceMeshProfile |
Service mesh profile for a managed cluster. |
| SysctlConfig |
Sysctl settings for Linux agent nodes. |
| UpgradeOverrideSettings |
Settings for overrides when upgrading a cluster. |
| WindowsGmsaProfile |
Windows gMSA Profile in the managed cluster. |
Structs
| Name | Description |
|---|---|
| ContainerServiceBuiltInRole |
Defines the built-in roles for ContainerService resources. |
Enums
| Name | Description |
|---|---|
| AgentPoolGpuDriver |
Whether to install GPU drivers. When it's not specified, default is Install. |
| AgentPoolMode |
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. |
| AgentPoolNetworkPortProtocol |
The network protocol of the port. |
| AgentPoolSshAccess |
SSH access method of an agent pool. |
| AgentPoolType |
The type of Agent Pool. |
| AutoScaleExpander |
The expander to use when scaling up. If not specified, the default is 'random'. See expanders for more information. |
| ContainerServiceArtifactSource |
The artifact source. The source where the artifacts are downloaded from. |
| ContainerServiceIPFamily |
To determine if address belongs IPv4 or IPv6 family. |
| ContainerServiceLoadBalancerSku |
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. |
| ContainerServiceMaintenanceRelativeMonthlyScheduleWeekIndex |
The week index. Specifies on which week of the month the dayOfWeek applies. |
| ContainerServiceNetworkMode |
The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'. |
| ContainerServiceNetworkPlugin |
Network plugin used for building the Kubernetes network. |
| ContainerServiceNetworkPluginMode |
The mode the network plugin should use. |
| ContainerServiceNetworkPolicy |
Network policy used for building the Kubernetes network. |
| ContainerServiceOSDiskType |
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. |
| ContainerServiceOSSku |
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. |
| ContainerServiceOSType |
The operating system type. The default is Linux. |
| ContainerServiceOutboundType |
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. |
| ContainerServicePrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| ContainerServicePrivateLinkServiceConnectionStatus |
The private link service connection status. |
| ContainerServicePublicNetworkAccess |
PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS. |
| ContainerServiceStateCode |
Tells whether the cluster is Running or Stopped. |
| ContainerServiceTrustedAccessRoleBindingProvisioningState |
The current provisioning state of trusted access role binding. |
| ContainerServiceWeekDay |
The weekday enum. |
| GpuInstanceProfile |
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. |
| IstioIngressGatewayMode |
Mode of an ingress gateway. |
| KubeletDiskType |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
| KubernetesSupportPlan |
Different support tiers for AKS managed clusters. |
| LocalDnsForwardDestination |
Destination server for DNS queries to be forwarded from localDNS. |
| LocalDnsForwardPolicy |
Forward policy for selecting upstream DNS server. See forward plugin for more information. |
| LocalDnsMode |
Mode of enablement for localDNS. |
| LocalDnsProtocol |
Enforce TCP or prefer UDP protocol for connections from localDNS to upstream DNS server. |
| LocalDnsQueryLogging |
Log level for DNS queries in localDNS. |
| LocalDnsServeStale |
Policy for serving stale data. See cache plugin for more information. |
| LocalDnsState |
System-generated state of localDNS. |
| ManagedClusterAdvancedNetworkingAccelerationMode |
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. |
| ManagedClusterAdvancedNetworkPolicy |
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. |
| ManagedClusterKeyVaultNetworkAccessType |
Network access of the key vault. Network access of key vault. The possible values are |
| ManagedClusterLoadBalancerBackendPoolType |
The type of the managed inbound Load Balancer BackendPool. |
| ManagedClusterNamespaceProvisioningState |
The current provisioning state of the namespace. |
| ManagedClusterNodeOSUpgradeChannel |
Node OS Upgrade Channel. Manner in which the OS on your nodes is updated. The default is NodeImage. |
| ManagedClusterNodeResourceGroupRestrictionLevel |
The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'. |
| ManagedClusterPodIdentityProvisioningState |
The current provisioning state of the pod identity. |
| ManagedClusterSkuName |
The name of a managed cluster SKU. |
| ManagedClusterSkuTier |
The tier of a managed cluster SKU. If not specified, the default is 'Free'. See AKS Pricing Tier for more details. |
| NamespaceAdoptionPolicy |
Action if Kubernetes namespace with same name already exists. |
| NamespaceDeletePolicy |
Delete options of a namespace. |
| NamespaceNetworkPolicyRule |
Enum representing different network policy rules. |
| NetworkDataplane |
Network dataplane used in the Kubernetes cluster. |
| NginxIngressControllerType |
Ingress type for the default NginxIngressController custom resource. |
| NodeProvisioningDefaultNodePool |
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. |
| NodeProvisioningMode |
The node provisioning mode. If not specified, the default is Manual. |
| PodIPAllocationMode |
Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'. |
| ProxyRedirectionMechanism |
Mode of traffic redirection. |
| ScaleDownMode |
Describes how VMs are added to or removed from Agent Pools. See billing states. |
| ScaleSetEvictionPolicy |
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. |
| ScaleSetPriority |
The Virtual Machine Scale Set priority. |
| ServiceMeshMode |
Mode of the service mesh. |
| SnapshotType |
The type of a snapshot. The default is NodePool. |
| TransitEncryptionType |
Configures pod-to-pod encryption. This can be enabled only on Cilium-based clusters. If not specified, the default value is None. |
| UndrainableNodeBehavior |
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. |
| UpgradeChannel |
The upgrade channel for auto upgrade. The default is 'none'. For more information see setting the AKS cluster auto-upgrade channel. |
| WindowsVmLicenseType |
The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details. |
| WorkloadRuntime |
Determines the type of workload a node can run. |