models Package
Classes
| AgentPool |
Agent Pool. Variables are only populated by the server, and will be ignored when sending a request. |
| AgentPoolAvailableVersions |
The list of available versions for an agent pool. Variables are only populated by the server, and will be ignored when sending a request. |
| AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem |
AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem. |
| AgentPoolListResult |
The response from the List Agent Pools operation. Variables are only populated by the server, and will be ignored when sending a request. |
| AgentPoolUpgradeProfile |
The list of available upgrades for an agent pool. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| AgentPoolUpgradeProfilePropertiesUpgradesItem |
AgentPoolUpgradeProfilePropertiesUpgradesItem. |
| AgentPoolUpgradeSettings |
Settings for upgrading an agentpool. |
| AzureKeyVaultKms |
Azure Key Vault key management service settings for the security profile. |
| CloudErrorBody |
An error response from the Container service. |
| ContainerServiceDiagnosticsProfile |
Profile for diagnostics on the container service cluster. All required parameters must be populated in order to send to Azure. |
| ContainerServiceLinuxProfile |
Profile for Linux VMs in the container service cluster. All required parameters must be populated in order to send to Azure. |
| ContainerServiceMasterProfile |
Profile for the container service master. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ContainerServiceNetworkProfile |
Profile of network configuration. |
| ContainerServiceSshConfiguration |
SSH configuration for Linux-based VMs running on Azure. All required parameters must be populated in order to send to Azure. |
| ContainerServiceSshPublicKey |
Contains information about SSH certificate public key data. All required parameters must be populated in order to send to Azure. |
| ContainerServiceVMDiagnostics |
Profile for diagnostics on the container service VMs. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| CreationData |
Data used when creating a target resource from a source resource. |
| CredentialResult |
The credential result response. Variables are only populated by the server, and will be ignored when sending a request. |
| CredentialResults |
The list credential result response. Variables are only populated by the server, and will be ignored when sending a request. |
| EndpointDependency |
A domain name that AKS agent nodes are reaching at. |
| EndpointDetail |
connect information from the AKS agent nodes to a single endpoint. |
| ExtendedLocation |
The complex type of the extended location. |
| KubeletConfig |
See AKS custom node configuration for more details. |
| LinuxOSConfig |
See AKS custom node configuration for more details. |
| MaintenanceConfiguration |
See planned maintenance for more information about planned maintenance. Variables are only populated by the server, and will be ignored when sending a request. |
| MaintenanceConfigurationListResult |
The response from the List maintenance configurations operation. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedCluster |
Managed cluster. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterAADProfile |
For more details see managed AAD on AKS. |
| ManagedClusterAPIServerAccessProfile |
Access profile for managed cluster API server. |
| ManagedClusterAccessProfile |
Managed cluster Access Profile. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterAddonProfile |
A Kubernetes add-on profile for a managed cluster. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterAddonProfileIdentity |
Information of user assigned identity used by this add-on. |
| ManagedClusterAgentPoolProfile |
Profile for the container service agent pool. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterAgentPoolProfileProperties |
Properties for the container service agent pool profile. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterAutoUpgradeProfile |
Auto upgrade profile for a managed cluster. |
| ManagedClusterHTTPProxyConfig |
Cluster HTTP proxy configuration. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterIdentity |
Identity for the managed cluster. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterIngressProfile |
Ingress profile for the container service cluster. |
| ManagedClusterIngressProfileWebAppRouting |
Web App Routing settings for the ingress profile. |
| ManagedClusterListResult |
The response from the List Managed Clusters operation. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterLoadBalancerProfile |
Profile of the managed cluster load balancer. |
| ManagedClusterLoadBalancerProfileManagedOutboundIPs |
Desired managed outbound IPs for the cluster load balancer. |
| ManagedClusterLoadBalancerProfileOutboundIPPrefixes |
Desired outbound IP Prefix resources for the cluster load balancer. |
| ManagedClusterLoadBalancerProfileOutboundIPs |
Desired outbound IP resources for the cluster load balancer. |
| ManagedClusterManagedOutboundIPProfile |
Profile of the managed outbound IP resources of the managed cluster. |
| ManagedClusterNATGatewayProfile |
Profile of the managed cluster NAT gateway. |
| ManagedClusterOIDCIssuerProfile |
The OIDC issuer profile of the Managed Cluster. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterPodIdentity |
Details about the pod identity assigned to the Managed Cluster. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterPodIdentityException |
See disable AAD Pod Identity for a specific Pod/Application for more details. All required parameters must be populated in order to send to Azure. |
| ManagedClusterPodIdentityProfile |
See use AAD pod identity for more details on pod identity integration. |
| ManagedClusterPodIdentityProvisioningError |
An error response from the pod identity provisioning. |
| ManagedClusterPodIdentityProvisioningErrorBody |
An error response from the pod identity provisioning. |
| ManagedClusterPodIdentityProvisioningInfo |
ManagedClusterPodIdentityProvisioningInfo. |
| ManagedClusterPoolUpgradeProfile |
The list of available upgrade versions. All required parameters must be populated in order to send to Azure. |
| ManagedClusterPoolUpgradeProfileUpgradesItem |
ManagedClusterPoolUpgradeProfileUpgradesItem. |
| ManagedClusterPropertiesAutoScalerProfile |
Parameters to be applied to the cluster-autoscaler when enabled. |
| ManagedClusterPropertiesForSnapshot |
managed cluster properties for snapshot, these properties are read only. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterSKU |
The SKU of a Managed Cluster. |
| ManagedClusterSecurityProfile |
Security profile for the container service cluster. |
| ManagedClusterSecurityProfileAzureDefender |
Azure Defender settings for the security profile. |
| ManagedClusterSecurityProfileWorkloadIdentity |
Workload Identity settings for the security profile. |
| ManagedClusterServicePrincipalProfile |
Information about a service principal identity for the cluster to use for manipulating Azure APIs. All required parameters must be populated in order to send to Azure. |
| ManagedClusterSnapshot |
A managed cluster snapshot resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterSnapshotListResult |
The response from the List Managed Cluster Snapshots operation. Variables are only populated by the server, and will be ignored when sending a request. |
| ManagedClusterStorageProfile |
Storage profile for the container service cluster. |
| ManagedClusterStorageProfileDiskCSIDriver |
AzureDisk CSI Driver settings for the storage profile. |
| ManagedClusterStorageProfileFileCSIDriver |
AzureFile CSI Driver settings for the storage profile. |
| ManagedClusterStorageProfileSnapshotController |
Snapshot Controller settings for the storage profile. |
| ManagedClusterUpgradeProfile |
The list of available upgrades for compute pools. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ManagedClusterWindowsProfile |
Profile for Windows VMs in the managed cluster. All required parameters must be populated in order to send to Azure. |
| ManagedServiceIdentityUserAssignedIdentitiesValue |
ManagedServiceIdentityUserAssignedIdentitiesValue. Variables are only populated by the server, and will be ignored when sending a request. |
| NetworkProfileForSnapshot |
network profile for managed cluster snapshot, these properties are read only. |
| OSOptionProfile |
The OS option profile. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| OSOptionProperty |
OS option property. All required parameters must be populated in order to send to Azure. |
| OperationListResult |
The List Operation response. Variables are only populated by the server, and will be ignored when sending a request. |
| OperationValue |
Describes the properties of a Operation value. Variables are only populated by the server, and will be ignored when sending a request. |
| OutboundEnvironmentEndpoint |
Egress endpoints which AKS agent nodes connect to for common purpose. |
| OutboundEnvironmentEndpointCollection |
Collection of OutboundEnvironmentEndpoint. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| PowerState |
Describes the Power State of the cluster. |
| PrivateEndpoint |
Private endpoint which a connection belongs to. |
| PrivateEndpointConnection |
A private endpoint connection. Variables are only populated by the server, and will be ignored when sending a request. |
| PrivateEndpointConnectionListResult |
A list of private endpoint connections. |
| PrivateLinkResource |
A private link resource. Variables are only populated by the server, and will be ignored when sending a request. |
| PrivateLinkResourcesListResult |
A list of private link resources. |
| PrivateLinkServiceConnectionState |
The state of a private link service connection. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
| ResourceReference |
A reference to an Azure resource. |
| RunCommandRequest |
A run command request. All required parameters must be populated in order to send to Azure. |
| RunCommandResult |
run command result. Variables are only populated by the server, and will be ignored when sending a request. |
| Snapshot |
A node pool snapshot resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| SnapshotListResult |
The response from the List Snapshots operation. Variables are only populated by the server, and will be ignored when sending a request. |
| SubResource |
Reference to another subresource. Variables are only populated by the server, and will be ignored when sending a request. |
| SysctlConfig |
Sysctl settings for Linux agent nodes. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TagsObject |
Tags object for patch operations. |
| TimeInWeek |
Time in a week. |
| TimeSpan |
For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| UserAssignedIdentity |
Details about a user assigned identity. |
| WindowsGmsaProfile |
Windows gMSA Profile in the managed cluster. |
Enums
| 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 |
| AgentPoolType |
The type of Agent Pool. |
| Code |
Tells whether the cluster is Running or Stopped |
| ConnectionStatus |
The private link service connection status. |
| ContainerServiceStorageProfileTypes |
Specifies what kind of storage to use. If omitted, the default will be chosen on your behalf based on the choice of orchestrator. |
| ContainerServiceVMSizeTypes |
Size of agent VMs. Note: This is no longer maintained. |
| Count |
Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. |
| CreatedByType |
The type of identity that created the resource. |
| Expander |
If not specified, the default is 'random'. See expanders for more information. |
| ExtendedLocationTypes |
The type of extendedLocation. |
| Format |
An enumeration. |
| 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. |
| KubeletDiskType |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
| LicenseType |
The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details. |
| LoadBalancerSku |
The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs. |
| 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. |
| NetworkMode |
This cannot be specified if networkPlugin is anything other than 'azure'. |
| NetworkPlugin |
Network plugin used for building the Kubernetes network. |
| NetworkPolicy |
Network policy used for building the Kubernetes network. |
| OSDiskType |
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. |
| OSSKU |
Specifies an OS SKU. This value must not be specified if OSType is Windows. |
| OSType |
The operating system type. The default is Linux. |
| OutboundType |
This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type. |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| PublicNetworkAccess |
Allow or deny public network access for AKS |
| ResourceIdentityType |
For more information see use managed identities in AKS. |
| 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. |
| SnapshotType |
The type of a snapshot. The default is NodePool. |
| UpgradeChannel |
For more information see setting the AKS cluster auto-upgrade channel. |
| WeekDay |
The weekday enum. |
| WorkloadRuntime |
Determines the type of workload a node can run. |
Feedback
Submit and view feedback for