azure-native-v2.containerservice.getManagedCluster

func LookupManagedCluster(ctx *Context, args *LookupManagedClusterArgs, opts ...InvokeOption) (*LookupManagedClusterResult, error)
func LookupManagedClusterOutput(ctx *Context, args *LookupManagedClusterOutputArgs, opts ...InvokeOption) LookupManagedClusterResultOutput

> Note: This function is named LookupManagedCluster in the Go SDK.

ResourceGroupName

This property is required.

Changes to this property will trigger replacement.

string

The name of the resource group. The name is case insensitive.

ResourceName

This property is required.

Changes to this property will trigger replacement.

string

The name of the managed cluster resource.

ResourceGroupName

This property is required.

Changes to this property will trigger replacement.

string

The name of the resource group. The name is case insensitive.

ResourceName

This property is required.

Changes to this property will trigger replacement.

string

The name of the managed cluster resource.

resourceGroupName

This property is required.

Changes to this property will trigger replacement.

String

The name of the resource group. The name is case insensitive.

resourceName

This property is required.

Changes to this property will trigger replacement.

String

The name of the managed cluster resource.

resource_group_name

This property is required.

Changes to this property will trigger replacement.

str

The name of the resource group. The name is case insensitive.

resource_name

This property is required.

Changes to this property will trigger replacement.

str

The name of the managed cluster resource.

resourceGroupName

This property is required.

Changes to this property will trigger replacement.

String

The name of the resource group. The name is case insensitive.

resourceName

This property is required.

Changes to this property will trigger replacement.

String

The name of the managed cluster resource.

AzurePortalFQDN string

The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

CurrentKubernetesVersion string

If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.

Fqdn string

The FQDN of the master pool.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

MaxAgentPools int

The max number of agent pools for the managed cluster.

Name string

The name of the resource

PowerState Pulumi.AzureNative.ContainerService.Outputs.PowerStateResponse

The Power State of the cluster.

PrivateFQDN string

The FQDN of private cluster.

ProvisioningState string

The current provisioning state.

SystemData Pulumi.AzureNative.ContainerService.Outputs.SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AadProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAADProfileResponse

The Azure Active Directory configuration.

AddonProfiles Dictionary<string, Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAddonProfileResponse>

The profile of managed cluster add-on.

AgentPoolProfiles List<Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAgentPoolProfileResponse>

The agent pool properties.

ApiServerAccessProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAPIServerAccessProfileResponse

The access profile for managed cluster API server.

AutoScalerProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterPropertiesResponseAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

AutoUpgradeProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAutoUpgradeProfileResponse

The auto upgrade configuration.

AzureMonitorProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterAzureMonitorProfileResponse

Azure Monitor addon profiles for monitoring the managed cluster.

DisableLocalAccounts bool

If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

DiskEncryptionSetID string

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

DnsPrefix string

This cannot be updated once the Managed Cluster has been created.

EnablePodSecurityPolicy bool

(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

EnableRBAC bool

Whether to enable Kubernetes Role-Based Access Control.

ExtendedLocation Pulumi.AzureNative.ContainerService.Outputs.ExtendedLocationResponse

The extended location of the Virtual Machine.

FqdnSubdomain string

This cannot be updated once the Managed Cluster has been created.

HttpProxyConfig Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterHTTPProxyConfigResponse

Configurations for provisioning the cluster with HTTP proxy servers.

Identity Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterIdentityResponse

The identity of the managed cluster, if configured.

IdentityProfile Dictionary<string, Pulumi.AzureNative.ContainerService.Outputs.UserAssignedIdentityResponse>

Identities associated with the cluster.

KubernetesVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

LinuxProfile Pulumi.AzureNative.ContainerService.Outputs.ContainerServiceLinuxProfileResponse

The profile for Linux VMs in the Managed Cluster.

NetworkProfile Pulumi.AzureNative.ContainerService.Outputs.ContainerServiceNetworkProfileResponse

The network configuration profile.

NodeResourceGroup string

The name of the resource group containing agent pool nodes.

OidcIssuerProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterOIDCIssuerProfileResponse

The OIDC issuer profile of the Managed Cluster.

PodIdentityProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterPodIdentityProfileResponse

See use AAD pod identity for more details on AAD pod identity integration.

PrivateLinkResources List<Pulumi.AzureNative.ContainerService.Outputs.PrivateLinkResourceResponse>

Private link resources associated with the cluster.

PublicNetworkAccess string

Allow or deny public network access for AKS

SecurityProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterSecurityProfileResponse

Security profile for the managed cluster.

ServicePrincipalProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterServicePrincipalProfileResponse

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

Sku Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterSKUResponse

The managed cluster SKU.

StorageProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterStorageProfileResponse

Storage profile for the managed cluster.

SupportPlan string

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

Tags Dictionary<string, string>

Resource tags.

WindowsProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterWindowsProfileResponse

The profile for Windows VMs in the Managed Cluster.

WorkloadAutoScalerProfile Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterWorkloadAutoScalerProfileResponse

Workload Auto-scaler profile for the managed cluster.

AzurePortalFQDN string

The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

CurrentKubernetesVersion string

If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.

Fqdn string

The FQDN of the master pool.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

MaxAgentPools int

The max number of agent pools for the managed cluster.

Name string

The name of the resource

PowerState PowerStateResponse

The Power State of the cluster.

PrivateFQDN string

The FQDN of private cluster.

ProvisioningState string

The current provisioning state.

SystemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AadProfile ManagedClusterAADProfileResponse

The Azure Active Directory configuration.

AddonProfiles map[string]ManagedClusterAddonProfileResponse

The profile of managed cluster add-on.

AgentPoolProfiles []ManagedClusterAgentPoolProfileResponse

The agent pool properties.

ApiServerAccessProfile ManagedClusterAPIServerAccessProfileResponse

The access profile for managed cluster API server.

AutoScalerProfile ManagedClusterPropertiesResponseAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

AutoUpgradeProfile ManagedClusterAutoUpgradeProfileResponse

The auto upgrade configuration.

AzureMonitorProfile ManagedClusterAzureMonitorProfileResponse

Azure Monitor addon profiles for monitoring the managed cluster.

DisableLocalAccounts bool

If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

DiskEncryptionSetID string

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

DnsPrefix string

This cannot be updated once the Managed Cluster has been created.

EnablePodSecurityPolicy bool

(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

EnableRBAC bool

Whether to enable Kubernetes Role-Based Access Control.

ExtendedLocation ExtendedLocationResponse

The extended location of the Virtual Machine.

FqdnSubdomain string

This cannot be updated once the Managed Cluster has been created.

HttpProxyConfig ManagedClusterHTTPProxyConfigResponse

Configurations for provisioning the cluster with HTTP proxy servers.

Identity ManagedClusterIdentityResponse

The identity of the managed cluster, if configured.

IdentityProfile map[string]UserAssignedIdentityResponse

Identities associated with the cluster.

KubernetesVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

LinuxProfile ContainerServiceLinuxProfileResponse

The profile for Linux VMs in the Managed Cluster.

NetworkProfile ContainerServiceNetworkProfileResponse

The network configuration profile.

NodeResourceGroup string

The name of the resource group containing agent pool nodes.

OidcIssuerProfile ManagedClusterOIDCIssuerProfileResponse

The OIDC issuer profile of the Managed Cluster.

PodIdentityProfile ManagedClusterPodIdentityProfileResponse

See use AAD pod identity for more details on AAD pod identity integration.

PrivateLinkResources []PrivateLinkResourceResponse

Private link resources associated with the cluster.

PublicNetworkAccess string

Allow or deny public network access for AKS

SecurityProfile ManagedClusterSecurityProfileResponse

Security profile for the managed cluster.

ServicePrincipalProfile ManagedClusterServicePrincipalProfileResponse

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

Sku ManagedClusterSKUResponse

The managed cluster SKU.

StorageProfile ManagedClusterStorageProfileResponse

Storage profile for the managed cluster.

SupportPlan string

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

Tags map[string]string

Resource tags.

WindowsProfile ManagedClusterWindowsProfileResponse

The profile for Windows VMs in the Managed Cluster.

WorkloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfileResponse

Workload Auto-scaler profile for the managed cluster.

azurePortalFQDN String

The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

currentKubernetesVersion String

If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.

fqdn String

The FQDN of the master pool.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

maxAgentPools Integer

The max number of agent pools for the managed cluster.

name String

The name of the resource

powerState PowerStateResponse

The Power State of the cluster.

privateFQDN String

The FQDN of private cluster.

provisioningState String

The current provisioning state.

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

aadProfile ManagedClusterAADProfileResponse

The Azure Active Directory configuration.

addonProfiles Map<String,ManagedClusterAddonProfileResponse>

The profile of managed cluster add-on.

agentPoolProfiles List<ManagedClusterAgentPoolProfileResponse>

The agent pool properties.

apiServerAccessProfile ManagedClusterAPIServerAccessProfileResponse

The access profile for managed cluster API server.

autoScalerProfile ManagedClusterPropertiesResponseAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

autoUpgradeProfile ManagedClusterAutoUpgradeProfileResponse

The auto upgrade configuration.

azureMonitorProfile ManagedClusterAzureMonitorProfileResponse

Azure Monitor addon profiles for monitoring the managed cluster.

disableLocalAccounts Boolean

If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

diskEncryptionSetID String

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

dnsPrefix String

This cannot be updated once the Managed Cluster has been created.

enablePodSecurityPolicy Boolean

(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

enableRBAC Boolean

Whether to enable Kubernetes Role-Based Access Control.

extendedLocation ExtendedLocationResponse

The extended location of the Virtual Machine.

fqdnSubdomain String

This cannot be updated once the Managed Cluster has been created.

httpProxyConfig ManagedClusterHTTPProxyConfigResponse

Configurations for provisioning the cluster with HTTP proxy servers.

identity ManagedClusterIdentityResponse

The identity of the managed cluster, if configured.

identityProfile Map<String,UserAssignedIdentityResponse>

Identities associated with the cluster.

kubernetesVersion String

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

linuxProfile ContainerServiceLinuxProfileResponse

The profile for Linux VMs in the Managed Cluster.

networkProfile ContainerServiceNetworkProfileResponse

The network configuration profile.

nodeResourceGroup String

The name of the resource group containing agent pool nodes.

oidcIssuerProfile ManagedClusterOIDCIssuerProfileResponse

The OIDC issuer profile of the Managed Cluster.

podIdentityProfile ManagedClusterPodIdentityProfileResponse

See use AAD pod identity for more details on AAD pod identity integration.

privateLinkResources List<PrivateLinkResourceResponse>

Private link resources associated with the cluster.

publicNetworkAccess String

Allow or deny public network access for AKS

securityProfile ManagedClusterSecurityProfileResponse

Security profile for the managed cluster.

servicePrincipalProfile ManagedClusterServicePrincipalProfileResponse

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

sku ManagedClusterSKUResponse

The managed cluster SKU.

storageProfile ManagedClusterStorageProfileResponse

Storage profile for the managed cluster.

supportPlan String

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

tags Map<String,String>

Resource tags.

windowsProfile ManagedClusterWindowsProfileResponse

The profile for Windows VMs in the Managed Cluster.

workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfileResponse

Workload Auto-scaler profile for the managed cluster.

azure_portal_fqdn str

The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

current_kubernetes_version str

If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.

fqdn str

The FQDN of the master pool.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location str

The geo-location where the resource lives

max_agent_pools int

The max number of agent pools for the managed cluster.

name str

The name of the resource

power_state PowerStateResponse

The Power State of the cluster.

private_fqdn str

The FQDN of private cluster.

provisioning_state str

The current provisioning state.

system_data SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

aad_profile ManagedClusterAADProfileResponse

The Azure Active Directory configuration.

addon_profiles Mapping[str, ManagedClusterAddonProfileResponse]

The profile of managed cluster add-on.

agent_pool_profiles Sequence[ManagedClusterAgentPoolProfileResponse]

The agent pool properties.

api_server_access_profile ManagedClusterAPIServerAccessProfileResponse

The access profile for managed cluster API server.

auto_scaler_profile ManagedClusterPropertiesResponseAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

auto_upgrade_profile ManagedClusterAutoUpgradeProfileResponse

The auto upgrade configuration.

azure_monitor_profile ManagedClusterAzureMonitorProfileResponse

Azure Monitor addon profiles for monitoring the managed cluster.

disable_local_accounts bool

If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

disk_encryption_set_id str

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

dns_prefix str

This cannot be updated once the Managed Cluster has been created.

enable_pod_security_policy bool

(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

enable_rbac bool

Whether to enable Kubernetes Role-Based Access Control.

extended_location ExtendedLocationResponse

The extended location of the Virtual Machine.

fqdn_subdomain str

This cannot be updated once the Managed Cluster has been created.

http_proxy_config ManagedClusterHTTPProxyConfigResponse

Configurations for provisioning the cluster with HTTP proxy servers.

identity ManagedClusterIdentityResponse

The identity of the managed cluster, if configured.

identity_profile Mapping[str, UserAssignedIdentityResponse]

Identities associated with the cluster.

kubernetes_version str

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

linux_profile ContainerServiceLinuxProfileResponse

The profile for Linux VMs in the Managed Cluster.

network_profile ContainerServiceNetworkProfileResponse

The network configuration profile.

node_resource_group str

The name of the resource group containing agent pool nodes.

oidc_issuer_profile ManagedClusterOIDCIssuerProfileResponse

The OIDC issuer profile of the Managed Cluster.

pod_identity_profile ManagedClusterPodIdentityProfileResponse

See use AAD pod identity for more details on AAD pod identity integration.

private_link_resources Sequence[PrivateLinkResourceResponse]

Private link resources associated with the cluster.

public_network_access str

Allow or deny public network access for AKS

security_profile ManagedClusterSecurityProfileResponse

Security profile for the managed cluster.

service_principal_profile ManagedClusterServicePrincipalProfileResponse

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

sku ManagedClusterSKUResponse

The managed cluster SKU.

storage_profile ManagedClusterStorageProfileResponse

Storage profile for the managed cluster.

support_plan str

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

tags Mapping[str, str]

Resource tags.

windows_profile ManagedClusterWindowsProfileResponse

The profile for Windows VMs in the Managed Cluster.

workload_auto_scaler_profile ManagedClusterWorkloadAutoScalerProfileResponse

Workload Auto-scaler profile for the managed cluster.

azurePortalFQDN String

The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

currentKubernetesVersion String

If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.

fqdn String

The FQDN of the master pool.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

maxAgentPools Number

The max number of agent pools for the managed cluster.

name String

The name of the resource

powerState Property Map

The Power State of the cluster.

privateFQDN String

The FQDN of private cluster.

provisioningState String

The current provisioning state.

systemData Property Map

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

aadProfile Property Map

The Azure Active Directory configuration.

addonProfiles Map<Property Map>

The profile of managed cluster add-on.

agentPoolProfiles List<Property Map>

The agent pool properties.

apiServerAccessProfile Property Map

The access profile for managed cluster API server.

autoScalerProfile Property Map

Parameters to be applied to the cluster-autoscaler when enabled

autoUpgradeProfile Property Map

The auto upgrade configuration.

azureMonitorProfile Property Map

Azure Monitor addon profiles for monitoring the managed cluster.

disableLocalAccounts Boolean

If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

diskEncryptionSetID String

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

dnsPrefix String

This cannot be updated once the Managed Cluster has been created.

enablePodSecurityPolicy Boolean

(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

enableRBAC Boolean

Whether to enable Kubernetes Role-Based Access Control.

extendedLocation Property Map

The extended location of the Virtual Machine.

fqdnSubdomain String

This cannot be updated once the Managed Cluster has been created.

httpProxyConfig Property Map

Configurations for provisioning the cluster with HTTP proxy servers.

identity Property Map

The identity of the managed cluster, if configured.

identityProfile Map<Property Map>

Identities associated with the cluster.

kubernetesVersion String

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

linuxProfile Property Map

The profile for Linux VMs in the Managed Cluster.

networkProfile Property Map

The network configuration profile.

nodeResourceGroup String

The name of the resource group containing agent pool nodes.

oidcIssuerProfile Property Map

The OIDC issuer profile of the Managed Cluster.

podIdentityProfile Property Map

See use AAD pod identity for more details on AAD pod identity integration.

privateLinkResources List<Property Map>

Private link resources associated with the cluster.

publicNetworkAccess String

Allow or deny public network access for AKS

securityProfile Property Map

Security profile for the managed cluster.

servicePrincipalProfile Property Map

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

sku Property Map

The managed cluster SKU.

storageProfile Property Map

Storage profile for the managed cluster.

supportPlan String

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

tags Map<String>

Resource tags.

windowsProfile Property Map

The profile for Windows VMs in the Managed Cluster.

workloadAutoScalerProfile Property Map

Workload Auto-scaler profile for the managed cluster.

MaxSurge string

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

MaxSurge string

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

maxSurge String

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

max_surge str

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

maxSurge String

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

Enabled bool

Whether to enable Azure Key Vault key management service. The default is false.

KeyId string

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

KeyVaultNetworkAccess string

Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

KeyVaultResourceId string

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

Enabled bool

Whether to enable Azure Key Vault key management service. The default is false.

KeyId string

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

KeyVaultNetworkAccess string

Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

KeyVaultResourceId string

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

enabled Boolean

Whether to enable Azure Key Vault key management service. The default is false.

keyId String

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

keyVaultNetworkAccess String

Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

keyVaultResourceId String

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

enabled bool

Whether to enable Azure Key Vault key management service. The default is false.

key_id str

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

key_vault_network_access str

Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

key_vault_resource_id str

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

enabled Boolean

Whether to enable Azure Key Vault key management service. The default is false.

keyId String

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

keyVaultNetworkAccess String

Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

keyVaultResourceId String

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

AdminUsername This property is required. string

The administrator username to use for Linux VMs.

Ssh This property is required. Pulumi.AzureNative.ContainerService.Inputs.ContainerServiceSshConfigurationResponse

The SSH configuration for Linux-based VMs running on Azure.

AdminUsername This property is required. string

The administrator username to use for Linux VMs.

Ssh This property is required. ContainerServiceSshConfigurationResponse

The SSH configuration for Linux-based VMs running on Azure.

adminUsername This property is required. String

The administrator username to use for Linux VMs.

ssh This property is required. ContainerServiceSshConfigurationResponse

The SSH configuration for Linux-based VMs running on Azure.

admin_username This property is required. str

The administrator username to use for Linux VMs.

ssh This property is required. ContainerServiceSshConfigurationResponse

The SSH configuration for Linux-based VMs running on Azure.

adminUsername This property is required. String

The administrator username to use for Linux VMs.

ssh This property is required. Property Map

The SSH configuration for Linux-based VMs running on Azure.

DnsServiceIP string

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

IpFamilies List<string>

IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

LoadBalancerProfile Pulumi.AzureNative.ContainerService.Inputs.ManagedClusterLoadBalancerProfileResponse

Profile of the cluster load balancer.

LoadBalancerSku string

The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

NatGatewayProfile Pulumi.AzureNative.ContainerService.Inputs.ManagedClusterNATGatewayProfileResponse

Profile of the cluster NAT gateway.

NetworkDataplane string

Network dataplane used in the Kubernetes cluster.

NetworkMode string

This cannot be specified if networkPlugin is anything other than 'azure'.

NetworkPlugin string

Network plugin used for building the Kubernetes network.

NetworkPluginMode string

The mode the network plugin should use.

NetworkPolicy string

Network policy used for building the Kubernetes network.

OutboundType string

This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

PodCidr string

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

PodCidrs List<string>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

ServiceCidr string

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

ServiceCidrs List<string>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

DnsServiceIP string

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

IpFamilies []string

IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

LoadBalancerProfile ManagedClusterLoadBalancerProfileResponse

Profile of the cluster load balancer.

LoadBalancerSku string

The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

NatGatewayProfile ManagedClusterNATGatewayProfileResponse

Profile of the cluster NAT gateway.

NetworkDataplane string

Network dataplane used in the Kubernetes cluster.

NetworkMode string

This cannot be specified if networkPlugin is anything other than 'azure'.

NetworkPlugin string

Network plugin used for building the Kubernetes network.

NetworkPluginMode string

The mode the network plugin should use.

NetworkPolicy string

Network policy used for building the Kubernetes network.

OutboundType string

This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

PodCidr string

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

PodCidrs []string

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

ServiceCidr string

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

ServiceCidrs []string

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

dnsServiceIP String

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

ipFamilies List<String>

IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

loadBalancerProfile ManagedClusterLoadBalancerProfileResponse

Profile of the cluster load balancer.

loadBalancerSku String

The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

natGatewayProfile ManagedClusterNATGatewayProfileResponse

Profile of the cluster NAT gateway.

networkDataplane String

Network dataplane used in the Kubernetes cluster.

networkMode String

This cannot be specified if networkPlugin is anything other than 'azure'.

networkPlugin String

Network plugin used for building the Kubernetes network.

networkPluginMode String

The mode the network plugin should use.

networkPolicy String

Network policy used for building the Kubernetes network.

outboundType String

This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

podCidr String

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

podCidrs List<String>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

serviceCidr String

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

serviceCidrs List<String>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

dns_service_ip str

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

ip_families Sequence[str]

IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

load_balancer_profile ManagedClusterLoadBalancerProfileResponse

Profile of the cluster load balancer.

load_balancer_sku str

The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

nat_gateway_profile ManagedClusterNATGatewayProfileResponse

Profile of the cluster NAT gateway.

network_dataplane str

Network dataplane used in the Kubernetes cluster.

network_mode str

This cannot be specified if networkPlugin is anything other than 'azure'.

network_plugin str

Network plugin used for building the Kubernetes network.

network_plugin_mode str

The mode the network plugin should use.

network_policy str

Network policy used for building the Kubernetes network.

outbound_type str

This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

pod_cidr str

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

pod_cidrs Sequence[str]

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

service_cidr str

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

service_cidrs Sequence[str]

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

dnsServiceIP String

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

ipFamilies List<String>

IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

loadBalancerProfile Property Map

Profile of the cluster load balancer.

loadBalancerSku String

The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

natGatewayProfile Property Map

Profile of the cluster NAT gateway.

networkDataplane String

Network dataplane used in the Kubernetes cluster.

networkMode String

This cannot be specified if networkPlugin is anything other than 'azure'.

networkPlugin String

Network plugin used for building the Kubernetes network.

networkPluginMode String

The mode the network plugin should use.

networkPolicy String

Network policy used for building the Kubernetes network.

outboundType String

This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

podCidr String

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

podCidrs List<String>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

serviceCidr String

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

serviceCidrs List<String>

One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

PublicKeys This property is required. List<Pulumi.AzureNative.ContainerService.Inputs.ContainerServiceSshPublicKeyResponse>

The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

PublicKeys This property is required. []ContainerServiceSshPublicKeyResponse

The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

publicKeys This property is required. List<ContainerServiceSshPublicKeyResponse>

The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

public_keys This property is required. Sequence[ContainerServiceSshPublicKeyResponse]

The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

publicKeys This property is required. List<Property Map>

The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

KeyData This property is required. string

Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

KeyData This property is required. string

Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

keyData This property is required. String

Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

key_data This property is required. str

Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

keyData This property is required. String

Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

SourceResourceId string

This is the ARM ID of the source object to be used to create the target object.

SourceResourceId string

This is the ARM ID of the source object to be used to create the target object.

sourceResourceId String

This is the ARM ID of the source object to be used to create the target object.

source_resource_id str

This is the ARM ID of the source object to be used to create the target object.

sourceResourceId String

This is the ARM ID of the source object to be used to create the target object.

Name string

The name of the extended location.

Type string

The type of the extended location.

Name string

The name of the extended location.

Type string

The type of the extended location.

name String

The name of the extended location.

type String

The type of the extended location.

name str

The name of the extended location.

type str

The type of the extended location.

name String

The name of the extended location.

type String

The type of the extended location.

AllowedUnsafeSysctls List<string>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota bool

The default is true.

CpuCfsQuotaPeriod string

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

CpuManagerPolicy string

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

FailSwapOn bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold int

To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids int

The maximum number of processes per pod.

TopologyManagerPolicy string

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

AllowedUnsafeSysctls []string

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota bool

The default is true.

CpuCfsQuotaPeriod string

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

CpuManagerPolicy string

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

FailSwapOn bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold int

To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids int

The maximum number of processes per pod.

TopologyManagerPolicy string

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowedUnsafeSysctls List<String>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

containerLogMaxFiles Integer

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

containerLogMaxSizeMB Integer

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpuCfsQuota Boolean

The default is true.

cpuCfsQuotaPeriod String

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpuManagerPolicy String

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

failSwapOn Boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

imageGcHighThreshold Integer

To disable image garbage collection, set to 100. The default is 85%

imageGcLowThreshold Integer

This cannot be set higher than imageGcHighThreshold. The default is 80%

podMaxPids Integer

The maximum number of processes per pod.

topologyManagerPolicy String

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowed_unsafe_sysctls Sequence[str]

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

container_log_max_files int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

container_log_max_size_mb int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpu_cfs_quota bool

The default is true.

cpu_cfs_quota_period str

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpu_manager_policy str

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

fail_swap_on bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

image_gc_high_threshold int

To disable image garbage collection, set to 100. The default is 85%

image_gc_low_threshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

pod_max_pids int

The maximum number of processes per pod.

topology_manager_policy str

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowedUnsafeSysctls List<String>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

containerLogMaxFiles Number

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

containerLogMaxSizeMB Number

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpuCfsQuota Boolean

The default is true.

cpuCfsQuotaPeriod String

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpuManagerPolicy String

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

failSwapOn Boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

imageGcHighThreshold Number

To disable image garbage collection, set to 100. The default is 85%

imageGcLowThreshold Number

This cannot be set higher than imageGcHighThreshold. The default is 80%

podMaxPids Number

The maximum number of processes per pod.

topologyManagerPolicy String

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

SwapFileSizeMB int

The size in MB of a swap file that will be created on each node.

Sysctls Pulumi.AzureNative.ContainerService.Inputs.SysctlConfigResponse

Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag string

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

TransparentHugePageEnabled string

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

SwapFileSizeMB int

The size in MB of a swap file that will be created on each node.

Sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag string

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

TransparentHugePageEnabled string

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swapFileSizeMB Integer

The size in MB of a swap file that will be created on each node.

sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

transparentHugePageDefrag String

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparentHugePageEnabled String

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swap_file_size_mb int

The size in MB of a swap file that will be created on each node.

sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

transparent_huge_page_defrag str

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparent_huge_page_enabled str

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swapFileSizeMB Number

The size in MB of a swap file that will be created on each node.

sysctls Property Map

Sysctl settings for Linux agent nodes.

transparentHugePageDefrag String

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparentHugePageEnabled String

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

AdminGroupObjectIDs List<string>

The list of AAD group object IDs that will have admin role of the cluster.

ClientAppID string

(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

EnableAzureRBAC bool

Whether to enable Azure RBAC for Kubernetes authorization.

Managed bool

Whether to enable managed AAD.

ServerAppID string

(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

ServerAppSecret string

(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

TenantID string

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

AdminGroupObjectIDs []string

The list of AAD group object IDs that will have admin role of the cluster.

ClientAppID string

(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

EnableAzureRBAC bool

Whether to enable Azure RBAC for Kubernetes authorization.

Managed bool

Whether to enable managed AAD.

ServerAppID string

(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

ServerAppSecret string

(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

TenantID string

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

adminGroupObjectIDs List<String>

The list of AAD group object IDs that will have admin role of the cluster.

clientAppID String

(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

enableAzureRBAC Boolean

Whether to enable Azure RBAC for Kubernetes authorization.

managed Boolean

Whether to enable managed AAD.

serverAppID String

(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

serverAppSecret String

(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

tenantID String

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

admin_group_object_ids Sequence[str]

The list of AAD group object IDs that will have admin role of the cluster.

client_app_id str

(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

enable_azure_rbac bool

Whether to enable Azure RBAC for Kubernetes authorization.

managed bool

Whether to enable managed AAD.

server_app_id str

(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

server_app_secret str

(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

tenant_id str

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

adminGroupObjectIDs List<String>

The list of AAD group object IDs that will have admin role of the cluster.

clientAppID String

(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

enableAzureRBAC Boolean

Whether to enable Azure RBAC for Kubernetes authorization.

managed Boolean

Whether to enable managed AAD.

serverAppID String

(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

serverAppSecret String

(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

tenantID String

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

AuthorizedIPRanges List<string>

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

DisableRunCommand bool

Whether to disable run command for the cluster or not.

EnablePrivateCluster bool

For more details, see Creating a private AKS cluster.

EnablePrivateClusterPublicFQDN bool

Whether to create additional public FQDN for private cluster or not.

PrivateDNSZone string

The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

AuthorizedIPRanges []string

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

DisableRunCommand bool

Whether to disable run command for the cluster or not.

EnablePrivateCluster bool

For more details, see Creating a private AKS cluster.

EnablePrivateClusterPublicFQDN bool

Whether to create additional public FQDN for private cluster or not.

PrivateDNSZone string

The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

authorizedIPRanges List<String>

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

disableRunCommand Boolean

Whether to disable run command for the cluster or not.

enablePrivateCluster Boolean

For more details, see Creating a private AKS cluster.

enablePrivateClusterPublicFQDN Boolean

Whether to create additional public FQDN for private cluster or not.

privateDNSZone String

The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

authorized_ip_ranges Sequence[str]

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

disable_run_command bool

Whether to disable run command for the cluster or not.

enable_private_cluster bool

For more details, see Creating a private AKS cluster.

enable_private_cluster_public_fqdn bool

Whether to create additional public FQDN for private cluster or not.

private_dns_zone str

The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

authorizedIPRanges List<String>

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

disableRunCommand Boolean

Whether to disable run command for the cluster or not.

enablePrivateCluster Boolean

For more details, see Creating a private AKS cluster.

enablePrivateClusterPublicFQDN Boolean

Whether to create additional public FQDN for private cluster or not.

privateDNSZone String

The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

Enabled This property is required. bool

Whether the add-on is enabled or not.

Identity This property is required. Pulumi.AzureNative.ContainerService.Inputs.ManagedClusterAddonProfileResponseIdentity

Information of user assigned identity used by this add-on.

Config Dictionary<string, string>

Key-value pairs for configuring an add-on.

Enabled This property is required. bool

Whether the add-on is enabled or not.

Identity This property is required. ManagedClusterAddonProfileResponseIdentity

Information of user assigned identity used by this add-on.

Config map[string]string

Key-value pairs for configuring an add-on.

enabled This property is required. Boolean

Whether the add-on is enabled or not.

identity This property is required. ManagedClusterAddonProfileResponseIdentity

Information of user assigned identity used by this add-on.

config Map<String,String>

Key-value pairs for configuring an add-on.

enabled This property is required. bool

Whether the add-on is enabled or not.

identity This property is required. ManagedClusterAddonProfileResponseIdentity

Information of user assigned identity used by this add-on.

config Mapping[str, str]

Key-value pairs for configuring an add-on.

enabled This property is required. Boolean

Whether the add-on is enabled or not.

identity This property is required. Property Map

Information of user assigned identity used by this add-on.

config Map<String>

Key-value pairs for configuring an add-on.

ClientId string

The client ID of the user assigned identity.

ObjectId string

The object ID of the user assigned identity.

ResourceId string

The resource ID of the user assigned identity.

ClientId string

The client ID of the user assigned identity.

ObjectId string

The object ID of the user assigned identity.

ResourceId string

The resource ID of the user assigned identity.

clientId String

The client ID of the user assigned identity.

objectId String

The object ID of the user assigned identity.

resourceId String

The resource ID of the user assigned identity.

client_id str

The client ID of the user assigned identity.

object_id str

The object ID of the user assigned identity.

resource_id str

The resource ID of the user assigned identity.

clientId String

The client ID of the user assigned identity.

objectId String

The object ID of the user assigned identity.

resourceId String

The resource ID of the user assigned identity.

CurrentOrchestratorVersion This property is required. string

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

Name This property is required. string

Windows agent pool names must be 6 characters or less.

NodeImageVersion This property is required. string

The version of node image

ProvisioningState This property is required. string

The current deployment or provisioning state.

AvailabilityZones List<string>

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

Count int

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.

CreationData Pulumi.AzureNative.ContainerService.Inputs.CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

EnableAutoScaling bool

Whether to enable auto-scaler

EnableEncryptionAtHost bool

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

EnableFIPS bool

See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP bool

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.

EnableUltraSSD bool

Whether to enable UltraSSD

GpuInstanceProfile string

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

HostGroupID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig Pulumi.AzureNative.ContainerService.Inputs.KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

KubeletDiskType string

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig Pulumi.AzureNative.ContainerService.Inputs.LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount int

The minimum number of nodes for auto-scaling

Mode string

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

NodeLabels Dictionary<string, string>

The node labels to be persisted across all nodes in agent pool.

NodePublicIPPrefixID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

NodeTaints List<string>

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OrchestratorVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. 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.

OsDiskSizeGB int

OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

OsDiskType string

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 string

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.

OsType string

The operating system type. The default is Linux.

PodSubnetID string

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}

PowerState Pulumi.AzureNative.ContainerService.Inputs.PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProximityPlacementGroupID string

The ID for Proximity Placement Group.

ScaleDownMode string

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy string

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

ScaleSetPriority string

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

SpotMaxPrice double

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

Tags Dictionary<string, string>

The tags to be persisted on the agent pool virtual machine scale set.

Type string

The type of Agent Pool.

UpgradeSettings Pulumi.AzureNative.ContainerService.Inputs.AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

VmSize string

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

VnetSubnetID string

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}

WorkloadRuntime string

Determines the type of workload a node can run.

CurrentOrchestratorVersion This property is required. string

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

Name This property is required. string

Windows agent pool names must be 6 characters or less.

NodeImageVersion This property is required. string

The version of node image

ProvisioningState This property is required. string

The current deployment or provisioning state.

AvailabilityZones []string

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

Count int

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.

CreationData CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

EnableAutoScaling bool

Whether to enable auto-scaler

EnableEncryptionAtHost bool

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

EnableFIPS bool

See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP bool

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.

EnableUltraSSD bool

Whether to enable UltraSSD

GpuInstanceProfile string

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

HostGroupID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

KubeletDiskType string

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount int

The minimum number of nodes for auto-scaling

Mode string

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

NodeLabels map[string]string

The node labels to be persisted across all nodes in agent pool.

NodePublicIPPrefixID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

NodeTaints []string

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OrchestratorVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. 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.

OsDiskSizeGB int

OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

OsDiskType string

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 string

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.

OsType string

The operating system type. The default is Linux.

PodSubnetID string

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}

PowerState PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProximityPlacementGroupID string

The ID for Proximity Placement Group.

ScaleDownMode string

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy string

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

ScaleSetPriority string

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

SpotMaxPrice float64

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

Tags map[string]string

The tags to be persisted on the agent pool virtual machine scale set.

Type string

The type of Agent Pool.

UpgradeSettings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

VmSize string

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

VnetSubnetID string

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}

WorkloadRuntime string

Determines the type of workload a node can run.

currentOrchestratorVersion This property is required. String

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

name This property is required. String

Windows agent pool names must be 6 characters or less.

nodeImageVersion This property is required. String

The version of node image

provisioningState This property is required. String

The current deployment or provisioning state.

availabilityZones List<String>

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

count Integer

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.

creationData CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

enableAutoScaling Boolean

Whether to enable auto-scaler

enableEncryptionAtHost Boolean

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

enableFIPS Boolean

See Add a FIPS-enabled node pool for more details.

enableNodePublicIP Boolean

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.

enableUltraSSD Boolean

Whether to enable UltraSSD

gpuInstanceProfile String

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

hostGroupID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

kubeletConfig KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

kubeletDiskType String

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

linuxOSConfig LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

maxCount Integer

The maximum number of nodes for auto-scaling

maxPods Integer

The maximum number of pods that can run on a node.

minCount Integer

The minimum number of nodes for auto-scaling

mode String

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

nodeLabels Map<String,String>

The node labels to be persisted across all nodes in agent pool.

nodePublicIPPrefixID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodeTaints List<String>

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

orchestratorVersion String

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. 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.

osDiskSizeGB Integer

OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

osDiskType String

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 String

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.

osType String

The operating system type. The default is Linux.

podSubnetID String

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}

powerState PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

proximityPlacementGroupID String

The ID for Proximity Placement Group.

scaleDownMode String

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scaleSetEvictionPolicy String

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scaleSetPriority String

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

spotMaxPrice Double

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

tags Map<String,String>

The tags to be persisted on the agent pool virtual machine scale set.

type String

The type of Agent Pool.

upgradeSettings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

vmSize String

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

vnetSubnetID String

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}

workloadRuntime String

Determines the type of workload a node can run.