clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_stack.azure_stack_hci.clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity of Cluster resource
location	string	The geo-location where the resource lives
properties	object	Cluster properties.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity of Cluster resource
location	string	The geo-location where the resource lives
properties	object	Cluster properties.
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
identity	object	Identity of Cluster resource
location	string	The geo-location where the resource lives
properties	object	Cluster properties.
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 HCI cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all HCI clusters in a resource group.
list_by_subscription	select	subscriptionId		List all HCI clusters in a subscription.
create	insert	subscriptionId, resourceGroupName, clusterName		Create an HCI cluster.
update	update	subscriptionId, resourceGroupName, clusterName		Update an HCI cluster.
delete	delete	subscriptionId, resourceGroupName, clusterName		Delete an HCI cluster.
upload_certificate	exec	subscriptionId, resourceGroupName, clusterName		Upload certificate.
extend_software_assurance_benefit	exec	subscriptionId, resourceGroupName, clusterName		Extends Software Assurance Benefit to a 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
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 HCI cluster.

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

list_by_resource_group

List all HCI clusters in a resource group.

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

list_by_subscription

List all HCI clusters in a subscription.

SELECT
identity,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create an HCI cluster.

INSERT INTO azure_stack.azure_stack_hci.clusters (
data__tags,
data__location,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
clusterName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}'
RETURNING
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: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        Identity of Cluster resource
    - name: properties
      value: object
      description: |
        Cluster properties.

UPDATE examples

update

Update an HCI cluster.

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

DELETE examples

delete

Delete an HCI cluster.

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

Lifecycle Methods

upload_certificate

Upload certificate.

EXEC azure_stack.azure_stack_hci.clusters.upload_certificate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

extend_software_assurance_benefit

Extends Software Assurance Benefit to a cluster

EXEC azure_stack.azure_stack_hci.clusters.extend_software_assurance_benefit 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;