# Constants
the LinuxDistros supported by vlabs.
ADFSIdentitySystem is a const string reference identifier for ADFS identity System.
AgentPoolProfileRoleEmpty is the empty role.
AgentPoolProfileRoleInfra is the infra role.
deprecated AKS 16.04 distro.
deprecated AKS 18.04 distro.
deprecated docker-engine distro.
the LinuxDistros supported by vlabs.
the LinuxDistros supported by vlabs.
APIVersion is the version of this API.
AvailabilitySet means that the vms are in an availability set.
AzureADIdentitySystem is a const string reference identifier for Azure AD identity System.
AzureStackCloud is a const string reference identifier for Azure Stack cloud.
AzureStackDependenciesLocationChina indicates to get dependencies from AzureChina cloud.
AzureStackDependenciesLocationGerman indicates to get dependencies from AzureGerman cloud.
AzureStackDependenciesLocationPublic indicates to get dependencies from in AzurePublic cloud.
AzureStackDependenciesLocationUSGovernment indicates to get dependencies from AzureUSGovernment cloud.
Supported container runtimes.
ClientCertificateAuthMethod indicates to use client certificate for authentication.
ClientSecretAuthMethod indicates to use client seret for authentication.
Supported container runtimes.
the LinuxDistros supported by vlabs.
Creating means ContainerService resource is being created.
DCOS is the string constant for DCOS orchestrator type and defaults to DCOS188.
DefaultNetworkPlugin defines the network plugin to use by default.
DefaultNetworkPluginWindows defines the network plugin to use by default for clusters with Windows agent pools.
DefaultNetworkPolicy defines the network policy to use by default.
Deleting means resource is in the process of being deleted.
Supported container runtimes.
Failed means resource is in failed state.
Supported container runtimes.
We currently support ipvs and iptables.
We currently support ipvs and iptables.
Kubernetes is the string constant for the Kubernetes orchestrator type.
KubernetesMinMaxPods is the minimum valid value for MaxPods, necessary for running kube-system pods.
the OSTypes supported by vlabs.
ManagedDisks means that the nodes use managed disks for their os and attached volumes.
MaxAgentCount are the maximum number of agents per agent pool.
MaxAzureStackManagedDiskSize is max etcd disk size supported on AzureStackCloud.
MaxDisks specifies the maximum attached disks to add to the cluster.
MaxDiskSizeGB specifies the maximum attached disk size.
MaxIPAddressCount specifies the maximum number of IP addresses per network interface.
MaxPort specifies the maximum tcp port to open.
Migrating means resource is being migrated from one subscription or resource group to another.
MinAgentCount are the minimum number of agents per agent pool.
MinDiskSizeGB specifies the minimum attached disk size.
MinIPAddressCount specifies the minimum number of IP addresses per network interface.
MinPort specifies the minimum tcp port to open.
NetworkPluginCilium is the string expression for cilium network policy config option.
NetworkPolicyCilium is the string expression for cilium network policy config option.
the LinuxDistros supported by vlabs.
StandardLoadBalancerSku is the string const for Azure Standard Load Balancer.
StorageAccount means that the nodes use raw storage accounts for their os and attached volumes.
Succeeded means resource created succeeded during last create/update.
Swarm is the string constant for the Swarm orchestrator type.
SwarmMode is the string constant for the Swarm Mode orchestrator type.
the LinuxDistros supported by vlabs.
the LinuxDistros supported by vlabs.
Updating means an existing ContainerService resource is being updated.
VirtualMachineScaleSets means that the vms are in a virtual machine scaleset.
the OSTypes supported by vlabs.
# Variables
ContainerRuntimeValues holds the valid values for container runtimes.
DependenciesLocationValues holds the valid values for dependencies location.
DistroValues holds the valid values for OS distros.
NetworkPluginValues holds the valid values for network plugin implementation.
NetworkPolicyValues holds the valid values for a network policy "azure" and "none" are there for backwards-compatibility.
# Structs
AADProfile specifies attributes for AAD integration.
AgentPoolProfile represents an agent pool definition.
AzureEndpointConfig describes an Azure endpoint.
AzureEnvironmentSpecConfig is the overall configuration differences in different cloud environments.
AzureOSImageConfig describes an Azure OS image.
BootstrapProfile represents the definition of the DCOS bootstrap node used to deploy the cluster.
CertificateProfile represents the definition of the master cluster The JSON parameters could be either a plain text, or referenced to a secret in a keyvault.
ContainerService complies with the ARM model of resource definition in a JSON template.
CustomCloudProfile represents the custom cloud profile.
CustomFile has source as the full absolute source path to a file and dest is the full absolute desired destination path to put the file on a master node.
CustomNodesDNS represents the Search Domain.
CustomSearchDomain represents the Search Domain when the custom vnet has a windows server DNS as a nameserver.
DcosConfig Configuration for DC/OS.
DCOSSpecConfig is the configurations of DCOS.
DockerSpecConfig is the configurations of docker.
Extension represents an extension definition in the master or agentPoolProfile.
ExtensionProfile represents an extension definition.
FeatureFlags defines feature-flag restricted functionality.
ImageReference represents a reference to an Image resource in Azure.
KeyVaultCertificate specifies a certificate to install On Linux, the certificate file is placed under the /var/lib/waagent directory with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for the private key.
KeyVaultID specifies a key vault.
KeyvaultSecretRef is a reference to a secret in a keyvault.
KeyVaultSecrets specifies certificates to install on the pool of machines from a given key vault the key vault specified must have been granted read permissions to CRP.
KubernetesAddon defines a list of addons w/ configuration to include with the cluster deployment.
KubernetesConfig contains the Kubernetes config structure, containing Kubernetes specific configuration.
KubernetesContainerSpec defines configuration for a container spec.
KubernetesSpecConfig is the kubernetes container images used.
LinuxProfile represents the linux parameters passed to the cluster.
MasterProfile represents the definition of the master cluster.
OrchestratorProfile contains Orchestrator properties.
OrchestratorVersionProfile contains information of a supported orchestrator version: - orchestrator type and version - whether this orchestrator version is deployed by default if orchestrator release is not specified - list of available upgrades for this orchestrator version.
OrchestratorVersionProfileList contains list of version profiles for supported orchestrators.
PoolUpgradeProfile contains pool properties: - orchestrator type and version - pool name (for agent pool) - OS type of the VMs in the pool - list of applicable upgrades.
PrivateCluster defines the configuration for a private cluster.
PrivateJumpboxProfile represents a jumpbox definition.
Properties represents the AKS cluster definition.
PublicKey represents an SSH key for LinuxProfile.
ResourcePurchasePlan defines resource plan as required by ARM for billing purposes.
ServicePrincipalProfile contains the client and secret used by the cluster for Azure Resource CRUD The 'Secret' and 'KeyvaultSecretRef' parameters are mutually exclusive The 'Secret' parameter should be a secret in plain text.
UpgradeProfile contains cluster properties: - orchestrator type and version for the cluster - list of pool profiles, constituting the cluster.
WindowsProfile represents the windows parameters passed to the cluster.
# Type aliases
AgentPoolProfileRole represents an agent role.
DependenciesLocation represents location to retrieve the dependencies.
Distro represents Linux distro to use for Linux VMs.
KubeProxyMode is for iptables and ipvs (and future others).
OSType represents OS types of agents.
ProvisioningState represents the current state of container service resource.