This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

azure_aks_cluster

api_server_access_profile

Type: STRUCT
Provider name: properties.apiServerAccessProfile
Description: Access profile for managed cluster API server.

  • authorized_ip_ranges
    Type: UNORDERED_LIST_STRING
    Provider name: authorizedIPRanges
    Description: Authorized IP Ranges to kubernetes API server.
  • enable_private_cluster
    Type: BOOLEAN
    Provider name: enablePrivateCluster
    Description: Whether to create the cluster as a private cluster or not.
  • private_dns_zone
    Type: STRING
    Provider name: privateDNSZone
    Description: Private dns zone mode for private cluster.

azure_portal_fqdn

Type: STRING
Provider name: properties.azurePortalFQDN
Description: FQDN for the master pool which used by proxy config.

disable_local_accounts

Type: BOOLEAN
Provider name: properties.disableLocalAccounts
Description: If set to true, getting static credential will be disabled for this cluster. Expected to only be used for AAD clusters.

disk_encryption_set_id

Type: STRING
Provider name: properties.diskEncryptionSetID
Description: ResourceId of the disk encryption set to use for enabling encryption at rest.

dns_prefix

Type: STRING
Provider name: properties.dnsPrefix
Description: DNS prefix specified when creating the managed cluster.

enable_pod_security_policy

Type: BOOLEAN
Provider name: properties.enablePodSecurityPolicy
Description: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

enable_rbac

Type: BOOLEAN
Provider name: properties.enableRBAC
Description: Whether to enable Kubernetes Role-Based Access Control.

fqdn

Type: STRING
Provider name: properties.fqdn
Description: FQDN for the master pool.

fqdn_subdomain

Type: STRING
Provider name: properties.fqdnSubdomain
Description: FQDN subdomain specified when creating private cluster with custom private dns zone.

id

Type: STRING
Provider name: id
Description: Resource Id

kubernetes_version

Type: STRING
Provider name: properties.kubernetesVersion
Description: Version of Kubernetes specified when creating the managed cluster.

location

Type: STRING
Provider name: location
Description: Resource location

max_agent_pools

Type: INT64
Provider name: properties.maxAgentPools
Description: The max number of agent pools for the managed cluster.

name

Type: STRING
Provider name: name
Description: Resource name

network_profile

Type: STRUCT
Provider name: properties.networkProfile
Description: Profile of network configuration.

  • dns_service_ip
    Type: STRING
    Provider name: dnsServiceIP
    Description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
  • docker_bridge_cidr
    Type: STRING
    Provider name: dockerBridgeCidr
    Description: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
  • load_balancer_sku
    Type: STRING
    Provider name: loadBalancerSku
    Description: The load balancer sku for the managed cluster.
  • network_mode
    Type: STRING
    Provider name: networkMode
    Description: Network mode used for building Kubernetes network.
  • network_plugin
    Type: STRING
    Provider name: networkPlugin
    Description: Network plugin used for building Kubernetes network.
  • network_policy
    Type: STRING
    Provider name: networkPolicy
    Description: Network policy used for building Kubernetes network.
  • outbound_type
    Type: STRING
    Provider name: outboundType
    Description: The outbound (egress) routing method.
  • pod_cidr
    Type: STRING
    Provider name: podCidr
    Description: A CIDR notation IP range from which to assign pod IPs when kubenet is used.
  • service_cidr
    Type: STRING
    Provider name: serviceCidr
    Description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

node_resource_group

Type: STRING
Provider name: properties.nodeResourceGroup
Description: Name of the resource group containing agent pool nodes.

power_state

Type: STRUCT
Provider name: properties.powerState
Description: Represents the Power State of the cluster

  • code
    Type: STRING
    Provider name: code
    Description: Tells whether the cluster is Running or Stopped

private_fqdn

Type: STRING
Provider name: properties.privateFQDN
Description: FQDN of private cluster.

provisioning_state

Type: STRING
Provider name: properties.provisioningState
Description: The current deployment or provisioning state, which only appears in the response.

resource_group

Type: STRING

service_principal_profile

Type: STRUCT
Provider name: properties.servicePrincipalProfile
Description: Information about a service principal identity for the cluster to use for manipulating Azure APIs.

  • client_id
    Type: STRING
    Provider name: clientId
    Description: The ID for the service principal.

sku

Type: STRUCT
Provider name: sku
Description: The managed cluster SKU.

  • name
    Type: STRING
    Provider name: name
    Description: Name of a managed cluster SKU.
  • tier
    Type: STRING
    Provider name: tier
    Description: Tier of a managed cluster SKU.

subscription_id

Type: STRING

subscription_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: Resource type

windows_profile

Type: STRUCT
Provider name: properties.windowsProfile
Description: Profile for Windows VMs in the container service cluster.

  • admin_username
    Type: STRING
    Provider name: adminUsername
    Description: Specifies the name of the administrator account.

    restriction: Cannot end in “.”

    Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”.

    Minimum-length: 1 character

    Max-length: 20 characters
  • enable_csi_proxy
    Type: BOOLEAN
    Provider name: enableCSIProxy
    Description: Whether to enable CSI proxy.
  • license_type
    Type: STRING
    Provider name: licenseType
    Description: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs.