clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_isv.avs.clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clusterId	integer	The identity.
clusterSize	integer	The cluster size.
hosts	array	The hosts.
provisioningState	string	The state of the cluster provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Deleting, Updating)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vsanDatastoreName	string	Name of the vsan datastore associated with the cluster.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clusterId	integer	The identity.
clusterSize	integer	The cluster size.
hosts	array	The hosts.
provisioningState	string	The state of the cluster provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Cancelled, Deleting, Updating)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vsanDatastoreName	string	Name of the vsan datastore associated with the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, cluster_name, subscription_id		Get a Cluster.
list	select	resource_group_name, private_cloud_name, subscription_id		List Cluster resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, cluster_name, subscription_id, sku		Create a Cluster.
update	update	resource_group_name, private_cloud_name, cluster_name, subscription_id		Update a Cluster.
create_or_update	replace	resource_group_name, private_cloud_name, cluster_name, subscription_id, sku		Create a Cluster.
delete	delete	resource_group_name, private_cloud_name, cluster_name, subscription_id		Delete a Cluster.
list_zones	exec	resource_group_name, private_cloud_name, cluster_name, subscription_id		List hosts by zone in 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
cluster_name	string	Name of the cluster. Required.
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Cluster.

SELECT
id,
name,
clusterId,
clusterSize,
hosts,
provisioningState,
sku,
systemData,
type,
vsanDatastoreName
FROM azure_isv.avs.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Cluster resources by PrivateCloud.

SELECT
id,
name,
clusterId,
clusterSize,
hosts,
provisioningState,
sku,
systemData,
type,
vsanDatastoreName
FROM azure_isv.avs.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Cluster.

INSERT INTO azure_isv.avs.clusters (
properties,
sku,
resource_group_name,
private_cloud_name,
cluster_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clusters resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clusters resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      clusterSize: {{ clusterSize }}
      provisioningState: "{{ provisioningState }}"
      clusterId: {{ clusterId }}
      hosts:
        - "{{ hosts }}"
      vsanDatastoreName: "{{ vsanDatastoreName }}"
  - name: sku
    description: |
      The SKU (Stock Keeping Unit) assigned to this resource. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}

UPDATE examples

update

Update a Cluster.

UPDATE azure_isv.avs.clusters
SET 
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
type;

REPLACE examples

create_or_update

Create a Cluster.

REPLACE azure_isv.avs.clusters
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
type;

DELETE examples

delete

Delete a Cluster.

DELETE FROM azure_isv.avs.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_zones

List hosts by zone in a cluster.

EXEC azure_isv.avs.clusters.list_zones 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;