kubernetes_clusters

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

Overview

Name	kubernetes_clusters
Type	Resource
Id	azure.nexus.kubernetes_clusters

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: KubernetesClusterProperties represents the properties of Kubernetes cluster resource.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: KubernetesClusterProperties represents the properties of Kubernetes cluster resource.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: KubernetesClusterProperties represents the properties of Kubernetes cluster 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, kubernetesClusterName		Get properties of the provided the Kubernetes cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of Kubernetes clusters in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of Kubernetes clusters in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, kubernetesClusterName, data__extendedLocation, data__properties		Create a new Kubernetes cluster or update the properties of the existing one.
update	update	subscriptionId, resourceGroupName, kubernetesClusterName		Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, kubernetesClusterName		Delete the provided Kubernetes cluster.
restart_node	exec	subscriptionId, resourceGroupName, kubernetesClusterName, nodeName		Restart a targeted node of a Kubernetes cluster.

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

SELECT examples

get

Get properties of the provided the Kubernetes cluster.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.kubernetes_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' -- required
;

list_by_resource_group

Get a list of Kubernetes clusters in the provided resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.kubernetes_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of Kubernetes clusters in the provided subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.kubernetes_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new Kubernetes cluster or update the properties of the existing one.

INSERT INTO azure.nexus.kubernetes_clusters (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
kubernetesClusterName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ kubernetesClusterName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: kubernetes_clusters
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the kubernetes_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kubernetes_clusters resource.
    - name: kubernetesClusterName
      value: string
      description: Required parameter for the kubernetes_clusters resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.

UPDATE azure.nexus.kubernetes_clusters
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided Kubernetes cluster.

DELETE FROM azure.nexus.kubernetes_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
;

Lifecycle Methods

restart_node

Restart a targeted node of a Kubernetes cluster.

EXEC azure.nexus.kubernetes_clusters.restart_node 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@kubernetesClusterName='{{ kubernetesClusterName }}' --required 
@@json=
'{
"nodeName": "{{ nodeName }}"
}'
;