connected_clusters

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

Overview

Name	connected_clusters
Type	Resource
Id	azure.hybrid_kubernetes.connected_clusters

Fields

The following fields are returned by SELECT queries:

get

Resource retrieved successfully.

Name	Datatype	Description
identity	object	The identity of the connected cluster.
kind	string	The kind of connected cluster.
location	string	The geo-location where the resource lives
properties	object	Describes the connected cluster resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	The identity of the connected cluster.
kind	string	The kind of connected cluster.
location	string	The geo-location where the resource lives
properties	object	Describes the connected cluster resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
identity	object	The identity of the connected cluster.
kind	string	The kind of connected cluster.
location	string	The geo-location where the resource lives
properties	object	Describes the connected cluster resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName		Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
list_by_resource_group	select	subscriptionId, resourceGroupName		API to enumerate registered connected K8s clusters under a Resource Group
list_by_subscription	select	subscriptionId		API to enumerate registered connected K8s clusters under a Subscription
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, data__properties, data__identity		API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).
update	update	subscriptionId, resourceGroupName, clusterName		API to update certain properties of the connected cluster resource
delete	delete	subscriptionId, resourceGroupName, clusterName		Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

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
clusterName	string	The name of the Kubernetes cluster on which get is called.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

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

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure.hybrid_kubernetes.connected_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

list_by_resource_group

API to enumerate registered connected K8s clusters under a Resource Group

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure.hybrid_kubernetes.connected_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

API to enumerate registered connected K8s clusters under a Subscription

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure.hybrid_kubernetes.connected_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

INSERT INTO azure.hybrid_kubernetes.connected_clusters (
data__identity,
data__kind,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
clusterName
)
SELECT 
'{{ identity }}' /* required */,
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}'
RETURNING
identity,
kind,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connected_clusters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the connected_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connected_clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the connected_clusters resource.
    - name: identity
      value: object
      description: |
        The identity of the connected cluster.
    - name: kind
      value: string
      description: |
        The kind of connected cluster.
      valid_values: ['ProvisionedCluster']
    - name: properties
      value: object
      description: |
        Describes the connected cluster resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

API to update certain properties of the connected cluster resource

UPDATE azure.hybrid_kubernetes.connected_clusters
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
RETURNING
identity,
kind,
location,
properties,
systemData,
tags;

DELETE examples

delete

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

DELETE FROM azure.hybrid_kubernetes.connected_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
;