Share via

Microsoft.Kubernetes connectedClusters 2024-01-01

Bicep resource definition

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

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

Resource format

To create a Microsoft.Kubernetes/connectedClusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kubernetes/connectedClusters@2024-01-01' = {
  identity: {
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    aadProfile: {
      adminGroupObjectIDs: [
        'string'
      ]
      enableAzureRBAC: bool
      tenantID: 'string'
    }
    agentPublicKeyCertificate: 'string'
    arcAgentProfile: {
      agentAutoUpgrade: 'string'
      desiredAgentVersion: 'string'
    }
    azureHybridBenefit: 'string'
    distribution: 'string'
    distributionVersion: 'string'
    infrastructure: 'string'
    privateLinkScopeResourceId: 'string'
    privateLinkState: 'string'
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Kubernetes/connectedClusters

Name Description Value
identity The identity of the connected cluster. ConnectedClusterIdentity (required)
kind The kind of connected cluster. 'ProvisionedCluster'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Describes the connected cluster resource properties. ConnectedClusterProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

AadProfile

Name Description Value
adminGroupObjectIDs The list of AAD group object IDs that will have admin role of the cluster. string[]
enableAzureRBAC Whether to enable Azure RBAC for Kubernetes authorization. bool
tenantID The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. string

ArcAgentProfile

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

ConnectedClusterIdentity

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

ConnectedClusterProperties

Name Description Value
aadProfile AAD profile for the connected cluster. AadProfile
agentPublicKeyCertificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. string (required)
arcAgentProfile Arc agentry configuration for the provisioned cluster. ArcAgentProfile
azureHybridBenefit Indicates whether Azure Hybrid Benefit is opted in 'False'
'NotApplicable'
'True'
distribution The Kubernetes distribution running on this connected cluster. string
distributionVersion The Kubernetes distribution version on this connected cluster. string
infrastructure The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. string
privateLinkScopeResourceId The resource id of the private link scope this connected cluster is assigned to, if any. string
privateLinkState Property which describes the state of private link on a connected cluster resource. 'Disabled'
'Enabled'
provisioningState Provisioning state of the connected cluster resource. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Kubernetes Connected Cluster AVM Resource Module for Kubernetes Connected Cluster

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create a Kubernetes cluster on Azure Stack HCI This template creates a Kubernetes cluster on Azure Stack HCI version 23H2+

ARM template resource definition

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

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

Resource format

To create a Microsoft.Kubernetes/connectedClusters resource, add the following JSON to your template.

{
  "type": "Microsoft.Kubernetes/connectedClusters",
  "apiVersion": "2024-01-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "aadProfile": {
      "adminGroupObjectIDs": [ "string" ],
      "enableAzureRBAC": "bool",
      "tenantID": "string"
    },
    "agentPublicKeyCertificate": "string",
    "arcAgentProfile": {
      "agentAutoUpgrade": "string",
      "desiredAgentVersion": "string"
    },
    "azureHybridBenefit": "string",
    "distribution": "string",
    "distributionVersion": "string",
    "infrastructure": "string",
    "privateLinkScopeResourceId": "string",
    "privateLinkState": "string",
    "provisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Kubernetes/connectedClusters

Name Description Value
apiVersion The api version '2024-01-01'
identity The identity of the connected cluster. ConnectedClusterIdentity (required)
kind The kind of connected cluster. 'ProvisionedCluster'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Describes the connected cluster resource properties. ConnectedClusterProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Kubernetes/connectedClusters'

AadProfile

Name Description Value
adminGroupObjectIDs The list of AAD group object IDs that will have admin role of the cluster. string[]
enableAzureRBAC Whether to enable Azure RBAC for Kubernetes authorization. bool
tenantID The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. string

ArcAgentProfile

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

ConnectedClusterIdentity

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

ConnectedClusterProperties

Name Description Value
aadProfile AAD profile for the connected cluster. AadProfile
agentPublicKeyCertificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. string (required)
arcAgentProfile Arc agentry configuration for the provisioned cluster. ArcAgentProfile
azureHybridBenefit Indicates whether Azure Hybrid Benefit is opted in 'False'
'NotApplicable'
'True'
distribution The Kubernetes distribution running on this connected cluster. string
distributionVersion The Kubernetes distribution version on this connected cluster. string
infrastructure The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. string
privateLinkScopeResourceId The resource id of the private link scope this connected cluster is assigned to, if any. string
privateLinkState Property which describes the state of private link on a connected cluster resource. 'Disabled'
'Enabled'
provisioningState Provisioning state of the connected cluster resource. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create a Kubernetes cluster on Azure Stack HCI

Deploy to Azure		 This template creates a Kubernetes cluster on Azure Stack HCI version 23H2+

Terraform (AzAPI provider) resource definition

The connectedClusters 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.Kubernetes/connectedClusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kubernetes/connectedClusters@2024-01-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      aadProfile = {
        adminGroupObjectIDs = [
          "string"
        ]
        enableAzureRBAC = bool
        tenantID = "string"
      }
      agentPublicKeyCertificate = "string"
      arcAgentProfile = {
        agentAutoUpgrade = "string"
        desiredAgentVersion = "string"
      }
      azureHybridBenefit = "string"
      distribution = "string"
      distributionVersion = "string"
      infrastructure = "string"
      privateLinkScopeResourceId = "string"
      privateLinkState = "string"
      provisioningState = "string"
    }
  }
}

Property Values

Microsoft.Kubernetes/connectedClusters

Name Description Value
identity The identity of the connected cluster. ConnectedClusterIdentity (required)
kind The kind of connected cluster. 'ProvisionedCluster'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Describes the connected cluster resource properties. ConnectedClusterProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Kubernetes/connectedClusters@2024-01-01"

AadProfile

Name Description Value
adminGroupObjectIDs The list of AAD group object IDs that will have admin role of the cluster. string[]
enableAzureRBAC Whether to enable Azure RBAC for Kubernetes authorization. bool
tenantID The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. string

ArcAgentProfile

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

ConnectedClusterIdentity

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

ConnectedClusterProperties

Name Description Value
aadProfile AAD profile for the connected cluster. AadProfile
agentPublicKeyCertificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. string (required)
arcAgentProfile Arc agentry configuration for the provisioned cluster. ArcAgentProfile
azureHybridBenefit Indicates whether Azure Hybrid Benefit is opted in 'False'
'NotApplicable'
'True'
distribution The Kubernetes distribution running on this connected cluster. string
distributionVersion The Kubernetes distribution version on this connected cluster. string
infrastructure The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. string
privateLinkScopeResourceId The resource id of the private link scope this connected cluster is assigned to, if any. string
privateLinkState Property which describes the state of private link on a connected cluster resource. 'Disabled'
'Enabled'
provisioningState Provisioning state of the connected cluster resource. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'

TrackedResourceTags

Name Description Value