clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_isv.connected_vsphere.clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
extendedLocation	object	Gets or sets the extended location.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location.
properties	object	Resource properties.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
extendedLocation	object	Gets or sets the extended location.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location.
properties	object	Resource properties.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
extendedLocation	object	Gets or sets the extended location.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	Gets or sets the location.
properties	object	Resource properties.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName	api-version	Implements cluster GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	List of clusters in a resource group.
list	select	subscriptionId	api-version	List of clusters in a subscription.
create	insert	subscriptionId, resourceGroupName, clusterName, data__location, data__properties	api-version	Create Or Update cluster.
update	update	subscriptionId, resourceGroupName, clusterName	api-version	API to update certain properties of the cluster resource.
delete	delete	subscriptionId, resourceGroupName, clusterName	api-version, force	Implements cluster DELETE method.

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.
resourceGroupName	string	The Resource Group Name.
subscriptionId	string	The Subscription ID.
api-version	string	Client Api Version.
force	boolean	Whether force delete was specified.

SELECT examples

get

Implements cluster GET method.

SELECT
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
FROM azure_isv.connected_vsphere.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

List of clusters in a resource group.

SELECT
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
FROM azure_isv.connected_vsphere.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

List of clusters in a subscription.

SELECT
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
FROM azure_isv.connected_vsphere.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Create Or Update cluster.

INSERT INTO azure_isv.connected_vsphere.clusters (
data__properties,
data__location,
data__extendedLocation,
data__tags,
data__kind,
subscriptionId,
resourceGroupName,
clusterName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ api-version }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
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: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: location
      value: string
      description: |
        Gets or sets the location.
    - name: extendedLocation
      value: object
      description: |
        Gets or sets the extended location.
    - name: tags
      value: object
      description: |
        Gets or sets the Resource tags.
    - name: kind
      value: string
      description: |
        Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

API to update certain properties of the cluster resource.

UPDATE azure_isv.connected_vsphere.clusters
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Implements cluster DELETE method.

DELETE FROM azure_isv.connected_vsphere.clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND api-version = '{{ api-version }}'
AND force = '{{ force }}'
;