clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.nexus.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 manager associated with the cluster. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
identity	object	The identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterProperties represents the properties of a cluster.)
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 manager associated with the cluster. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
identity	object	The identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterProperties represents the properties of a cluster.)
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 manager associated with the cluster. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
identity	object	The identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterProperties represents the properties of a cluster.)
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		Get properties of the provided cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of clusters in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of clusters in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, data__extendedLocation, data__properties		Create a new cluster or update the properties of the cluster if it exists.
update	update	subscriptionId, resourceGroupName, clusterName		Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, clusterName		Delete the provided cluster.
continue_update_version	exec	subscriptionId, resourceGroupName, clusterName		Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.
deploy	exec	subscriptionId, resourceGroupName, clusterName		Deploy the cluster using the rack configuration provided during creation.
scan_runtime	exec	subscriptionId, resourceGroupName, clusterName		Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

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 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 cluster.

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

list_by_resource_group

Get a list of clusters in the provided resource group.

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

list_by_subscription

Get a list of clusters in the provided subscription.

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

INSERT examples

create_or_update

Create a new cluster or update the properties of the cluster if it exists.

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

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster manager associated with the cluster.
    - name: identity
      value: object
      description: |
        The identity for 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 cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

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

DELETE examples

delete

Delete the provided cluster.

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

Lifecycle Methods

continue_update_version

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

EXEC azure.nexus.clusters.continue_update_version 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"machineGroupTargetingMode": "{{ machineGroupTargetingMode }}"
}'
;

deploy

Deploy the cluster using the rack configuration provided during creation.

EXEC azure.nexus.clusters.deploy 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"skipValidationsForMachines": "{{ skipValidationsForMachines }}"
}'
;

scan_runtime

Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

EXEC azure.nexus.clusters.scan_runtime 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"scanActivity": "{{ scanActivity }}"
}'
;