containerservice.azure.com/v1api20210501
APIVersion
Value | Description |
---|---|
“2021-05-01” |
ManagedCluster
Used by: ManagedClusterList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | ManagedCluster_Spec Optional |
|
status | ManagedCluster_STATUS Optional |
ManagedCluster_Spec
Property | Description | Type |
---|---|---|
aadProfile | ManagedClusterAADProfile Optional |
|
addonProfiles | map[string]ManagedClusterAddonProfile Optional |
|
agentPoolProfiles | ManagedClusterAgentPoolProfile[] Optional |
|
apiServerAccessProfile | ManagedClusterAPIServerAccessProfile Optional |
|
autoScalerProfile | ManagedClusterProperties_AutoScalerProfile Optional |
|
autoUpgradeProfile | ManagedClusterAutoUpgradeProfile Optional |
|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
disableLocalAccounts | bool Optional |
|
diskEncryptionSetIDReference | genruntime.ResourceReference Optional |
|
dnsPrefix | string Optional |
|
enablePodSecurityPolicy | bool Optional |
|
enableRBAC | bool Optional |
|
extendedLocation | ExtendedLocation Optional |
|
fqdnSubdomain | string Optional |
|
httpProxyConfig | ManagedClusterHTTPProxyConfig Optional |
|
identity | ManagedClusterIdentity Optional |
|
identityProfile | map[string]UserAssignedIdentity Optional |
|
kubernetesVersion | string Optional |
|
linuxProfile | ContainerServiceLinuxProfile Optional |
|
location | string Required |
|
networkProfile | ContainerServiceNetworkProfile Optional |
|
nodeResourceGroup | string Optional |
|
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ManagedClusterOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
podIdentityProfile | ManagedClusterPodIdentityProfile Optional |
|
privateLinkResources | PrivateLinkResource[] Optional |
|
servicePrincipalProfile | ManagedClusterServicePrincipalProfile Optional |
|
sku | ManagedClusterSKU Optional |
|
tags | map[string]string Optional |
|
windowsProfile | ManagedClusterWindowsProfile Optional |
ManagedCluster_STATUS
Property | Description | Type |
---|---|---|
aadProfile | ManagedClusterAADProfile_STATUS Optional |
|
addonProfiles | map[string]ManagedClusterAddonProfile_STATUS Optional |
|
agentPoolProfiles | ManagedClusterAgentPoolProfile_STATUS[] Optional |
|
apiServerAccessProfile | ManagedClusterAPIServerAccessProfile_STATUS Optional |
|
autoScalerProfile | ManagedClusterProperties_AutoScalerProfile_STATUS Optional |
|
autoUpgradeProfile | ManagedClusterAutoUpgradeProfile_STATUS Optional |
|
azurePortalFQDN | string Optional |
|
conditions | The observed state of the resource | conditions.Condition[] Optional |
disableLocalAccounts | bool Optional |
|
diskEncryptionSetID | string Optional |
|
dnsPrefix | string Optional |
|
enablePodSecurityPolicy | bool Optional |
|
enableRBAC | bool Optional |
|
extendedLocation | ExtendedLocation_STATUS Optional |
|
fqdn | string Optional |
|
fqdnSubdomain | string Optional |
|
httpProxyConfig | ManagedClusterHTTPProxyConfig_STATUS Optional |
|
id | string Optional |
|
identity | ManagedClusterIdentity_STATUS Optional |
|
identityProfile | map[string]UserAssignedIdentity_STATUS Optional |
|
kubernetesVersion | string Optional |
|
linuxProfile | ContainerServiceLinuxProfile_STATUS Optional |
|
location | string Optional |
|
maxAgentPools | int Optional |
|
name | string Optional |
|
networkProfile | ContainerServiceNetworkProfile_STATUS Optional |
|
nodeResourceGroup | string Optional |
|
podIdentityProfile | ManagedClusterPodIdentityProfile_STATUS Optional |
|
powerState | PowerState_STATUS Optional |
|
privateFQDN | string Optional |
|
privateLinkResources | PrivateLinkResource_STATUS[] Optional |
|
provisioningState | string Optional |
|
servicePrincipalProfile | ManagedClusterServicePrincipalProfile_STATUS Optional |
|
sku | ManagedClusterSKU_STATUS Optional |
|
tags | map[string]string Optional |
|
type | string Optional |
|
windowsProfile | ManagedClusterWindowsProfile_STATUS Optional |
ManagedClusterList
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | ManagedCluster[] Optional |
ManagedClustersAgentPool
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2021-05-01/managedClusters.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
Used by: ManagedClustersAgentPoolList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | ManagedClustersAgentPool_Spec Optional |
|
status | ManagedClustersAgentPool_STATUS Optional |
ManagedClustersAgentPool_Spec
Property | Description | Type |
---|---|---|
availabilityZones | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. | string[] Optional |
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
count | Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. | int Optional |
enableAutoScaling | Whether to enable auto-scaler | bool Optional |
enableEncryptionAtHost | This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption | bool Optional |
enableFIPS | See Add a FIPS-enabled node pool for more details. | bool Optional |
enableNodePublicIP | Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. | bool Optional |
enableUltraSSD | Whether to enable UltraSSD | bool Optional |
gpuInstanceProfile | GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. | GPUInstanceProfile Optional |
kubeletConfig | The Kubelet configuration on the agent pool nodes. | KubeletConfig Optional |
kubeletDiskType | Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. | KubeletDiskType Optional |
linuxOSConfig | The OS configuration of Linux agent nodes. | LinuxOSConfig Optional |
maxCount | The maximum number of nodes for auto-scaling | int Optional |
maxPods | The maximum number of pods that can run on a node. | int Optional |
minCount | The minimum number of nodes for auto-scaling | int Optional |
mode | 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 | AgentPoolMode Optional |
nodeLabels | The node labels to be persisted across all nodes in agent pool. | map[string]string Optional |
nodePublicIPPrefixIDReference | This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} | genruntime.ResourceReference Optional |
nodeTaints | The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ManagedClustersAgentPoolOperatorSpec Optional |
orchestratorVersion | As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool. | string Optional |
osDiskSizeGB | ContainerServiceOSDisk Optional |
|
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. | OSDiskType Optional |
osSKU | Specifies an OS SKU. This value must not be specified if OSType is Windows. | OSSKU Optional |
osType | The operating system type. The default is Linux. | OSType Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/ManagedCluster resource | genruntime.KnownResourceReference Required |
podSubnetIDReference | If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
proximityPlacementGroupID | The ID for Proximity Placement Group. | string Optional |
scaleSetEvictionPolicy | This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. | ScaleSetEvictionPolicy Optional |
scaleSetPriority | The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. | ScaleSetPriority Optional |
spotMaxPrice | Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing | float64 Optional |
tags | The tags to be persisted on the agent pool virtual machine scale set. | map[string]string Optional |
type | The type of Agent Pool. | AgentPoolType Optional |
upgradeSettings | Settings for upgrading the agentpool | AgentPoolUpgradeSettings Optional |
vmSize | VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions | string Optional |
vnetSubnetIDReference | If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
ManagedClustersAgentPool_STATUS
Property | Description | Type |
---|---|---|
availabilityZones | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. | string[] Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
count | Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. | int Optional |
enableAutoScaling | Whether to enable auto-scaler | bool Optional |
enableEncryptionAtHost | This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption | bool Optional |
enableFIPS | See Add a FIPS-enabled node pool for more details. | bool Optional |
enableNodePublicIP | Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. | bool Optional |
enableUltraSSD | Whether to enable UltraSSD | bool Optional |
gpuInstanceProfile | GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. | GPUInstanceProfile_STATUS Optional |
id | Resource ID. | string Optional |
kubeletConfig | The Kubelet configuration on the agent pool nodes. | KubeletConfig_STATUS Optional |
kubeletDiskType | Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. | KubeletDiskType_STATUS Optional |
linuxOSConfig | The OS configuration of Linux agent nodes. | LinuxOSConfig_STATUS Optional |
maxCount | The maximum number of nodes for auto-scaling | int Optional |
maxPods | The maximum number of pods that can run on a node. | int Optional |
minCount | The minimum number of nodes for auto-scaling | int Optional |
mode | 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 | AgentPoolMode_STATUS Optional |
name | The name of the resource that is unique within a resource group. This name can be used to access the resource. | string Optional |
nodeImageVersion | The version of node image | string Optional |
nodeLabels | The node labels to be persisted across all nodes in agent pool. | map[string]string Optional |
nodePublicIPPrefixID | This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} | string Optional |
nodeTaints | The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] Optional |
orchestratorVersion | As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool. | string Optional |
osDiskSizeGB | int Optional |
|
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. | OSDiskType_STATUS Optional |
osSKU | Specifies an OS SKU. This value must not be specified if OSType is Windows. | OSSKU_STATUS Optional |
osType | The operating system type. The default is Linux. | OSType_STATUS Optional |
podSubnetID | If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | string Optional |
powerState | Describes whether the Agent Pool is Running or Stopped | PowerState_STATUS Optional |
properties_type | The type of Agent Pool. | AgentPoolType_STATUS Optional |
provisioningState | The current deployment or provisioning state. | string Optional |
proximityPlacementGroupID | The ID for Proximity Placement Group. | string Optional |
scaleSetEvictionPolicy | This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. | ScaleSetEvictionPolicy_STATUS Optional |
scaleSetPriority | The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. | ScaleSetPriority_STATUS Optional |
spotMaxPrice | Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing | float64 Optional |
tags | The tags to be persisted on the agent pool virtual machine scale set. | map[string]string Optional |
type | Resource type | string Optional |
upgradeSettings | Settings for upgrading the agentpool | AgentPoolUpgradeSettings_STATUS Optional |
vmSize | VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions | string Optional |
vnetSubnetID | If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | string Optional |
ManagedClustersAgentPoolList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2021-05-01/managedClusters.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | ManagedClustersAgentPool[] Optional |
ManagedCluster_Spec
Used by: ManagedCluster.
Property | Description | Type |
---|---|---|
aadProfile | ManagedClusterAADProfile Optional |
|
addonProfiles | map[string]ManagedClusterAddonProfile Optional |
|
agentPoolProfiles | ManagedClusterAgentPoolProfile[] Optional |
|
apiServerAccessProfile | ManagedClusterAPIServerAccessProfile Optional |
|
autoScalerProfile | ManagedClusterProperties_AutoScalerProfile Optional |
|
autoUpgradeProfile | ManagedClusterAutoUpgradeProfile Optional |
|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
disableLocalAccounts | bool Optional |
|
diskEncryptionSetIDReference | genruntime.ResourceReference Optional |
|
dnsPrefix | string Optional |
|
enablePodSecurityPolicy | bool Optional |
|
enableRBAC | bool Optional |
|
extendedLocation | ExtendedLocation Optional |
|
fqdnSubdomain | string Optional |
|
httpProxyConfig | ManagedClusterHTTPProxyConfig Optional |
|
identity | ManagedClusterIdentity Optional |
|
identityProfile | map[string]UserAssignedIdentity Optional |
|
kubernetesVersion | string Optional |
|
linuxProfile | ContainerServiceLinuxProfile Optional |
|
location | string Required |
|
networkProfile | ContainerServiceNetworkProfile Optional |
|
nodeResourceGroup | string Optional |
|
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ManagedClusterOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
podIdentityProfile | ManagedClusterPodIdentityProfile Optional |
|
privateLinkResources | PrivateLinkResource[] Optional |
|
servicePrincipalProfile | ManagedClusterServicePrincipalProfile Optional |
|
sku | ManagedClusterSKU Optional |
|
tags | map[string]string Optional |
|
windowsProfile | ManagedClusterWindowsProfile Optional |
ManagedCluster_STATUS
Used by: ManagedCluster.
Property | Description | Type |
---|---|---|
aadProfile | ManagedClusterAADProfile_STATUS Optional |
|
addonProfiles | map[string]ManagedClusterAddonProfile_STATUS Optional |
|
agentPoolProfiles | ManagedClusterAgentPoolProfile_STATUS[] Optional |
|
apiServerAccessProfile | ManagedClusterAPIServerAccessProfile_STATUS Optional |
|
autoScalerProfile | ManagedClusterProperties_AutoScalerProfile_STATUS Optional |
|
autoUpgradeProfile | ManagedClusterAutoUpgradeProfile_STATUS Optional |
|
azurePortalFQDN | string Optional |
|
conditions | The observed state of the resource | conditions.Condition[] Optional |
disableLocalAccounts | bool Optional |
|
diskEncryptionSetID | string Optional |
|
dnsPrefix | string Optional |
|
enablePodSecurityPolicy | bool Optional |
|
enableRBAC | bool Optional |
|
extendedLocation | ExtendedLocation_STATUS Optional |
|
fqdn | string Optional |
|
fqdnSubdomain | string Optional |
|
httpProxyConfig | ManagedClusterHTTPProxyConfig_STATUS Optional |
|
id | string Optional |
|
identity | ManagedClusterIdentity_STATUS Optional |
|
identityProfile | map[string]UserAssignedIdentity_STATUS Optional |
|
kubernetesVersion | string Optional |
|
linuxProfile | ContainerServiceLinuxProfile_STATUS Optional |
|
location | string Optional |
|
maxAgentPools | int Optional |
|
name | string Optional |
|
networkProfile | ContainerServiceNetworkProfile_STATUS Optional |
|
nodeResourceGroup | string Optional |
|
podIdentityProfile | ManagedClusterPodIdentityProfile_STATUS Optional |
|
powerState | PowerState_STATUS Optional |
|
privateFQDN | string Optional |
|
privateLinkResources | PrivateLinkResource_STATUS[] Optional |
|
provisioningState | string Optional |
|
servicePrincipalProfile | ManagedClusterServicePrincipalProfile_STATUS Optional |
|
sku | ManagedClusterSKU_STATUS Optional |
|
tags | map[string]string Optional |
|
type | string Optional |
|
windowsProfile | ManagedClusterWindowsProfile_STATUS Optional |
ManagedClustersAgentPool_Spec
Used by: ManagedClustersAgentPool.
Property | Description | Type |
---|---|---|
availabilityZones | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. | string[] Optional |
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
count | Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. | int Optional |
enableAutoScaling | Whether to enable auto-scaler | bool Optional |
enableEncryptionAtHost | This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption | bool Optional |
enableFIPS | See Add a FIPS-enabled node pool for more details. | bool Optional |
enableNodePublicIP | Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. | bool Optional |
enableUltraSSD | Whether to enable UltraSSD | bool Optional |
gpuInstanceProfile | GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. | GPUInstanceProfile Optional |
kubeletConfig | The Kubelet configuration on the agent pool nodes. | KubeletConfig Optional |
kubeletDiskType | Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. | KubeletDiskType Optional |
linuxOSConfig | The OS configuration of Linux agent nodes. | LinuxOSConfig Optional |
maxCount | The maximum number of nodes for auto-scaling | int Optional |
maxPods | The maximum number of pods that can run on a node. | int Optional |
minCount | The minimum number of nodes for auto-scaling | int Optional |
mode | 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 | AgentPoolMode Optional |
nodeLabels | The node labels to be persisted across all nodes in agent pool. | map[string]string Optional |
nodePublicIPPrefixIDReference | This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} | genruntime.ResourceReference Optional |
nodeTaints | The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ManagedClustersAgentPoolOperatorSpec Optional |
orchestratorVersion | As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool. | string Optional |
osDiskSizeGB | ContainerServiceOSDisk Optional |
|
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. | OSDiskType Optional |
osSKU | Specifies an OS SKU. This value must not be specified if OSType is Windows. | OSSKU Optional |
osType | The operating system type. The default is Linux. | OSType Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/ManagedCluster resource | genruntime.KnownResourceReference Required |
podSubnetIDReference | If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
proximityPlacementGroupID | The ID for Proximity Placement Group. | string Optional |
scaleSetEvictionPolicy | This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. | ScaleSetEvictionPolicy Optional |
scaleSetPriority | The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. | ScaleSetPriority Optional |
spotMaxPrice | Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing | float64 Optional |
tags | The tags to be persisted on the agent pool virtual machine scale set. | map[string]string Optional |
type | The type of Agent Pool. | AgentPoolType Optional |
upgradeSettings | Settings for upgrading the agentpool | AgentPoolUpgradeSettings Optional |
vmSize | VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions | string Optional |
vnetSubnetIDReference | If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
ManagedClustersAgentPool_STATUS
Used by: ManagedClustersAgentPool.
Property | Description | Type |
---|---|---|
availabilityZones | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. | string[] Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
count | Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. | int Optional |
enableAutoScaling | Whether to enable auto-scaler | bool Optional |
enableEncryptionAtHost | This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption | bool Optional |
enableFIPS | See Add a FIPS-enabled node pool for more details. | bool Optional |
enableNodePublicIP | Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. | bool Optional |
enableUltraSSD | Whether to enable UltraSSD | bool Optional |
gpuInstanceProfile | GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. | GPUInstanceProfile_STATUS Optional |
id | Resource ID. | string Optional |
kubeletConfig | The Kubelet configuration on the agent pool nodes. | KubeletConfig_STATUS Optional |
kubeletDiskType | Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. | KubeletDiskType_STATUS Optional |
linuxOSConfig | The OS configuration of Linux agent nodes. | LinuxOSConfig_STATUS Optional |
maxCount | The maximum number of nodes for auto-scaling | int Optional |
maxPods | The maximum number of pods that can run on a node. | int Optional |
minCount | The minimum number of nodes for auto-scaling | int Optional |
mode | 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 | AgentPoolMode_STATUS Optional |
name | The name of the resource that is unique within a resource group. This name can be used to access the resource. | string Optional |
nodeImageVersion | The version of node image | string Optional |
nodeLabels | The node labels to be persisted across all nodes in agent pool. | map[string]string Optional |
nodePublicIPPrefixID | This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} | string Optional |
nodeTaints | The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] Optional |
orchestratorVersion | As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool. | string Optional |
osDiskSizeGB | int Optional |
|
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. | OSDiskType_STATUS Optional |
osSKU | Specifies an OS SKU. This value must not be specified if OSType is Windows. | OSSKU_STATUS Optional |
osType | The operating system type. The default is Linux. | OSType_STATUS Optional |
podSubnetID | If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | string Optional |
powerState | Describes whether the Agent Pool is Running or Stopped | PowerState_STATUS Optional |
properties_type | The type of Agent Pool. | AgentPoolType_STATUS Optional |
provisioningState | The current deployment or provisioning state. | string Optional |
proximityPlacementGroupID | The ID for Proximity Placement Group. | string Optional |
scaleSetEvictionPolicy | This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. | ScaleSetEvictionPolicy_STATUS Optional |
scaleSetPriority | The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. | ScaleSetPriority_STATUS Optional |
spotMaxPrice | Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing | float64 Optional |
tags | The tags to be persisted on the agent pool virtual machine scale set. | map[string]string Optional |
type | Resource type | string Optional |
upgradeSettings | Settings for upgrading the agentpool | AgentPoolUpgradeSettings_STATUS Optional |
vmSize | VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions | string Optional |
vnetSubnetID | If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} | string Optional |
AgentPoolMode
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“System” | |
“User” |
AgentPoolMode_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“System” | |
“User” |
AgentPoolType
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“AvailabilitySet” | |
“VirtualMachineScaleSets” |
AgentPoolType_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“AvailabilitySet” | |
“VirtualMachineScaleSets” |
AgentPoolUpgradeSettings
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Property | Description | Type |
---|---|---|
maxSurge | string Optional |
AgentPoolUpgradeSettings_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Property | Description | Type |
---|---|---|
maxSurge | string Optional |
ContainerServiceLinuxProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
adminUsername | string Required |
|
ssh | ContainerServiceSshConfiguration Required |
ContainerServiceLinuxProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
adminUsername | string Optional |
|
ssh | ContainerServiceSshConfiguration_STATUS Optional |
ContainerServiceNetworkProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
dnsServiceIP | string Optional |
|
dockerBridgeCidr | string Optional |
|
loadBalancerProfile | ManagedClusterLoadBalancerProfile Optional |
|
loadBalancerSku | ContainerServiceNetworkProfile_LoadBalancerSku Optional |
|
networkMode | ContainerServiceNetworkProfile_NetworkMode Optional |
|
networkPlugin | ContainerServiceNetworkProfile_NetworkPlugin Optional |
|
networkPolicy | ContainerServiceNetworkProfile_NetworkPolicy Optional |
|
outboundType | ContainerServiceNetworkProfile_OutboundType Optional |
|
podCidr | string Optional |
|
serviceCidr | string Optional |
ContainerServiceNetworkProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
dnsServiceIP | string Optional |
|
dockerBridgeCidr | string Optional |
|
loadBalancerProfile | ManagedClusterLoadBalancerProfile_STATUS Optional |
|
loadBalancerSku | ContainerServiceNetworkProfile_LoadBalancerSku_STATUS Optional |
|
networkMode | ContainerServiceNetworkProfile_NetworkMode_STATUS Optional |
|
networkPlugin | ContainerServiceNetworkProfile_NetworkPlugin_STATUS Optional |
|
networkPolicy | ContainerServiceNetworkProfile_NetworkPolicy_STATUS Optional |
|
outboundType | ContainerServiceNetworkProfile_OutboundType_STATUS Optional |
|
podCidr | string Optional |
|
serviceCidr | string Optional |
ContainerServiceOSDisk
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
ExtendedLocation
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
name | string Optional |
|
type | ExtendedLocationType Optional |
ExtendedLocation_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
name | string Optional |
|
type | ExtendedLocationType_STATUS Optional |
GPUInstanceProfile
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“MIG1g” | |
“MIG2g” | |
“MIG3g” | |
“MIG4g” | |
“MIG7g” |
GPUInstanceProfile_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“MIG1g” | |
“MIG2g” | |
“MIG3g” | |
“MIG4g” | |
“MIG7g” |
KubeletConfig
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Property | Description | Type |
---|---|---|
allowedUnsafeSysctls | string[] Optional |
|
containerLogMaxFiles | int Optional |
|
containerLogMaxSizeMB | int Optional |
|
cpuCfsQuota | bool Optional |
|
cpuCfsQuotaPeriod | string Optional |
|
cpuManagerPolicy | string Optional |
|
failSwapOn | bool Optional |
|
imageGcHighThreshold | int Optional |
|
imageGcLowThreshold | int Optional |
|
podMaxPids | int Optional |
|
topologyManagerPolicy | string Optional |
KubeletConfig_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Property | Description | Type |
---|---|---|
allowedUnsafeSysctls | string[] Optional |
|
containerLogMaxFiles | int Optional |
|
containerLogMaxSizeMB | int Optional |
|
cpuCfsQuota | bool Optional |
|
cpuCfsQuotaPeriod | string Optional |
|
cpuManagerPolicy | string Optional |
|
failSwapOn | bool Optional |
|
imageGcHighThreshold | int Optional |
|
imageGcLowThreshold | int Optional |
|
podMaxPids | int Optional |
|
topologyManagerPolicy | string Optional |
KubeletDiskType
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“OS” | |
“Temporary” |
KubeletDiskType_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“OS” | |
“Temporary” |
LinuxOSConfig
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Property | Description | Type |
---|---|---|
swapFileSizeMB | int Optional |
|
sysctls | SysctlConfig Optional |
|
transparentHugePageDefrag | string Optional |
|
transparentHugePageEnabled | string Optional |
LinuxOSConfig_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Property | Description | Type |
---|---|---|
swapFileSizeMB | int Optional |
|
sysctls | SysctlConfig_STATUS Optional |
|
transparentHugePageDefrag | string Optional |
|
transparentHugePageEnabled | string Optional |
ManagedClusterAADProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
adminGroupObjectIDs | string[] Optional |
|
clientAppID | string Optional |
|
enableAzureRBAC | bool Optional |
|
managed | bool Optional |
|
serverAppID | string Optional |
|
serverAppSecret | string Optional |
|
tenantID | string Optional |
ManagedClusterAADProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
adminGroupObjectIDs | string[] Optional |
|
clientAppID | string Optional |
|
enableAzureRBAC | bool Optional |
|
managed | bool Optional |
|
serverAppID | string Optional |
|
serverAppSecret | string Optional |
|
tenantID | string Optional |
ManagedClusterAddonProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
config | map[string]string Optional |
|
enabled | bool Required |
ManagedClusterAddonProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
config | map[string]string Optional |
|
enabled | bool Optional |
|
identity | UserAssignedIdentity_STATUS Optional |
ManagedClusterAgentPoolProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
availabilityZones | string[] Optional |
|
count | int Optional |
|
enableAutoScaling | bool Optional |
|
enableEncryptionAtHost | bool Optional |
|
enableFIPS | bool Optional |
|
enableNodePublicIP | bool Optional |
|
enableUltraSSD | bool Optional |
|
gpuInstanceProfile | GPUInstanceProfile Optional |
|
kubeletConfig | KubeletConfig Optional |
|
kubeletDiskType | KubeletDiskType Optional |
|
linuxOSConfig | LinuxOSConfig Optional |
|
maxCount | int Optional |
|
maxPods | int Optional |
|
minCount | int Optional |
|
mode | AgentPoolMode Optional |
|
name | string Optional |
|
nodeLabels | map[string]string Optional |
|
nodePublicIPPrefixIDReference | genruntime.ResourceReference Optional |
|
nodeTaints | string[] Optional |
|
orchestratorVersion | string Optional |
|
osDiskSizeGB | ContainerServiceOSDisk Optional |
|
osDiskType | OSDiskType Optional |
|
osSKU | OSSKU Optional |
|
osType | OSType Optional |
|
podSubnetIDReference | genruntime.ResourceReference Optional |
|
proximityPlacementGroupID | string Optional |
|
scaleSetEvictionPolicy | ScaleSetEvictionPolicy Optional |
|
scaleSetPriority | ScaleSetPriority Optional |
|
spotMaxPrice | float64 Optional |
|
tags | map[string]string Optional |
|
type | AgentPoolType Optional |
|
upgradeSettings | AgentPoolUpgradeSettings Optional |
|
vmSize | string Optional |
|
vnetSubnetIDReference | genruntime.ResourceReference Optional |
ManagedClusterAgentPoolProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
availabilityZones | string[] Optional |
|
count | int Optional |
|
enableAutoScaling | bool Optional |
|
enableEncryptionAtHost | bool Optional |
|
enableFIPS | bool Optional |
|
enableNodePublicIP | bool Optional |
|
enableUltraSSD | bool Optional |
|
gpuInstanceProfile | GPUInstanceProfile_STATUS Optional |
|
kubeletConfig | KubeletConfig_STATUS Optional |
|
kubeletDiskType | KubeletDiskType_STATUS Optional |
|
linuxOSConfig | LinuxOSConfig_STATUS Optional |
|
maxCount | int Optional |
|
maxPods | int Optional |
|
minCount | int Optional |
|
mode | AgentPoolMode_STATUS Optional |
|
name | string Optional |
|
nodeImageVersion | string Optional |
|
nodeLabels | map[string]string Optional |
|
nodePublicIPPrefixID | string Optional |
|
nodeTaints | string[] Optional |
|
orchestratorVersion | string Optional |
|
osDiskSizeGB | int Optional |
|
osDiskType | OSDiskType_STATUS Optional |
|
osSKU | OSSKU_STATUS Optional |
|
osType | OSType_STATUS Optional |
|
podSubnetID | string Optional |
|
powerState | PowerState_STATUS Optional |
|
provisioningState | string Optional |
|
proximityPlacementGroupID | string Optional |
|
scaleSetEvictionPolicy | ScaleSetEvictionPolicy_STATUS Optional |
|
scaleSetPriority | ScaleSetPriority_STATUS Optional |
|
spotMaxPrice | float64 Optional |
|
tags | map[string]string Optional |
|
type | AgentPoolType_STATUS Optional |
|
upgradeSettings | AgentPoolUpgradeSettings_STATUS Optional |
|
vmSize | string Optional |
|
vnetSubnetID | string Optional |
ManagedClusterAPIServerAccessProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
authorizedIPRanges | string[] Optional |
|
enablePrivateCluster | bool Optional |
|
enablePrivateClusterPublicFQDN | bool Optional |
|
privateDNSZone | string Optional |
ManagedClusterAPIServerAccessProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
authorizedIPRanges | string[] Optional |
|
enablePrivateCluster | bool Optional |
|
enablePrivateClusterPublicFQDN | bool Optional |
|
privateDNSZone | string Optional |
ManagedClusterAutoUpgradeProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
upgradeChannel | ManagedClusterAutoUpgradeProfile_UpgradeChannel Optional |
ManagedClusterAutoUpgradeProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
upgradeChannel | ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS Optional |
ManagedClusterHTTPProxyConfig
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
httpProxy | string Optional |
|
httpsProxy | string Optional |
|
noProxy | string[] Optional |
|
trustedCa | string Optional |
ManagedClusterHTTPProxyConfig_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
httpProxy | string Optional |
|
httpsProxy | string Optional |
|
noProxy | string[] Optional |
|
trustedCa | string Optional |
ManagedClusterIdentity
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
type | ManagedClusterIdentity_Type Optional |
|
userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedClusterIdentity_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
principalId | string Optional |
|
tenantId | string Optional |
|
type | ManagedClusterIdentity_Type_STATUS Optional |
|
userAssignedIdentities | map[string]ManagedClusterIdentity_UserAssignedIdentities_STATUS Optional |
ManagedClusterOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
secrets | configures where to place Azure generated secrets. | ManagedClusterOperatorSecrets Optional |
ManagedClusterPodIdentityProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
allowNetworkPluginKubenet | bool Optional |
|
enabled | bool Optional |
|
userAssignedIdentities | ManagedClusterPodIdentity[] Optional |
|
userAssignedIdentityExceptions | ManagedClusterPodIdentityException[] Optional |
ManagedClusterPodIdentityProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
allowNetworkPluginKubenet | bool Optional |
|
enabled | bool Optional |
|
userAssignedIdentities | ManagedClusterPodIdentity_STATUS[] Optional |
|
userAssignedIdentityExceptions | ManagedClusterPodIdentityException_STATUS[] Optional |
ManagedClusterProperties_AutoScalerProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
balance-similar-node-groups | string Optional |
|
expander | ManagedClusterProperties_AutoScalerProfile_Expander Optional |
|
max-empty-bulk-delete | string Optional |
|
max-graceful-termination-sec | string Optional |
|
max-node-provision-time | string Optional |
|
max-total-unready-percentage | string Optional |
|
new-pod-scale-up-delay | string Optional |
|
ok-total-unready-count | string Optional |
|
scale-down-delay-after-add | string Optional |
|
scale-down-delay-after-delete | string Optional |
|
scale-down-delay-after-failure | string Optional |
|
scale-down-unneeded-time | string Optional |
|
scale-down-unready-time | string Optional |
|
scale-down-utilization-threshold | string Optional |
|
scan-interval | string Optional |
|
skip-nodes-with-local-storage | string Optional |
|
skip-nodes-with-system-pods | string Optional |
ManagedClusterProperties_AutoScalerProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
balance-similar-node-groups | string Optional |
|
expander | ManagedClusterProperties_AutoScalerProfile_Expander_STATUS Optional |
|
max-empty-bulk-delete | string Optional |
|
max-graceful-termination-sec | string Optional |
|
max-node-provision-time | string Optional |
|
max-total-unready-percentage | string Optional |
|
new-pod-scale-up-delay | string Optional |
|
ok-total-unready-count | string Optional |
|
scale-down-delay-after-add | string Optional |
|
scale-down-delay-after-delete | string Optional |
|
scale-down-delay-after-failure | string Optional |
|
scale-down-unneeded-time | string Optional |
|
scale-down-unready-time | string Optional |
|
scale-down-utilization-threshold | string Optional |
|
scan-interval | string Optional |
|
skip-nodes-with-local-storage | string Optional |
|
skip-nodes-with-system-pods | string Optional |
ManagedClustersAgentPoolOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ManagedClustersAgentPool_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ManagedClusterServicePrincipalProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
clientId | string Required |
|
secret | genruntime.SecretReference Optional |
ManagedClusterServicePrincipalProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
clientId | string Optional |
ManagedClusterSKU
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
name | ManagedClusterSKU_Name Optional |
|
tier | ManagedClusterSKU_Tier Optional |
ManagedClusterSKU_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
name | ManagedClusterSKU_Name_STATUS Optional |
|
tier | ManagedClusterSKU_Tier_STATUS Optional |
ManagedClusterWindowsProfile
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
adminPassword | genruntime.SecretReference Optional |
|
adminUsername | string Required |
|
enableCSIProxy | bool Optional |
|
licenseType | ManagedClusterWindowsProfile_LicenseType Optional |
ManagedClusterWindowsProfile_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
adminUsername | string Optional |
|
enableCSIProxy | bool Optional |
|
licenseType | ManagedClusterWindowsProfile_LicenseType_STATUS Optional |
OSDiskType
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“Ephemeral” | |
“Managed” |
OSDiskType_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“Ephemeral” | |
“Managed” |
OSSKU
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“CBLMariner” | |
“Ubuntu” |
OSSKU_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“CBLMariner” | |
“Ubuntu” |
OSType
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“Linux” | |
“Windows” |
OSType_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“Linux” | |
“Windows” |
PowerState_STATUS
Used by: ManagedCluster_STATUS, ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Property | Description | Type |
---|---|---|
code | PowerState_Code_STATUS Optional |
PrivateLinkResource
Used by: ManagedCluster_Spec.
Property | Description | Type |
---|---|---|
groupId | string Optional |
|
name | string Optional |
|
reference | genruntime.ResourceReference Optional |
|
requiredMembers | string[] Optional |
|
type | string Optional |
PrivateLinkResource_STATUS
Used by: ManagedCluster_STATUS.
Property | Description | Type |
---|---|---|
groupId | string Optional |
|
id | string Optional |
|
name | string Optional |
|
privateLinkServiceID | string Optional |
|
requiredMembers | string[] Optional |
|
type | string Optional |
ScaleSetEvictionPolicy
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“Deallocate” | |
“Delete” |
ScaleSetEvictionPolicy_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“Deallocate” | |
“Delete” |
ScaleSetPriority
Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.
Value | Description |
---|---|
“Regular” | |
“Spot” |
ScaleSetPriority_STATUS
Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.
Value | Description |
---|---|
“Regular” | |
“Spot” |
UserAssignedIdentity
Used by: ManagedCluster_Spec, and ManagedClusterPodIdentity.
Property | Description | Type |
---|---|---|
clientId | string Optional |
|
objectId | string Optional |
|
resourceReference | genruntime.ResourceReference Optional |
UserAssignedIdentity_STATUS
Used by: ManagedCluster_STATUS, ManagedClusterAddonProfile_STATUS, and ManagedClusterPodIdentity_STATUS.
Property | Description | Type |
---|---|---|
clientId | string Optional |
|
objectId | string Optional |
|
resourceId | string Optional |
ContainerServiceNetworkProfile_LoadBalancerSku
Used by: ContainerServiceNetworkProfile.
Value | Description |
---|---|
“basic” | |
“standard” |
ContainerServiceNetworkProfile_LoadBalancerSku_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Value | Description |
---|---|
“basic” | |
“standard” |
ContainerServiceNetworkProfile_NetworkMode
Used by: ContainerServiceNetworkProfile.
Value | Description |
---|---|
“bridge” | |
“transparent” |
ContainerServiceNetworkProfile_NetworkMode_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Value | Description |
---|---|
“bridge” | |
“transparent” |
ContainerServiceNetworkProfile_NetworkPlugin
Used by: ContainerServiceNetworkProfile.
Value | Description |
---|---|
“azure” | |
“kubenet” |
ContainerServiceNetworkProfile_NetworkPlugin_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Value | Description |
---|---|
“azure” | |
“kubenet” |
ContainerServiceNetworkProfile_NetworkPolicy
Used by: ContainerServiceNetworkProfile.
Value | Description |
---|---|
“azure” | |
“calico” |
ContainerServiceNetworkProfile_NetworkPolicy_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Value | Description |
---|---|
“azure” | |
“calico” |
ContainerServiceNetworkProfile_OutboundType
Used by: ContainerServiceNetworkProfile.
Value | Description |
---|---|
“loadBalancer” | |
“userDefinedRouting” |
ContainerServiceNetworkProfile_OutboundType_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Value | Description |
---|---|
“loadBalancer” | |
“userDefinedRouting” |
ContainerServiceSshConfiguration
Used by: ContainerServiceLinuxProfile.
Property | Description | Type |
---|---|---|
publicKeys | ContainerServiceSshPublicKey[] Required |
ContainerServiceSshConfiguration_STATUS
Used by: ContainerServiceLinuxProfile_STATUS.
Property | Description | Type |
---|---|---|
publicKeys | ContainerServiceSshPublicKey_STATUS[] Optional |
ExtendedLocationType
Used by: ExtendedLocation.
Value | Description |
---|---|
“EdgeZone” |
ExtendedLocationType_STATUS
Used by: ExtendedLocation_STATUS.
Value | Description |
---|---|
“EdgeZone” |
ManagedClusterAutoUpgradeProfile_UpgradeChannel
Used by: ManagedClusterAutoUpgradeProfile.
Value | Description |
---|---|
“node-image” | |
“none” | |
“patch” | |
“rapid” | |
“stable” |
ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS
Used by: ManagedClusterAutoUpgradeProfile_STATUS.
Value | Description |
---|---|
“node-image” | |
“none” | |
“patch” | |
“rapid” | |
“stable” |
ManagedClusterIdentity_Type
Used by: ManagedClusterIdentity.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“UserAssigned” |
ManagedClusterIdentity_Type_STATUS
Used by: ManagedClusterIdentity_STATUS.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“UserAssigned” |
ManagedClusterIdentity_UserAssignedIdentities_STATUS
Used by: ManagedClusterIdentity_STATUS.
Property | Description | Type |
---|---|---|
clientId | string Optional |
|
principalId | string Optional |
ManagedClusterLoadBalancerProfile
Used by: ContainerServiceNetworkProfile.
Property | Description | Type |
---|---|---|
allocatedOutboundPorts | int Optional |
|
effectiveOutboundIPs | ResourceReference[] Optional |
|
idleTimeoutInMinutes | int Optional |
|
managedOutboundIPs | ManagedClusterLoadBalancerProfile_ManagedOutboundIPs Optional |
|
outboundIPPrefixes | ManagedClusterLoadBalancerProfile_OutboundIPPrefixes Optional |
|
outboundIPs | ManagedClusterLoadBalancerProfile_OutboundIPs Optional |
ManagedClusterLoadBalancerProfile_STATUS
Used by: ContainerServiceNetworkProfile_STATUS.
Property | Description | Type |
---|---|---|
allocatedOutboundPorts | int Optional |
|
effectiveOutboundIPs | ResourceReference_STATUS[] Optional |
|
idleTimeoutInMinutes | int Optional |
|
managedOutboundIPs | ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS Optional |
|
outboundIPPrefixes | ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS Optional |
|
outboundIPs | ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS Optional |
ManagedClusterOperatorSecrets
Used by: ManagedClusterOperatorSpec.
Property | Description | Type |
---|---|---|
adminCredentials | indicates where the AdminCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
userCredentials | indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
ManagedClusterPodIdentity
Used by: ManagedClusterPodIdentityProfile.
Property | Description | Type |
---|---|---|
bindingSelector | string Optional |
|
identity | UserAssignedIdentity Required |
|
name | string Required |
|
namespace | string Required |
ManagedClusterPodIdentity_STATUS
Used by: ManagedClusterPodIdentityProfile_STATUS.
Property | Description | Type |
---|---|---|
bindingSelector | string Optional |
|
identity | UserAssignedIdentity_STATUS Optional |
|
name | string Optional |
|
namespace | string Optional |
|
provisioningInfo | ManagedClusterPodIdentity_ProvisioningInfo_STATUS Optional |
|
provisioningState | ManagedClusterPodIdentity_ProvisioningState_STATUS Optional |
ManagedClusterPodIdentityException
Used by: ManagedClusterPodIdentityProfile.
Property | Description | Type |
---|---|---|
name | string Required |
|
namespace | string Required |
|
podLabels | map[string]string Required |
ManagedClusterPodIdentityException_STATUS
Used by: ManagedClusterPodIdentityProfile_STATUS.
Property | Description | Type |
---|---|---|
name | string Optional |
|
namespace | string Optional |
|
podLabels | map[string]string Optional |
ManagedClusterProperties_AutoScalerProfile_Expander
Used by: ManagedClusterProperties_AutoScalerProfile.
Value | Description |
---|---|
“least-waste” | |
“most-pods” | |
“priority” | |
“random” |
ManagedClusterProperties_AutoScalerProfile_Expander_STATUS
Used by: ManagedClusterProperties_AutoScalerProfile_STATUS.
Value | Description |
---|---|
“least-waste” | |
“most-pods” | |
“priority” | |
“random” |
ManagedClusterSKU_Name
Used by: ManagedClusterSKU.
Value | Description |
---|---|
“Basic” |
ManagedClusterSKU_Name_STATUS
Used by: ManagedClusterSKU_STATUS.
Value | Description |
---|---|
“Basic” |
ManagedClusterSKU_Tier
Used by: ManagedClusterSKU.
Value | Description |
---|---|
“Free” | |
“Paid” |
ManagedClusterSKU_Tier_STATUS
Used by: ManagedClusterSKU_STATUS.
Value | Description |
---|---|
“Free” | |
“Paid” |
ManagedClusterWindowsProfile_LicenseType
Used by: ManagedClusterWindowsProfile.
Value | Description |
---|---|
“None” | |
“Windows_Server” |
ManagedClusterWindowsProfile_LicenseType_STATUS
Used by: ManagedClusterWindowsProfile_STATUS.
Value | Description |
---|---|
“None” | |
“Windows_Server” |
PowerState_Code_STATUS
Used by: PowerState_STATUS.
Value | Description |
---|---|
“Running” | |
“Stopped” |
SysctlConfig
Used by: LinuxOSConfig.
Property | Description | Type |
---|---|---|
fsAioMaxNr | int Optional |
|
fsFileMax | int Optional |
|
fsInotifyMaxUserWatches | int Optional |
|
fsNrOpen | int Optional |
|
kernelThreadsMax | int Optional |
|
netCoreNetdevMaxBacklog | int Optional |
|
netCoreOptmemMax | int Optional |
|
netCoreRmemDefault | int Optional |
|
netCoreRmemMax | int Optional |
|
netCoreSomaxconn | int Optional |
|
netCoreWmemDefault | int Optional |
|
netCoreWmemMax | int Optional |
|
netIpv4IpLocalPortRange | string Optional |
|
netIpv4NeighDefaultGcThresh1 | int Optional |
|
netIpv4NeighDefaultGcThresh2 | int Optional |
|
netIpv4NeighDefaultGcThresh3 | int Optional |
|
netIpv4TcpFinTimeout | int Optional |
|
netIpv4TcpkeepaliveIntvl | int Optional |
|
netIpv4TcpKeepaliveProbes | int Optional |
|
netIpv4TcpKeepaliveTime | int Optional |
|
netIpv4TcpMaxSynBacklog | int Optional |
|
netIpv4TcpMaxTwBuckets | int Optional |
|
netIpv4TcpTwReuse | bool Optional |
|
netNetfilterNfConntrackBuckets | int Optional |
|
netNetfilterNfConntrackMax | int Optional |
|
vmMaxMapCount | int Optional |
|
vmSwappiness | int Optional |
|
vmVfsCachePressure | int Optional |
SysctlConfig_STATUS
Used by: LinuxOSConfig_STATUS.
Property | Description | Type |
---|---|---|
fsAioMaxNr | int Optional |
|
fsFileMax | int Optional |
|
fsInotifyMaxUserWatches | int Optional |
|
fsNrOpen | int Optional |
|
kernelThreadsMax | int Optional |
|
netCoreNetdevMaxBacklog | int Optional |
|
netCoreOptmemMax | int Optional |
|
netCoreRmemDefault | int Optional |
|
netCoreRmemMax | int Optional |
|
netCoreSomaxconn | int Optional |
|
netCoreWmemDefault | int Optional |
|
netCoreWmemMax | int Optional |
|
netIpv4IpLocalPortRange | string Optional |
|
netIpv4NeighDefaultGcThresh1 | int Optional |
|
netIpv4NeighDefaultGcThresh2 | int Optional |
|
netIpv4NeighDefaultGcThresh3 | int Optional |
|
netIpv4TcpFinTimeout | int Optional |
|
netIpv4TcpkeepaliveIntvl | int Optional |
|
netIpv4TcpKeepaliveProbes | int Optional |
|
netIpv4TcpKeepaliveTime | int Optional |
|
netIpv4TcpMaxSynBacklog | int Optional |
|
netIpv4TcpMaxTwBuckets | int Optional |
|
netIpv4TcpTwReuse | bool Optional |
|
netNetfilterNfConntrackBuckets | int Optional |
|
netNetfilterNfConntrackMax | int Optional |
|
vmMaxMapCount | int Optional |
|
vmSwappiness | int Optional |
|
vmVfsCachePressure | int Optional |
UserAssignedIdentityDetails
Used by: ManagedClusterIdentity.
Property | Description | Type |
---|---|---|
reference | genruntime.ResourceReference Optional |
ContainerServiceSshPublicKey
Used by: ContainerServiceSshConfiguration.
Property | Description | Type |
---|---|---|
keyData | string Required |
ContainerServiceSshPublicKey_STATUS
Used by: ContainerServiceSshConfiguration_STATUS.
Property | Description | Type |
---|---|---|
keyData | string Optional |
ManagedClusterLoadBalancerProfile_ManagedOutboundIPs
Used by: ManagedClusterLoadBalancerProfile.
Property | Description | Type |
---|---|---|
count | int Optional |
ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS
Used by: ManagedClusterLoadBalancerProfile_STATUS.
Property | Description | Type |
---|---|---|
count | int Optional |
ManagedClusterLoadBalancerProfile_OutboundIPPrefixes
Used by: ManagedClusterLoadBalancerProfile.
Property | Description | Type |
---|---|---|
publicIPPrefixes | ResourceReference[] Optional |
ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS
Used by: ManagedClusterLoadBalancerProfile_STATUS.
Property | Description | Type |
---|---|---|
publicIPPrefixes | ResourceReference_STATUS[] Optional |
ManagedClusterLoadBalancerProfile_OutboundIPs
Used by: ManagedClusterLoadBalancerProfile.
Property | Description | Type |
---|---|---|
publicIPs | ResourceReference[] Optional |
ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS
Used by: ManagedClusterLoadBalancerProfile_STATUS.
Property | Description | Type |
---|---|---|
publicIPs | ResourceReference_STATUS[] Optional |
ManagedClusterPodIdentity_ProvisioningInfo_STATUS
Used by: ManagedClusterPodIdentity_STATUS.
Property | Description | Type |
---|---|---|
error | ManagedClusterPodIdentityProvisioningError_STATUS Optional |
ManagedClusterPodIdentity_ProvisioningState_STATUS
Used by: ManagedClusterPodIdentity_STATUS.
Value | Description |
---|---|
“Assigned” | |
“Deleting” | |
“Failed” | |
“Updating” |
ResourceReference
Used by: ManagedClusterLoadBalancerProfile, ManagedClusterLoadBalancerProfile_OutboundIPPrefixes, and ManagedClusterLoadBalancerProfile_OutboundIPs.
Property | Description | Type |
---|---|---|
reference | genruntime.ResourceReference Optional |
ResourceReference_STATUS
Used by: ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS, ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS, and ManagedClusterLoadBalancerProfile_STATUS.
Property | Description | Type |
---|---|---|
id | string Optional |
ManagedClusterPodIdentityProvisioningError_STATUS
Used by: ManagedClusterPodIdentity_ProvisioningInfo_STATUS.
Property | Description | Type |
---|---|---|
error | ManagedClusterPodIdentityProvisioningErrorBody_STATUS Optional |
ManagedClusterPodIdentityProvisioningErrorBody_STATUS
Used by: ManagedClusterPodIdentityProvisioningError_STATUS.
Property | Description | Type |
---|---|---|
code | string Optional |
|
details | ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled[] Optional |
|
message | string Optional |
|
target | string Optional |
ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled
Used by: ManagedClusterPodIdentityProvisioningErrorBody_STATUS.
Property | Description | Type |
---|---|---|
code | string Optional |
|
message | string Optional |
|
target | string Optional |