managed_clusters

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

Overview

Name	managed_clusters
Type	Resource
Id	azure.aks.managed_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extended location of the Virtual Machine.
identity	object	The identity of the managed cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of a managed cluster.
sku	object	The managed cluster SKU.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
extendedLocation	object	The extended location of the Virtual Machine.
identity	object	The identity of the managed cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of a managed cluster.
sku	object	The managed cluster SKU.
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extended location of the Virtual Machine.
identity	object	The identity of the managed cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of a managed cluster.
sku	object	The managed cluster SKU.
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, resourceName
list_by_resource_group	select	subscriptionId, resourceGroupName
list	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroupName, resourceName
delete	delete	subscriptionId, resourceGroupName, resourceName
update_tags	exec	subscriptionId, resourceGroupName, resourceName
reset_service_principal_profile	exec	subscriptionId, resourceGroupName, resourceName, clientId		This action cannot be performed on a cluster that is not using a service principal
reset_aad_profile	exec	subscriptionId, resourceGroupName, resourceName		WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.
rotate_cluster_certificates	exec	subscriptionId, resourceGroupName, resourceName		See Certificate rotation for more details about rotating managed cluster certificates.
abort_latest_operation	exec	subscriptionId, resourceGroupName, resourceName		Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
rotate_service_account_signing_keys	exec	subscriptionId, resourceGroupName, resourceName
stop	exec	subscriptionId, resourceGroupName, resourceName		This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a cluster.
start	exec	subscriptionId, resourceGroupName, resourceName		See starting a cluster for more details about starting a cluster.
run_command	exec	subscriptionId, resourceGroupName, resourceName, command		AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the managed cluster resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK

SELECT
extendedLocation,
identity,
location,
properties,
sku,
tags
FROM azure.aks.managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

OK

SELECT
extendedLocation,
identity,
location,
properties,
sku,
tags
FROM azure.aks.managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

OK

SELECT
extendedLocation,
identity,
location,
properties,
sku,
tags
FROM azure.aks.managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.aks.managed_clusters (
data__sku,
data__extendedLocation,
data__identity,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ sku }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
extendedLocation,
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: managed_clusters
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the managed_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_clusters resource.
    - name: resourceName
      value: string
      description: Required parameter for the managed_clusters resource.
    - name: sku
      value: object
      description: |
        The managed cluster SKU.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the Virtual Machine.
    - name: identity
      value: object
      description: |
        The identity of the managed cluster, if configured.
    - name: properties
      value: object
      description: |
        Properties of a managed cluster.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

No description available.

DELETE FROM azure.aks.managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;

Lifecycle Methods

update_tags

OK

EXEC azure.aks.managed_clusters.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

reset_service_principal_profile

This action cannot be performed on a cluster that is not using a service principal

EXEC azure.aks.managed_clusters.reset_service_principal_profile 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"clientId": "{{ clientId }}", 
"secret": "{{ secret }}"
}'
;

reset_aad_profile

WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.

EXEC azure.aks.managed_clusters.reset_aad_profile 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"managed": {{ managed }}, 
"enableAzureRBAC": {{ enableAzureRBAC }}, 
"adminGroupObjectIDs": "{{ adminGroupObjectIDs }}", 
"clientAppID": "{{ clientAppID }}", 
"serverAppID": "{{ serverAppID }}", 
"serverAppSecret": "{{ serverAppSecret }}", 
"tenantID": "{{ tenantID }}"
}'
;

rotate_cluster_certificates

See Certificate rotation for more details about rotating managed cluster certificates.

EXEC azure.aks.managed_clusters.rotate_cluster_certificates 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

abort_latest_operation

Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.

EXEC azure.aks.managed_clusters.abort_latest_operation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

rotate_service_account_signing_keys

Accepted

EXEC azure.aks.managed_clusters.rotate_service_account_signing_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

stop

This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a cluster.

EXEC azure.aks.managed_clusters.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

start

See starting a cluster for more details about starting a cluster.

EXEC azure.aks.managed_clusters.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

run_command

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

EXEC azure.aks.managed_clusters.run_command 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"command": "{{ command }}", 
"context": "{{ context }}", 
"clusterToken": "{{ clusterToken }}"
}'
;