Azure.ResourceManager.ContainerService.Models 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
| AgentPoolAvailableVersion |
The AgentPoolAvailableVersion. |
| AgentPoolAvailableVersions |
The list of available versions for an agent pool. |
| AgentPoolNetworkPortRange |
The port range. |
| AgentPoolNetworkProfile |
Network settings of an agent pool. |
| AgentPoolUpgradeProfilePropertiesUpgradesItem |
The AgentPoolUpgradeProfilePropertiesUpgradesItem. |
| AgentPoolUpgradeSettings |
Settings for upgrading an agentpool. |
| ArmContainerServiceModelFactory |
Model factory for models. |
| CompatibleVersions |
Version information about a product/service that is compatible with a service mesh revision. |
| ContainerServiceDateSpan |
For example, between '2022-12-23' and '2023-01-05'. |
| ContainerServiceEndpointDependency |
A domain name that AKS agent nodes are reaching at. |
| ContainerServiceEndpointDetail |
connect information from the AKS agent nodes to a single endpoint. |
| ContainerServiceFleetCredentialResult |
The credential result response. |
| ContainerServiceFleetCredentialResults |
The list credential result response. |
| ContainerServiceFleetHubProfile |
The FleetHubProfile configures the fleet hub. |
| ContainerServiceFleetPatch |
Properties of a Fleet that can be patched. |
| ContainerServiceIPTag |
Contains the IPTag associated with the object. |
| ContainerServiceLinuxProfile |
Profile for Linux VMs in the container service cluster. |
| ContainerServiceMaintenanceAbsoluteMonthlySchedule |
For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. |
| 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. |
| ContainerServiceNetworkProfile |
Profile of network configuration. Serialized Name: ContainerServiceNetworkProfile |
| ContainerServiceNetworkProfileForSnapshot |
network profile for managed cluster snapshot, these properties are read only. |
| ContainerServiceNetworkProfileKubeProxyConfig |
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'. |
| ContainerServiceNetworkProfileKubeProxyIPVSConfig |
Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'. |
| ContainerServiceOSOptionProperty |
OS option property. |
| ContainerServiceOutboundEnvironmentEndpoint |
Egress endpoints which AKS agent nodes connect to for common purpose. |
| ContainerServicePrivateLinkResourceData |
A private link resource. |
| ContainerServicePrivateLinkServiceConnectionState |
The state of a private link service connection. |
| ContainerServiceSshConfiguration |
SSH configuration for Linux-based VMs running on Azure. |
| ContainerServiceSshPublicKey |
Contains information about SSH certificate public key data. |
| ContainerServiceTagsObject |
Tags object for patch operations. |
| ContainerServiceTimeInWeek |
Time in a week. |
| ContainerServiceTimeSpan |
For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. |
| ContainerServiceTrustedAccessRole |
Trusted access role definition. |
| ContainerServiceTrustedAccessRoleRule |
Rule for trusted access role. |
| 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 |
See AKS custom node configuration for more details. |
| KubernetesPatchVersion |
Kubernetes patch version profile. |
| KubernetesVersion |
Kubernetes version profile for given major.minor release. |
| KubernetesVersionListResult |
Hold values properties, which is array of KubernetesVersion. |
| LinuxOSConfig |
See AKS custom node configuration for more details. |
| ManagedClusterAadProfile |
For more details see managed AAD on AKS. |
| ManagedClusterAccessProfile |
Managed cluster Access Profile. |
| ManagedClusterAddonProfile |
A Kubernetes add-on profile for a managed cluster. |
| ManagedClusterAddonProfileIdentity |
Information of user assigned identity used by this add-on. |
| ManagedClusterAgentPoolProfile |
Profile for the container service agent pool. |
| ManagedClusterAgentPoolProfileProperties |
Properties for the container service agent pool profile. Serialized Name: ManagedClusterAgentPoolProfileProperties |
| 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. |
| ManagedClusterCredential |
The credential result response. |
| ManagedClusterCredentials |
The list credential result response. |
| ManagedClusterDelegatedIdentity |
Delegated resource properties - internal use only. |
| ManagedClusterGuardrailsProfile |
The Guardrails profile. |
| ManagedClusterHttpProxyConfig |
Cluster HTTP proxy configuration. |
| ManagedClusterIdentity |
Identity for the managed cluster. Serialized Name: ManagedClusterIdentity |
| ManagedClusterIngressProfileWebAppRouting |
Web App Routing 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. |
| ManagedClusterNatGatewayProfile |
Profile of the managed cluster NAT gateway. |
| ManagedClusterOidcIssuerProfile |
The OIDC issuer profile of the Managed Cluster. |
| ManagedClusterPodIdentity |
Details about the pod identity assigned to the Managed Cluster. |
| ManagedClusterPodIdentityException |
See disable AAD Pod Identity for a specific Pod/Application for more details. |
| ManagedClusterPodIdentityProfile |
See use AAD pod identity for more details on pod identity integration. |
| ManagedClusterPoolUpgradeProfile |
The list of available upgrade versions. |
| ManagedClusterPoolUpgradeProfileUpgradesItem |
The ManagedClusterPoolUpgradeProfileUpgradesItem. |
| ManagedClusterPropertiesForSnapshot |
managed cluster properties for snapshot, these properties are read only. |
| ManagedClusterRunCommandContent |
A run command request. |
| ManagedClusterRunCommandResult |
run command result. |
| 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. |
| ManagedClusterStorageProfileDiskCsiDriver |
AzureDisk CSI Driver settings for the storage profile. |
| ManagedClusterVerticalPodAutoscaler |
The ManagedClusterVerticalPodAutoscaler. |
| ManagedClusterWindowsProfile |
Profile for Windows VMs in the managed cluster. |
| ManagedClusterWorkloadAutoScalerProfile |
Workload Auto-scaler profile for the managed cluster. |
| MeshRevision |
Holds information on upgrades and compatibility for given major.minor mesh release. |
| MeshUpgradeProfileProperties |
Mesh upgrade profile properties for a major.minor release. |
| 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
| AgentPoolMode |
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. |
| AgentPoolType |
The type of Agent Pool. |
| AutoScaleExpander |
If not specified, the default is 'random'. See expanders for more information. |
| ContainerServiceFleetMemberProvisioningState |
The provisioning state of the last accepted operation. |
| ContainerServiceFleetProvisioningState |
The provisioning state of the last accepted operation. |
| ContainerServiceLoadBalancerSku |
The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs. |
| ContainerServiceMaintenanceRelativeMonthlyScheduleWeekIndex |
Specifies on which week of the month the dayOfWeek applies. |
| ContainerServiceNetworkMode |
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. |
| ContainerServiceNetworkProfileKubeProxyIPVSScheduler |
IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html. |
| ContainerServiceNetworkProfileKubeProxyMode |
Specify which proxy mode to use ('IPTABLES' or 'IPVS'). |
| ContainerServiceOSDiskType |
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 |
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 |
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. |
| EbpfDataplane |
The eBPF dataplane used for building the Kubernetes network. |
| GpuInstanceProfile |
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. |
| IPFamily |
The IP version to use for cluster networking and IP assignment. |
| IstioIngressGatewayMode |
Mode of an ingress gateway. |
| KubeConfigFormat |
The KubeConfigFormat. |
| KubeletDiskType |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
| KubernetesSupportPlan |
Different support tiers for AKS managed clusters. |
| ManagedClusterGuardrailsProfileLevel |
The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces. |
| ManagedClusterKeyVaultNetworkAccessType |
Network access of key vault. The possible values are |
| ManagedClusterLoadBalancerBackendPoolType |
The type of the managed inbound Load Balancer BackendPool. |
| ManagedClusterNodeOSUpgradeChannel |
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. |
| ManagedClusterPodIdentityProvisioningState |
The current provisioning state of the pod identity. |
| ManagedClusterSkuName |
The name of a managed cluster SKU. |
| ManagedClusterSkuTier |
If not specified, the default is 'Free'. See uptime SLA for more details. |
| ManagedClusterVerticalPodAutoscalerUpdateMode |
Each update mode level is a superset of the lower levels. Off<Initial<Recreate<=Auto. For example: if UpdateMode is Initial, it means VPA sets the recommended resources in the VerticalPodAutoscaler Custom Resource (from UpdateMode Off) and also assigns resources on pod creation (from Initial). The default value is Off. |
| ManagedClusterWorkloadAutoScalerControlledValue |
Controls which resource value autoscaler will change. Default value is RequestsAndLimits. |
| NetworkDataplane |
Network dataplane used in the Kubernetes cluster. |
| ScaleDownMode |
Describes how VMs are added to or removed from Agent Pools. See billing states. |
| ScaleSetEvictionPolicy |
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. |
| UpgradeChannel |
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. |
