clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_isv.vmware.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The properties of a cluster resource
sku	object	The resource model definition representing SKU
type	string	Resource type.

list

successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The properties of a cluster resource
sku	object	The resource model definition representing SKU
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, privateCloudName, clusterName
list	select	subscriptionId, resourceGroupName, privateCloudName
create_or_update	insert	subscriptionId, resourceGroupName, privateCloudName, clusterName, data__sku, data__properties
update	update	subscriptionId, resourceGroupName, privateCloudName, clusterName
delete	delete	subscriptionId, resourceGroupName, privateCloudName, clusterName

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	Name of the cluster in the private cloud
privateCloudName	string	Name of the private cloud
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

successful operation

SELECT
id,
name,
properties,
sku,
type
FROM azure_isv.vmware.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateCloudName = '{{ privateCloudName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

list

successful operation

SELECT
id,
name,
properties,
sku,
type
FROM azure_isv.vmware.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateCloudName = '{{ privateCloudName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure_isv.vmware.clusters (
data__sku,
data__properties,
subscriptionId,
resourceGroupName,
privateCloudName,
clusterName
)
SELECT 
'{{ sku }}' /* required */,
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ privateCloudName }}',
'{{ clusterName }}'
RETURNING
id,
name,
properties,
sku,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: privateCloudName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: properties
      value: object
      description: |
        The properties of a cluster resource

UPDATE examples

update

No description available.

UPDATE azure_isv.vmware.clusters
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND privateCloudName = '{{ privateCloudName }}' --required
AND clusterName = '{{ clusterName }}' --required
RETURNING
id,
name,
properties,
sku,
type;

DELETE examples

delete

No description available.

DELETE FROM azure_isv.vmware.clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND privateCloudName = '{{ privateCloudName }}' --required
AND clusterName = '{{ clusterName }}' --required
;