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

vw_connected_clusters

Name	Datatype	Description
aad_profile	text	field from the properties object
agent_public_key_certificate	text	field from the properties object
agent_version	text	field from the properties object
arc_agent_profile	text	field from the properties object
arc_agentry_configurations	text	field from the properties object
azure_hybrid_benefit	text	field from the properties object
clusterName	text	field from the properties object
connectivity_status	text	field from the properties object
distribution	text	field from the properties object
distribution_version	text	field from the properties object
gateway	text	field from the properties object
identity	text	Identity for the connected cluster.
infrastructure	text	field from the properties object
kind	text	Indicates the kind of Arc connected cluster based on host infrastructure.
kubernetes_version	text	field from the properties object
last_connectivity_time	text	field from the properties object
location	text	The geo-location where the resource lives
managed_identity_certificate_expiration_time	text	field from the properties object
miscellaneous_properties	text	field from the properties object
offering	text	field from the properties object
oidc_issuer_profile	text	field from the properties object
private_link_scope_resource_id	text	field from the properties object
private_link_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
security_profile	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
total_core_count	text	field from the properties object
total_node_count	text	field from the properties object

connected_clusters

Name	Datatype	Description
identity	object	Identity for the connected cluster.
kind	string	Indicates the kind of Arc connected cluster based on host infrastructure.
location	string	The geo-location where the resource lives
properties	object	Properties of the connected cluster.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	clusterName, resourceGroupName, subscriptionId, data__identity, data__properties	API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
update	UPDATE	clusterName, resourceGroupName, subscriptionId	API to update certain properties of the connected cluster resource

SELECT examples

API to enumerate registered connected K8s clusters under a Subscription

vw_connected_clusters

SELECT
aad_profile,
agent_public_key_certificate,
agent_version,
arc_agent_profile,
arc_agentry_configurations,
azure_hybrid_benefit,
clusterName,
connectivity_status,
distribution,
distribution_version,
gateway,
identity,
infrastructure,
kind,
kubernetes_version,
last_connectivity_time,
location,
managed_identity_certificate_expiration_time,
miscellaneous_properties,
offering,
oidc_issuer_profile,
private_link_scope_resource_id,
private_link_state,
provisioning_state,
resourceGroupName,
security_profile,
subscriptionId,
system_data,
tags,
total_core_count,
total_node_count
FROM azure.hybrid_kubernetes.vw_connected_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

connected_clusters

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

INSERT example

Use the following StackQL query and manifest file to create a new connected_clusters resource.

All Properties

/*+ create */
INSERT INTO azure.hybrid_kubernetes.connected_clusters (
clusterName,
resourceGroupName,
subscriptionId,
data__identity,
data__properties,
identity,
kind,
properties,
tags,
location
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__identity }}',
'{{ data__properties }}',
'{{ identity }}',
'{{ kind }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
    - name: kind
      value: []
    - name: properties
      value:
        - name: agentPublicKeyCertificate
          value: string
        - name: kubernetesVersion
          value: string
        - name: totalNodeCount
          value: integer
        - name: totalCoreCount
          value: integer
        - name: agentVersion
          value: string
        - name: provisioningState
          value: []
        - name: distribution
          value: string
        - name: distributionVersion
          value: string
        - name: infrastructure
          value: string
        - name: offering
          value: string
        - name: managedIdentityCertificateExpirationTime
          value: string
        - name: lastConnectivityTime
          value: string
        - name: connectivityStatus
          value: string
        - name: privateLinkState
          value: string
        - name: privateLinkScopeResourceId
          value: string
        - name: azureHybridBenefit
          value: string
        - name: aadProfile
          value:
            - name: enableAzureRBAC
              value: boolean
            - name: adminGroupObjectIDs
              value:
                - string
            - name: tenantID
              value: string
        - name: arcAgentProfile
          value:
            - name: desiredAgentVersion
              value: string
            - name: agentAutoUpgrade
              value: string
            - name: systemComponents
              value:
                - - name: type
                    value: string
                  - name: userSpecifiedVersion
                    value: string
                  - name: majorVersion
                    value: integer
                  - name: currentVersion
                    value: string
            - name: agentErrors
              value:
                - - name: message
                    value: string
                  - name: severity
                    value: string
                  - name: component
                    value: string
                  - name: time
                    value: string
            - name: agentState
              value: string
        - name: securityProfile
          value:
            - name: workloadIdentity
              value:
                - name: enabled
                  value: boolean
        - name: oidcIssuerProfile
          value:
            - name: enabled
              value: boolean
            - name: issuerUrl
              value: string
            - name: selfHostedIssuerUrl
              value: string
        - name: gateway
          value:
            - name: enabled
              value: boolean
            - name: resourceId
              value: string
        - name: arcAgentryConfigurations
          value:
            - - name: feature
                value: string
              - name: settings
                value: object
              - name: protectedSettings
                value: object
        - name: miscellaneousProperties
          value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a connected_clusters resource.

/*+ update */
UPDATE azure.hybrid_kubernetes.connected_clusters
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified connected_clusters resource.

/*+ delete */
DELETE FROM azure.hybrid_kubernetes.connected_clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';