Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The connectedClusters 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.Kubernetes/connectedClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Kubernetes/connectedClusters@2022-10-01-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
agentPublicKeyCertificate: '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) |
| 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 |
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 |
|---|---|---|
| agentPublicKeyCertificate | Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. | string (required) |
| 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:
- 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.Kubernetes/connectedClusters resource, add the following JSON to your template.
{
"type": "Microsoft.Kubernetes/connectedClusters",
"apiVersion": "2022-10-01-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"agentPublicKeyCertificate": "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 | '2022-10-01-preview' |
| identity | The identity of the connected cluster. | ConnectedClusterIdentity (required) |
| 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' |
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 |
|---|---|---|
| agentPublicKeyCertificate | Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. | string (required) |
| 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 |
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@2022-10-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
agentPublicKeyCertificate = "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) |
| 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@2022-10-01-preview" |
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 |
|---|---|---|
| agentPublicKeyCertificate | Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. | string (required) |
| 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 |
|---|