connected_cluster

Creates, updates, deletes, gets or lists a connected_cluster resource.

Overview

Name	connected_cluster
Type	Resource
Id	azure.hybrid_kubernetes.connected_cluster

Fields

The following fields are returned by SELECT queries:

list_cluster_user_credential

Name	Datatype	Description
hybridConnectionConfig	object	Contains the REP (rendezvous endpoint) and “Sender” access token.
kubeconfigs	array	Base64-encoded Kubernetes configuration file.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
aadProfile	object	AAD profile for the connected cluster.
agentPublicKeyCertificate	string	Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Required.
agentVersion	string	Version of the agent running on the connected cluster resource.
arcAgentProfile	object	Arc agentry configuration for the provisioned cluster.
arcAgentryConfigurations	array	Configuration settings for customizing the behavior of the connected cluster.
azureHybridBenefit	string	Indicates whether Azure Hybrid Benefit is opted in. Known values are: "True", "False", and "NotApplicable". (True, False, NotApplicable)
connectivityStatus	string	Represents the connectivity status of the connected cluster. Known values are: "Connecting", "Connected", "Offline", "Expired", and "AgentNotInstalled". (Connecting, Connected, Offline, Expired, AgentNotInstalled)
distribution	string	The Kubernetes distribution running on this connected cluster.
distributionVersion	string	The Kubernetes distribution version on this connected cluster.
gateway	object	Details of the gateway used by the Arc router for connectivity.
identity	object	The identity of the connected cluster. Required.
infrastructure	string	The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
kind	string	The kind of connected cluster. "ProvisionedCluster" (ProvisionedCluster)
kubernetesVersion	string	The Kubernetes version of the connected cluster resource.
lastConnectivityTime	string (date-time)	Time representing the last instance when heart beat was received from the cluster.
location	string	The geo-location where the resource lives. Required.
managedIdentityCertificateExpirationTime	string (date-time)	Expiration time of the managed identity certificate.
miscellaneousProperties	object	More properties related to the Connected Cluster.
offering	string	Connected cluster offering.
oidcIssuerProfile	object	Open ID Connect (OIDC) Issuer Profile for the connected cluster.
privateLinkScopeResourceId	string	This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState	string	Property which describes the state of private link on a connected cluster resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
provisioningState	string	Provisioning state of the connected cluster resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
securityProfile	object	Security profile for the connected cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalCoreCount	integer	Number of CPU cores present in the connected cluster resource.
totalNodeCount	integer	Number of nodes present in the connected cluster resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
aadProfile	object	AAD profile for the connected cluster.
agentPublicKeyCertificate	string	Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Required.
agentVersion	string	Version of the agent running on the connected cluster resource.
arcAgentProfile	object	Arc agentry configuration for the provisioned cluster.
arcAgentryConfigurations	array	Configuration settings for customizing the behavior of the connected cluster.
azureHybridBenefit	string	Indicates whether Azure Hybrid Benefit is opted in. Known values are: "True", "False", and "NotApplicable". (True, False, NotApplicable)
connectivityStatus	string	Represents the connectivity status of the connected cluster. Known values are: "Connecting", "Connected", "Offline", "Expired", and "AgentNotInstalled". (Connecting, Connected, Offline, Expired, AgentNotInstalled)
distribution	string	The Kubernetes distribution running on this connected cluster.
distributionVersion	string	The Kubernetes distribution version on this connected cluster.
gateway	object	Details of the gateway used by the Arc router for connectivity.
identity	object	The identity of the connected cluster. Required.
infrastructure	string	The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
kind	string	The kind of connected cluster. "ProvisionedCluster" (ProvisionedCluster)
kubernetesVersion	string	The Kubernetes version of the connected cluster resource.
lastConnectivityTime	string (date-time)	Time representing the last instance when heart beat was received from the cluster.
location	string	The geo-location where the resource lives. Required.
managedIdentityCertificateExpirationTime	string (date-time)	Expiration time of the managed identity certificate.
miscellaneousProperties	object	More properties related to the Connected Cluster.
offering	string	Connected cluster offering.
oidcIssuerProfile	object	Open ID Connect (OIDC) Issuer Profile for the connected cluster.
privateLinkScopeResourceId	string	This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState	string	Property which describes the state of private link on a connected cluster resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
provisioningState	string	Provisioning state of the connected cluster resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
securityProfile	object	Security profile for the connected cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalCoreCount	integer	Number of CPU cores present in the connected cluster resource.
totalNodeCount	integer	Number of nodes present in the connected cluster resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
aadProfile	object	AAD profile for the connected cluster.
agentPublicKeyCertificate	string	Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Required.
agentVersion	string	Version of the agent running on the connected cluster resource.
arcAgentProfile	object	Arc agentry configuration for the provisioned cluster.
arcAgentryConfigurations	array	Configuration settings for customizing the behavior of the connected cluster.
azureHybridBenefit	string	Indicates whether Azure Hybrid Benefit is opted in. Known values are: "True", "False", and "NotApplicable". (True, False, NotApplicable)
connectivityStatus	string	Represents the connectivity status of the connected cluster. Known values are: "Connecting", "Connected", "Offline", "Expired", and "AgentNotInstalled". (Connecting, Connected, Offline, Expired, AgentNotInstalled)
distribution	string	The Kubernetes distribution running on this connected cluster.
distributionVersion	string	The Kubernetes distribution version on this connected cluster.
gateway	object	Details of the gateway used by the Arc router for connectivity.
identity	object	The identity of the connected cluster. Required.
infrastructure	string	The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
kind	string	The kind of connected cluster. "ProvisionedCluster" (ProvisionedCluster)
kubernetesVersion	string	The Kubernetes version of the connected cluster resource.
lastConnectivityTime	string (date-time)	Time representing the last instance when heart beat was received from the cluster.
location	string	The geo-location where the resource lives. Required.
managedIdentityCertificateExpirationTime	string (date-time)	Expiration time of the managed identity certificate.
miscellaneousProperties	object	More properties related to the Connected Cluster.
offering	string	Connected cluster offering.
oidcIssuerProfile	object	Open ID Connect (OIDC) Issuer Profile for the connected cluster.
privateLinkScopeResourceId	string	This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState	string	Property which describes the state of private link on a connected cluster resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
provisioningState	string	Provisioning state of the connected cluster resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
securityProfile	object	Security profile for the connected cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalCoreCount	integer	Number of CPU cores present in the connected cluster resource.
totalNodeCount	integer	Number of nodes present in the connected cluster resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_cluster_user_credential	select	resource_group_name, cluster_name, subscription_id		Gets cluster user credentials of a connected cluster. Gets cluster user credentials of the connected cluster with a specified resource group and name.
get	select	resource_group_name, cluster_name, subscription_id		Get the properties of the specified connected cluster. Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all connected clusters in the given Resource Group. API to enumerate registered connected K8s clusters under a Resource Group.
list_by_subscription	select	subscription_id		Lists all connected clusters in the given Subscription. API to enumerate registered connected K8s clusters under a Subscription.
create_or_replace	insert	resource_group_name, cluster_name, subscription_id, location, properties, identity		Register a new Kubernetes cluster with Azure Resource Manager. API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).
create_or_replace	replace	resource_group_name, cluster_name, subscription_id, location, properties, identity		Register a new Kubernetes cluster with Azure Resource Manager. API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).
delete	delete	resource_group_name, cluster_name, subscription_id		Delete a connected cluster. Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
update_async	exec	resource_group_name, cluster_name, subscription_id		Updates a connected cluster. API to update certain properties of the connected cluster resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the Kubernetes cluster on which get is called. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_cluster_user_credential

Gets cluster user credentials of a connected cluster. Gets cluster user credentials of the connected cluster with a specified resource group and name.

SELECT
hybridConnectionConfig,
kubeconfigs
FROM azure.hybrid_kubernetes.connected_cluster
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get the properties of the specified connected cluster. Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.

SELECT
id,
name,
aadProfile,
agentPublicKeyCertificate,
agentVersion,
arcAgentProfile,
arcAgentryConfigurations,
azureHybridBenefit,
connectivityStatus,
distribution,
distributionVersion,
gateway,
identity,
infrastructure,
kind,
kubernetesVersion,
lastConnectivityTime,
location,
managedIdentityCertificateExpirationTime,
miscellaneousProperties,
offering,
oidcIssuerProfile,
privateLinkScopeResourceId,
privateLinkState,
provisioningState,
securityProfile,
systemData,
tags,
totalCoreCount,
totalNodeCount,
type
FROM azure.hybrid_kubernetes.connected_cluster
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all connected clusters in the given Resource Group. API to enumerate registered connected K8s clusters under a Resource Group.

SELECT
id,
name,
aadProfile,
agentPublicKeyCertificate,
agentVersion,
arcAgentProfile,
arcAgentryConfigurations,
azureHybridBenefit,
connectivityStatus,
distribution,
distributionVersion,
gateway,
identity,
infrastructure,
kind,
kubernetesVersion,
lastConnectivityTime,
location,
managedIdentityCertificateExpirationTime,
miscellaneousProperties,
offering,
oidcIssuerProfile,
privateLinkScopeResourceId,
privateLinkState,
provisioningState,
securityProfile,
systemData,
tags,
totalCoreCount,
totalNodeCount,
type
FROM azure.hybrid_kubernetes.connected_cluster
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all connected clusters in the given Subscription. API to enumerate registered connected K8s clusters under a Subscription.

SELECT
id,
name,
aadProfile,
agentPublicKeyCertificate,
agentVersion,
arcAgentProfile,
arcAgentryConfigurations,
azureHybridBenefit,
connectivityStatus,
distribution,
distributionVersion,
gateway,
identity,
infrastructure,
kind,
kubernetesVersion,
lastConnectivityTime,
location,
managedIdentityCertificateExpirationTime,
miscellaneousProperties,
offering,
oidcIssuerProfile,
privateLinkScopeResourceId,
privateLinkState,
provisioningState,
securityProfile,
systemData,
tags,
totalCoreCount,
totalNodeCount,
type
FROM azure.hybrid_kubernetes.connected_cluster
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Register a new Kubernetes cluster with Azure Resource Manager. API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).

INSERT INTO azure.hybrid_kubernetes.connected_cluster (
tags,
location,
properties,
identity,
kind,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ identity }}' /* required */,
'{{ kind }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: connected_cluster
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connected_cluster resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the connected_cluster resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connected_cluster resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the connected cluster resource properties. Required.
    value:
      agentPublicKeyCertificate: "{{ agentPublicKeyCertificate }}"
      kubernetesVersion: "{{ kubernetesVersion }}"
      totalNodeCount: {{ totalNodeCount }}
      totalCoreCount: {{ totalCoreCount }}
      agentVersion: "{{ agentVersion }}"
      provisioningState: "{{ provisioningState }}"
      distribution: "{{ distribution }}"
      distributionVersion: "{{ distributionVersion }}"
      infrastructure: "{{ infrastructure }}"
      offering: "{{ offering }}"
      managedIdentityCertificateExpirationTime: "{{ managedIdentityCertificateExpirationTime }}"
      lastConnectivityTime: "{{ lastConnectivityTime }}"
      connectivityStatus: "{{ connectivityStatus }}"
      privateLinkState: "{{ privateLinkState }}"
      privateLinkScopeResourceId: "{{ privateLinkScopeResourceId }}"
      azureHybridBenefit: "{{ azureHybridBenefit }}"
      aadProfile:
        enableAzureRBAC: {{ enableAzureRBAC }}
        adminGroupObjectIDs:
          - "{{ adminGroupObjectIDs }}"
        tenantID: "{{ tenantID }}"
      arcAgentProfile:
        desiredAgentVersion: "{{ desiredAgentVersion }}"
        agentAutoUpgrade: "{{ agentAutoUpgrade }}"
        systemComponents:
          - type: "{{ type }}"
            userSpecifiedVersion: "{{ userSpecifiedVersion }}"
            majorVersion: {{ majorVersion }}
            currentVersion: "{{ currentVersion }}"
        agentErrors:
          - message: "{{ message }}"
            severity: "{{ severity }}"
            component: "{{ component }}"
            time: "{{ time }}"
        agentState: "{{ agentState }}"
      securityProfile:
        workloadIdentity:
          enabled: {{ enabled }}
      oidcIssuerProfile:
        enabled: {{ enabled }}
        issuerUrl: "{{ issuerUrl }}"
        selfHostedIssuerUrl: "{{ selfHostedIssuerUrl }}"
      gateway:
        enabled: {{ enabled }}
      arcAgentryConfigurations:
        - feature: "{{ feature }}"
          settings: "{{ settings }}"
          protectedSettings: "{{ protectedSettings }}"
      miscellaneousProperties: "{{ miscellaneousProperties }}"
  - name: identity
    description: |
      The identity of the connected cluster. Required.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of connected cluster. "ProvisionedCluster"
    valid_values: ['ProvisionedCluster']

REPLACE examples

create_or_replace

Register a new Kubernetes cluster with Azure Resource Manager. API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).

REPLACE azure.hybrid_kubernetes.connected_cluster
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND identity = '{{ identity }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a connected cluster. Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

DELETE FROM azure.hybrid_kubernetes.connected_cluster
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_async

Updates a connected cluster. API to update certain properties of the connected cluster resource.

EXEC azure.hybrid_kubernetes.connected_cluster.update_async 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"properties": "{{ properties }}"
}'
;