Microsoft.HybridContainerService provisionedClusters

Bicep resource definition

The provisionedClusters resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridContainerService/provisionedClusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridContainerService/provisionedClusters@2022-09-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    aadProfile: {
      adminGroupObjectIDs: [
        'string'
      ]
      clientAppID: 'string'
      enableAzureRbac: bool
      managed: bool
      serverAppID: 'string'
      serverAppSecret: 'string'
      tenantID: 'string'
    }
    addonProfiles: {
      {customized property}: {
        config: {
          {customized property}: 'string'
        }
        enabled: bool
      }
    }
    agentPoolProfiles: [
      {
        availabilityZones: [
          'string'
        ]
        cloudProviderProfile: {
          infraNetworkProfile: {
            vnetSubnetIds: [
              'string'
            ]
          }
          infraStorageProfile: {
            storageSpaceIds: [
              'string'
            ]
          }
        }
        count: int
        maxCount: int
        maxPods: int
        minCount: int
        mode: 'string'
        name: 'string'
        nodeImageVersion: 'string'
        nodeLabels: {
          {customized property}: 'string'
        }
        nodeTaints: [
          'string'
        ]
        osType: 'string'
        vmSize: 'string'
      }
    ]
    cloudProviderProfile: {
      infraNetworkProfile: {
        vnetSubnetIds: [
          'string'
        ]
      }
      infraStorageProfile: {
        storageSpaceIds: [
          'string'
        ]
      }
    }
    controlPlane: {
      availabilityZones: [
        'string'
      ]
      cloudProviderProfile: {
        infraNetworkProfile: {
          vnetSubnetIds: [
            'string'
          ]
        }
        infraStorageProfile: {
          storageSpaceIds: [
            'string'
          ]
        }
      }
      controlPlaneEndpoint: {
        hostIP: 'string'
        port: 'string'
      }
      count: int
      linuxProfile: {
        adminUsername: 'string'
        ssh: {
          publicKeys: [
            {
              keyData: 'string'
            }
          ]
        }
      }
      maxCount: int
      maxPods: int
      minCount: int
      mode: 'string'
      name: 'string'
      nodeImageVersion: 'string'
      nodeLabels: {
        {customized property}: 'string'
      }
      nodeTaints: [
        'string'
      ]
      osType: 'string'
      vmSize: 'string'
    }
    enableRbac: bool
    features: {
      arcAgentProfile: {
        agentAutoUpgrade: 'string'
        agentVersion: 'string'
      }
    }
    httpProxyConfig: {
      httpProxy: 'string'
      httpsProxy: 'string'
      noProxy: [
        'string'
      ]
      password: 'string'
      trustedCa: 'string'
      username: 'string'
    }
    kubernetesVersion: 'string'
    linuxProfile: {
      adminUsername: 'string'
      ssh: {
        publicKeys: [
          {
            keyData: 'string'
          }
        ]
      }
    }
    networkProfile: {
      dnsServiceIP: 'string'
      loadBalancerProfile: {
        availabilityZones: [
          'string'
        ]
        cloudProviderProfile: {
          infraNetworkProfile: {
            vnetSubnetIds: [
              'string'
            ]
          }
          infraStorageProfile: {
            storageSpaceIds: [
              'string'
            ]
          }
        }
        count: int
        linuxProfile: {
          adminUsername: 'string'
          ssh: {
            publicKeys: [
              {
                keyData: 'string'
              }
            ]
          }
        }
        maxCount: int
        maxPods: int
        minCount: int
        mode: 'string'
        name: 'string'
        nodeImageVersion: 'string'
        nodeLabels: {
          {customized property}: 'string'
        }
        nodeTaints: [
          'string'
        ]
        osType: 'string'
        vmSize: 'string'
      }
      loadBalancerSku: 'string'
      networkPolicy: 'string'
      podCidr: 'string'
      podCidrs: [
        'string'
      ]
      serviceCidr: 'string'
      serviceCidrs: [
        'string'
      ]
    }
    nodeResourceGroup: 'string'
    windowsProfile: {
      adminPassword: 'string'
      adminUsername: 'string'
      enableCsiProxy: bool
      licenseType: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HybridContainerService/provisionedClusters

Name	Description	Value
extendedLocation		ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation
identity	Identity for the Provisioned cluster.	ProvisionedClusterIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	All properties of the provisioned cluster	ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AADProfileOrAADProfileResponse

Name	Description	Value
adminGroupObjectIDs	The list of AAD group object IDs that will have admin role of the cluster.	string[]
clientAppID	The client AAD application ID.	string
enableAzureRbac	Whether to enable Azure RBAC for Kubernetes authorization.	bool
managed	Whether to enable managed AAD.	bool
serverAppID	The server AAD application ID.	string
serverAppSecret	The server AAD application secret.	string Constraints: Sensitive value. Pass in as a secure parameter.
tenantID	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.	string

AddonProfiles

Name	Description	Value
config	Config - Key-value pairs for configuring an add-on.	AddonProfilesConfig
enabled	Enabled - Whether the add-on is enabled or not.	bool

AddonProfilesConfig

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

ArcAgentProfile

Name	Description	Value
agentAutoUpgrade	Indicates whether the Arc agents on the provisioned clusters be upgraded automatically to the latest version. Defaults to Enabled.	'Disabled' 'Enabled'
agentVersion	Version of the Arc agents to be installed on the provisioned Provisioned cluster resource	string

CloudProviderProfile

Name	Description	Value
infraNetworkProfile	InfraNetworkProfile - List of infra network profiles for the provisioned cluster	CloudProviderProfileInfraNetworkProfile
infraStorageProfile	InfraStorageProfile - List of infra storage profiles for the provisioned cluster	CloudProviderProfileInfraStorageProfile

CloudProviderProfileInfraNetworkProfile

Name	Description	Value
vnetSubnetIds	Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}	string[]

CloudProviderProfileInfraStorageProfile

Name	Description	Value
storageSpaceIds	Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}	string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Name	Description	Value
hostIP	Host IP address for API server	string
port	Port for the API server	string

ControlPlaneProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlaneEndpoint	API server endpoint for the control plane	ControlPlaneEndpointProfileControlPlaneEndpoint
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

HttpProxyConfigOrHttpProxyConfigResponse

Name	Description	Value
httpProxy	The HTTP proxy server endpoint to use.	string
httpsProxy	The HTTPS proxy server endpoint to use.	string
noProxy	The endpoints that should not go through proxy.	string[]
password	Password to use for connecting to proxy server	string Constraints: Sensitive value. Pass in as a secure parameter.
trustedCa	Alternative CA cert to use for connecting to proxy servers.	string
username	Username to use for connecting to proxy server	string

LinuxProfileProperties

Name	Description	Value
adminUsername	AdminUsername - The administrator username to use for Linux VMs.	string
ssh	SSH - SSH configuration for Linux-based VMs running on Azure.	LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Name	Description	Value
publicKeys	PublicKeys - The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.	LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Name	Description	Value
keyData	KeyData - Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.	string

LoadBalancerProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NamedAgentPoolProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NetworkProfile

Name	Description	Value
dnsServiceIP	DNSServiceIP - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.	string
loadBalancerProfile	LoadBalancerProfile - Profile of the cluster load balancer.	LoadBalancerProfile
loadBalancerSku	LoadBalancerSku - The load balancer sku for the provisioned cluster. Possible values: 'unstacked-haproxy', 'stacked-kube-vip', 'stacked-metallb', 'unmanaged'. The default is 'unmanaged'.	'stacked-kube-vip' 'stacked-metallb' 'unmanaged' 'unstacked-haproxy'
networkPolicy	NetworkPolicy - Network policy used for building Kubernetes network. Possible values include: 'calico', 'flannel'. Default is 'calico'	'calico' 'flannel'
podCidr	PodCidr - A CIDR notation IP range from which to assign pod IPs when kubenet is used.	string
podCidrs	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.	string[]
serviceCidr	ServiceCidr - A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.	string
serviceCidrs	The CIDR notation IP ranges from which to assign service cluster IPs. 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.	string[]

ProvisionedClusterIdentity

Name	Description	Value
type	The type of identity used for the provisioned cluster. The type SystemAssigned, includes a system created identity. The type None means no identity is assigned to the provisioned cluster.	'None' 'SystemAssigned' (required)

ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties

Name	Description	Value
aadProfile	AAD profile for the provisioned cluster.	AADProfileOrAADProfileResponse
addonProfiles	AddonProfiles - Profile of managed cluster add-on.	ProvisionedClustersCommonPropertiesAddonProfiles
agentPoolProfiles	The agent pools of the cluster.	NamedAgentPoolProfile[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlane	ControlPlane - ControlPlane Configuration	ControlPlaneProfile
enableRbac	EnableRBAC - Whether to enable Kubernetes Role-Based Access Control.	bool
features	Additional features specs like Arc Agent Onboarding.	ProvisionedClustersCommonPropertiesFeatures
httpProxyConfig	HttpProxyConfig - Configurations for provisioning the cluster with HTTP proxy servers.	HttpProxyConfigOrHttpProxyConfigResponse
kubernetesVersion	KubernetesVersion - Version of Kubernetes specified when creating the managed cluster.	string
linuxProfile	LinuxProfile - The profile for Linux VMs in the Provisioned Cluster.	LinuxProfileProperties
networkProfile	NetworkProfile - Profile of network configuration.	NetworkProfile
nodeResourceGroup	NodeResourceGroup - Name of the resource group containing agent pool nodes.	string
windowsProfile	WindowsProfile - Profile for Windows VMs in the Provisioned Cluster.	WindowsProfileOrWindowsProfileResponse

ProvisionedClustersCommonPropertiesAddonProfiles

Name	Description	Value

ProvisionedClustersCommonPropertiesFeatures

Name	Description	Value
arcAgentProfile	Arc agentry configuration for the provisioned cluster.	ArcAgentProfile

ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

TrackedResourceTags

Name	Description	Value

WindowsProfileOrWindowsProfileResponse

Name	Description	Value
adminPassword	AdminPassword - Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	AdminUsername - 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	string
enableCsiProxy	EnableCSIProxy - Whether to enable CSI proxy.	bool
licenseType	LicenseType - The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. Possible values include: 'None', 'Windows_Server'	'None' 'Windows_Server'

ARM template resource definition

The provisionedClusters resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridContainerService/provisionedClusters resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridContainerService/provisionedClusters",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "aadProfile": {
      "adminGroupObjectIDs": [ "string" ],
      "clientAppID": "string",
      "enableAzureRbac": "bool",
      "managed": "bool",
      "serverAppID": "string",
      "serverAppSecret": "string",
      "tenantID": "string"
    },
    "addonProfiles": {
      "{customized property}": {
        "config": {
          "{customized property}": "string"
        },
        "enabled": "bool"
      }
    },
    "agentPoolProfiles": [
      {
        "availabilityZones": [ "string" ],
        "cloudProviderProfile": {
          "infraNetworkProfile": {
            "vnetSubnetIds": [ "string" ]
          },
          "infraStorageProfile": {
            "storageSpaceIds": [ "string" ]
          }
        },
        "count": "int",
        "maxCount": "int",
        "maxPods": "int",
        "minCount": "int",
        "mode": "string",
        "name": "string",
        "nodeImageVersion": "string",
        "nodeLabels": {
          "{customized property}": "string"
        },
        "nodeTaints": [ "string" ],
        "osType": "string",
        "vmSize": "string"
      }
    ],
    "cloudProviderProfile": {
      "infraNetworkProfile": {
        "vnetSubnetIds": [ "string" ]
      },
      "infraStorageProfile": {
        "storageSpaceIds": [ "string" ]
      }
    },
    "controlPlane": {
      "availabilityZones": [ "string" ],
      "cloudProviderProfile": {
        "infraNetworkProfile": {
          "vnetSubnetIds": [ "string" ]
        },
        "infraStorageProfile": {
          "storageSpaceIds": [ "string" ]
        }
      },
      "controlPlaneEndpoint": {
        "hostIP": "string",
        "port": "string"
      },
      "count": "int",
      "linuxProfile": {
        "adminUsername": "string",
        "ssh": {
          "publicKeys": [
            {
              "keyData": "string"
            }
          ]
        }
      },
      "maxCount": "int",
      "maxPods": "int",
      "minCount": "int",
      "mode": "string",
      "name": "string",
      "nodeImageVersion": "string",
      "nodeLabels": {
        "{customized property}": "string"
      },
      "nodeTaints": [ "string" ],
      "osType": "string",
      "vmSize": "string"
    },
    "enableRbac": "bool",
    "features": {
      "arcAgentProfile": {
        "agentAutoUpgrade": "string",
        "agentVersion": "string"
      }
    },
    "httpProxyConfig": {
      "httpProxy": "string",
      "httpsProxy": "string",
      "noProxy": [ "string" ],
      "password": "string",
      "trustedCa": "string",
      "username": "string"
    },
    "kubernetesVersion": "string",
    "linuxProfile": {
      "adminUsername": "string",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "string"
          }
        ]
      }
    },
    "networkProfile": {
      "dnsServiceIP": "string",
      "loadBalancerProfile": {
        "availabilityZones": [ "string" ],
        "cloudProviderProfile": {
          "infraNetworkProfile": {
            "vnetSubnetIds": [ "string" ]
          },
          "infraStorageProfile": {
            "storageSpaceIds": [ "string" ]
          }
        },
        "count": "int",
        "linuxProfile": {
          "adminUsername": "string",
          "ssh": {
            "publicKeys": [
              {
                "keyData": "string"
              }
            ]
          }
        },
        "maxCount": "int",
        "maxPods": "int",
        "minCount": "int",
        "mode": "string",
        "name": "string",
        "nodeImageVersion": "string",
        "nodeLabels": {
          "{customized property}": "string"
        },
        "nodeTaints": [ "string" ],
        "osType": "string",
        "vmSize": "string"
      },
      "loadBalancerSku": "string",
      "networkPolicy": "string",
      "podCidr": "string",
      "podCidrs": [ "string" ],
      "serviceCidr": "string",
      "serviceCidrs": [ "string" ]
    },
    "nodeResourceGroup": "string",
    "windowsProfile": {
      "adminPassword": "string",
      "adminUsername": "string",
      "enableCsiProxy": "bool",
      "licenseType": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HybridContainerService/provisionedClusters

Name	Description	Value
apiVersion	The api version	'2022-09-01-preview'
extendedLocation		ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation
identity	Identity for the Provisioned cluster.	ProvisionedClusterIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	All properties of the provisioned cluster	ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.HybridContainerService/provisionedClusters'

AADProfileOrAADProfileResponse

Name	Description	Value
adminGroupObjectIDs	The list of AAD group object IDs that will have admin role of the cluster.	string[]
clientAppID	The client AAD application ID.	string
enableAzureRbac	Whether to enable Azure RBAC for Kubernetes authorization.	bool
managed	Whether to enable managed AAD.	bool
serverAppID	The server AAD application ID.	string
serverAppSecret	The server AAD application secret.	string Constraints: Sensitive value. Pass in as a secure parameter.
tenantID	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.	string

AddonProfiles

Name	Description	Value
config	Config - Key-value pairs for configuring an add-on.	AddonProfilesConfig
enabled	Enabled - Whether the add-on is enabled or not.	bool

AddonProfilesConfig

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

ArcAgentProfile

Name	Description	Value
agentAutoUpgrade	Indicates whether the Arc agents on the provisioned clusters be upgraded automatically to the latest version. Defaults to Enabled.	'Disabled' 'Enabled'
agentVersion	Version of the Arc agents to be installed on the provisioned Provisioned cluster resource	string

CloudProviderProfile

Name	Description	Value
infraNetworkProfile	InfraNetworkProfile - List of infra network profiles for the provisioned cluster	CloudProviderProfileInfraNetworkProfile
infraStorageProfile	InfraStorageProfile - List of infra storage profiles for the provisioned cluster	CloudProviderProfileInfraStorageProfile

CloudProviderProfileInfraNetworkProfile

Name	Description	Value
vnetSubnetIds	Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}	string[]

CloudProviderProfileInfraStorageProfile

Name	Description	Value
storageSpaceIds	Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}	string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Name	Description	Value
hostIP	Host IP address for API server	string
port	Port for the API server	string

ControlPlaneProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlaneEndpoint	API server endpoint for the control plane	ControlPlaneEndpointProfileControlPlaneEndpoint
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

HttpProxyConfigOrHttpProxyConfigResponse

Name	Description	Value
httpProxy	The HTTP proxy server endpoint to use.	string
httpsProxy	The HTTPS proxy server endpoint to use.	string
noProxy	The endpoints that should not go through proxy.	string[]
password	Password to use for connecting to proxy server	string Constraints: Sensitive value. Pass in as a secure parameter.
trustedCa	Alternative CA cert to use for connecting to proxy servers.	string
username	Username to use for connecting to proxy server	string

LinuxProfileProperties

Name	Description	Value
adminUsername	AdminUsername - The administrator username to use for Linux VMs.	string
ssh	SSH - SSH configuration for Linux-based VMs running on Azure.	LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Name	Description	Value
publicKeys	PublicKeys - The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.	LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Name	Description	Value
keyData	KeyData - Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.	string

LoadBalancerProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NamedAgentPoolProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NetworkProfile

Name	Description	Value
dnsServiceIP	DNSServiceIP - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.	string
loadBalancerProfile	LoadBalancerProfile - Profile of the cluster load balancer.	LoadBalancerProfile
loadBalancerSku	LoadBalancerSku - The load balancer sku for the provisioned cluster. Possible values: 'unstacked-haproxy', 'stacked-kube-vip', 'stacked-metallb', 'unmanaged'. The default is 'unmanaged'.	'stacked-kube-vip' 'stacked-metallb' 'unmanaged' 'unstacked-haproxy'
networkPolicy	NetworkPolicy - Network policy used for building Kubernetes network. Possible values include: 'calico', 'flannel'. Default is 'calico'	'calico' 'flannel'
podCidr	PodCidr - A CIDR notation IP range from which to assign pod IPs when kubenet is used.	string
podCidrs	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.	string[]
serviceCidr	ServiceCidr - A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.	string
serviceCidrs	The CIDR notation IP ranges from which to assign service cluster IPs. 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.	string[]

ProvisionedClusterIdentity

Name	Description	Value
type	The type of identity used for the provisioned cluster. The type SystemAssigned, includes a system created identity. The type None means no identity is assigned to the provisioned cluster.	'None' 'SystemAssigned' (required)

ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties

Name	Description	Value
aadProfile	AAD profile for the provisioned cluster.	AADProfileOrAADProfileResponse
addonProfiles	AddonProfiles - Profile of managed cluster add-on.	ProvisionedClustersCommonPropertiesAddonProfiles
agentPoolProfiles	The agent pools of the cluster.	NamedAgentPoolProfile[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlane	ControlPlane - ControlPlane Configuration	ControlPlaneProfile
enableRbac	EnableRBAC - Whether to enable Kubernetes Role-Based Access Control.	bool
features	Additional features specs like Arc Agent Onboarding.	ProvisionedClustersCommonPropertiesFeatures
httpProxyConfig	HttpProxyConfig - Configurations for provisioning the cluster with HTTP proxy servers.	HttpProxyConfigOrHttpProxyConfigResponse
kubernetesVersion	KubernetesVersion - Version of Kubernetes specified when creating the managed cluster.	string
linuxProfile	LinuxProfile - The profile for Linux VMs in the Provisioned Cluster.	LinuxProfileProperties
networkProfile	NetworkProfile - Profile of network configuration.	NetworkProfile
nodeResourceGroup	NodeResourceGroup - Name of the resource group containing agent pool nodes.	string
windowsProfile	WindowsProfile - Profile for Windows VMs in the Provisioned Cluster.	WindowsProfileOrWindowsProfileResponse

ProvisionedClustersCommonPropertiesAddonProfiles

Name	Description	Value

ProvisionedClustersCommonPropertiesFeatures

Name	Description	Value
arcAgentProfile	Arc agentry configuration for the provisioned cluster.	ArcAgentProfile

ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

TrackedResourceTags

Name	Description	Value

WindowsProfileOrWindowsProfileResponse

Name	Description	Value
adminPassword	AdminPassword - Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	AdminUsername - 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	string
enableCsiProxy	EnableCSIProxy - Whether to enable CSI proxy.	bool
licenseType	LicenseType - The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. Possible values include: 'None', 'Windows_Server'	'None' 'Windows_Server'

Usage Examples

Terraform (AzAPI provider) resource definition

The provisionedClusters resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridContainerService/provisionedClusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridContainerService/provisionedClusters@2022-09-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      aadProfile = {
        adminGroupObjectIDs = [
          "string"
        ]
        clientAppID = "string"
        enableAzureRbac = bool
        managed = bool
        serverAppID = "string"
        serverAppSecret = "string"
        tenantID = "string"
      }
      addonProfiles = {
        {customized property} = {
          config = {
            {customized property} = "string"
          }
          enabled = bool
        }
      }
      agentPoolProfiles = [
        {
          availabilityZones = [
            "string"
          ]
          cloudProviderProfile = {
            infraNetworkProfile = {
              vnetSubnetIds = [
                "string"
              ]
            }
            infraStorageProfile = {
              storageSpaceIds = [
                "string"
              ]
            }
          }
          count = int
          maxCount = int
          maxPods = int
          minCount = int
          mode = "string"
          name = "string"
          nodeImageVersion = "string"
          nodeLabels = {
            {customized property} = "string"
          }
          nodeTaints = [
            "string"
          ]
          osType = "string"
          vmSize = "string"
        }
      ]
      cloudProviderProfile = {
        infraNetworkProfile = {
          vnetSubnetIds = [
            "string"
          ]
        }
        infraStorageProfile = {
          storageSpaceIds = [
            "string"
          ]
        }
      }
      controlPlane = {
        availabilityZones = [
          "string"
        ]
        cloudProviderProfile = {
          infraNetworkProfile = {
            vnetSubnetIds = [
              "string"
            ]
          }
          infraStorageProfile = {
            storageSpaceIds = [
              "string"
            ]
          }
        }
        controlPlaneEndpoint = {
          hostIP = "string"
          port = "string"
        }
        count = int
        linuxProfile = {
          adminUsername = "string"
          ssh = {
            publicKeys = [
              {
                keyData = "string"
              }
            ]
          }
        }
        maxCount = int
        maxPods = int
        minCount = int
        mode = "string"
        name = "string"
        nodeImageVersion = "string"
        nodeLabels = {
          {customized property} = "string"
        }
        nodeTaints = [
          "string"
        ]
        osType = "string"
        vmSize = "string"
      }
      enableRbac = bool
      features = {
        arcAgentProfile = {
          agentAutoUpgrade = "string"
          agentVersion = "string"
        }
      }
      httpProxyConfig = {
        httpProxy = "string"
        httpsProxy = "string"
        noProxy = [
          "string"
        ]
        password = "string"
        trustedCa = "string"
        username = "string"
      }
      kubernetesVersion = "string"
      linuxProfile = {
        adminUsername = "string"
        ssh = {
          publicKeys = [
            {
              keyData = "string"
            }
          ]
        }
      }
      networkProfile = {
        dnsServiceIP = "string"
        loadBalancerProfile = {
          availabilityZones = [
            "string"
          ]
          cloudProviderProfile = {
            infraNetworkProfile = {
              vnetSubnetIds = [
                "string"
              ]
            }
            infraStorageProfile = {
              storageSpaceIds = [
                "string"
              ]
            }
          }
          count = int
          linuxProfile = {
            adminUsername = "string"
            ssh = {
              publicKeys = [
                {
                  keyData = "string"
                }
              ]
            }
          }
          maxCount = int
          maxPods = int
          minCount = int
          mode = "string"
          name = "string"
          nodeImageVersion = "string"
          nodeLabels = {
            {customized property} = "string"
          }
          nodeTaints = [
            "string"
          ]
          osType = "string"
          vmSize = "string"
        }
        loadBalancerSku = "string"
        networkPolicy = "string"
        podCidr = "string"
        podCidrs = [
          "string"
        ]
        serviceCidr = "string"
        serviceCidrs = [
          "string"
        ]
      }
      nodeResourceGroup = "string"
      windowsProfile = {
        adminPassword = "string"
        adminUsername = "string"
        enableCsiProxy = bool
        licenseType = "string"
      }
    }
  }
}

Property Values

Microsoft.HybridContainerService/provisionedClusters

Name	Description	Value
extendedLocation		ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation
identity	Identity for the Provisioned cluster.	ProvisionedClusterIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	All properties of the provisioned cluster	ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.HybridContainerService/provisionedClusters@2022-09-01-preview"

AADProfileOrAADProfileResponse

Name	Description	Value
adminGroupObjectIDs	The list of AAD group object IDs that will have admin role of the cluster.	string[]
clientAppID	The client AAD application ID.	string
enableAzureRbac	Whether to enable Azure RBAC for Kubernetes authorization.	bool
managed	Whether to enable managed AAD.	bool
serverAppID	The server AAD application ID.	string
serverAppSecret	The server AAD application secret.	string Constraints: Sensitive value. Pass in as a secure parameter.
tenantID	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.	string

AddonProfiles

Name	Description	Value
config	Config - Key-value pairs for configuring an add-on.	AddonProfilesConfig
enabled	Enabled - Whether the add-on is enabled or not.	bool

AddonProfilesConfig

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

AgentPoolProfileNodeLabels

Name	Description	Value

ArcAgentProfile

Name	Description	Value
agentAutoUpgrade	Indicates whether the Arc agents on the provisioned clusters be upgraded automatically to the latest version. Defaults to Enabled.	'Disabled' 'Enabled'
agentVersion	Version of the Arc agents to be installed on the provisioned Provisioned cluster resource	string

CloudProviderProfile

Name	Description	Value
infraNetworkProfile	InfraNetworkProfile - List of infra network profiles for the provisioned cluster	CloudProviderProfileInfraNetworkProfile
infraStorageProfile	InfraStorageProfile - List of infra storage profiles for the provisioned cluster	CloudProviderProfileInfraStorageProfile

CloudProviderProfileInfraNetworkProfile

Name	Description	Value
vnetSubnetIds	Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}	string[]

CloudProviderProfileInfraStorageProfile

Name	Description	Value
storageSpaceIds	Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}	string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Name	Description	Value
hostIP	Host IP address for API server	string
port	Port for the API server	string

ControlPlaneProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlaneEndpoint	API server endpoint for the control plane	ControlPlaneEndpointProfileControlPlaneEndpoint
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

HttpProxyConfigOrHttpProxyConfigResponse

Name	Description	Value
httpProxy	The HTTP proxy server endpoint to use.	string
httpsProxy	The HTTPS proxy server endpoint to use.	string
noProxy	The endpoints that should not go through proxy.	string[]
password	Password to use for connecting to proxy server	string Constraints: Sensitive value. Pass in as a secure parameter.
trustedCa	Alternative CA cert to use for connecting to proxy servers.	string
username	Username to use for connecting to proxy server	string

LinuxProfileProperties

Name	Description	Value
adminUsername	AdminUsername - The administrator username to use for Linux VMs.	string
ssh	SSH - SSH configuration for Linux-based VMs running on Azure.	LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Name	Description	Value
publicKeys	PublicKeys - The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.	LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Name	Description	Value
keyData	KeyData - Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.	string

LoadBalancerProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
linuxProfile	Profile for Linux VMs in the container service cluster.	LinuxProfileProperties
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NamedAgentPoolProfile

Name	Description	Value
availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones	string[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.	int
maxCount	The maximum number of nodes for auto-scaling	int
maxPods	The maximum number of pods that can run on a node.	int
minCount	The minimum number of nodes for auto-scaling	int
mode	Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'	'LB' 'System' 'User'
name	Unique name of the agent pool profile in the context of the subscription and resource group.	string
nodeImageVersion	The version of node image	string
nodeLabels	NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.	AgentPoolProfileNodeLabels
nodeTaints	NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.	string[]
osType	OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'	'Linux' 'Windows'
vmSize	VmSize - The size of the agent pool VMs.	string

NetworkProfile

Name	Description	Value
dnsServiceIP	DNSServiceIP - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.	string
loadBalancerProfile	LoadBalancerProfile - Profile of the cluster load balancer.	LoadBalancerProfile
loadBalancerSku	LoadBalancerSku - The load balancer sku for the provisioned cluster. Possible values: 'unstacked-haproxy', 'stacked-kube-vip', 'stacked-metallb', 'unmanaged'. The default is 'unmanaged'.	'stacked-kube-vip' 'stacked-metallb' 'unmanaged' 'unstacked-haproxy'
networkPolicy	NetworkPolicy - Network policy used for building Kubernetes network. Possible values include: 'calico', 'flannel'. Default is 'calico'	'calico' 'flannel'
podCidr	PodCidr - A CIDR notation IP range from which to assign pod IPs when kubenet is used.	string
podCidrs	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.	string[]
serviceCidr	ServiceCidr - A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.	string
serviceCidrs	The CIDR notation IP ranges from which to assign service cluster IPs. 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.	string[]

ProvisionedClusterIdentity

Name	Description	Value
type	The type of identity used for the provisioned cluster. The type SystemAssigned, includes a system created identity. The type None means no identity is assigned to the provisioned cluster.	'None' 'SystemAssigned' (required)

ProvisionedClustersAllPropertiesOrProvisionedClustersResponseProperties

Name	Description	Value
aadProfile	AAD profile for the provisioned cluster.	AADProfileOrAADProfileResponse
addonProfiles	AddonProfiles - Profile of managed cluster add-on.	ProvisionedClustersCommonPropertiesAddonProfiles
agentPoolProfiles	The agent pools of the cluster.	NamedAgentPoolProfile[]
cloudProviderProfile	The underlying cloud infra provider properties.	CloudProviderProfile
controlPlane	ControlPlane - ControlPlane Configuration	ControlPlaneProfile
enableRbac	EnableRBAC - Whether to enable Kubernetes Role-Based Access Control.	bool
features	Additional features specs like Arc Agent Onboarding.	ProvisionedClustersCommonPropertiesFeatures
httpProxyConfig	HttpProxyConfig - Configurations for provisioning the cluster with HTTP proxy servers.	HttpProxyConfigOrHttpProxyConfigResponse
kubernetesVersion	KubernetesVersion - Version of Kubernetes specified when creating the managed cluster.	string
linuxProfile	LinuxProfile - The profile for Linux VMs in the Provisioned Cluster.	LinuxProfileProperties
networkProfile	NetworkProfile - Profile of network configuration.	NetworkProfile
nodeResourceGroup	NodeResourceGroup - Name of the resource group containing agent pool nodes.	string
windowsProfile	WindowsProfile - Profile for Windows VMs in the Provisioned Cluster.	WindowsProfileOrWindowsProfileResponse

ProvisionedClustersCommonPropertiesAddonProfiles

Name	Description	Value

ProvisionedClustersCommonPropertiesFeatures

Name	Description	Value
arcAgentProfile	Arc agentry configuration for the provisioned cluster.	ArcAgentProfile

ProvisionedClustersExtendedLocationOrProvisionedClustersResponseExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

TrackedResourceTags

Name	Description	Value

WindowsProfileOrWindowsProfileResponse

Name	Description	Value
adminPassword	AdminPassword - Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	AdminUsername - 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	string
enableCsiProxy	EnableCSIProxy - Whether to enable CSI proxy.	bool
licenseType	LicenseType - The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. Possible values include: 'None', 'Windows_Server'	'None' 'Windows_Server'

Feedback

Was this page helpful?

Last updated on 2024-12-09