clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_isv.connectedvmware.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.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the cluster.
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. Required.
moName	string	Gets or sets the vCenter Managed Object name for the cluster.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.
networkIds	array	Gets the network ARM ids.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
totalCpuMHz	integer	Gets the max CPU usage across all cores on the cluster in MHz.
totalMemoryGB	integer	Gets the total amount of physical memory on the cluster in GB.
type	string	Gets or sets the type of the resource.
usedCpuMHz	integer	Gets the used CPU usage across all cores on the cluster in MHz.
usedMemoryGB	integer	Gets the used physical memory on the cluster in GB.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the cluster.
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. Required.
moName	string	Gets or sets the vCenter Managed Object name for the cluster.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.
networkIds	array	Gets the network ARM ids.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
totalCpuMHz	integer	Gets the max CPU usage across all cores on the cluster in MHz.
totalMemoryGB	integer	Gets the total amount of physical memory on the cluster in GB.
type	string	Gets or sets the type of the resource.
usedCpuMHz	integer	Gets the used CPU usage across all cores on the cluster in MHz.
usedMemoryGB	integer	Gets the used physical memory on the cluster in GB.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	Gets or sets the extended location.
inventoryItemId	string	Gets or sets the inventory Item ID for the cluster.
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. Required.
moName	string	Gets or sets the vCenter Managed Object name for the cluster.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.
networkIds	array	Gets the network ARM ids.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
totalCpuMHz	integer	Gets the max CPU usage across all cores on the cluster in MHz.
totalMemoryGB	integer	Gets the total amount of physical memory on the cluster in GB.
type	string	Gets or sets the type of the resource.
usedCpuMHz	integer	Gets the used CPU usage across all cores on the cluster in MHz.
usedMemoryGB	integer	Gets the used physical memory on the cluster in GB.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets a cluster. Implements cluster GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET clusters in a resource group. List of clusters in a resource group.
list	select	subscription_id		Implements GET clusters in a subscription. List of clusters in a subscription.
create	insert	resource_group_name, cluster_name, subscription_id, location		Implements cluster PUT method. Create Or Update cluster.
update	update	resource_group_name, cluster_name, subscription_id		Updates a cluster. API to update certain properties of the cluster resource.
delete	delete	resource_group_name, cluster_name, subscription_id	force	Deletes an cluster. 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
cluster_name	string	Name of the cluster. Required.
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
force	boolean	Whether force delete was specified. Default value is None.

SELECT examples

get

Gets a cluster. Implements cluster GET method.

SELECT
id,
name,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
networkIds,
provisioningState,
statuses,
systemData,
tags,
totalCpuMHz,
totalMemoryGB,
type,
usedCpuMHz,
usedMemoryGB,
uuid,
vCenterId
FROM azure_isv.connectedvmware.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements GET clusters in a resource group. List of clusters in a resource group.

SELECT
id,
name,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
networkIds,
provisioningState,
statuses,
systemData,
tags,
totalCpuMHz,
totalMemoryGB,
type,
usedCpuMHz,
usedMemoryGB,
uuid,
vCenterId
FROM azure_isv.connectedvmware.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements GET clusters in a subscription. List of clusters in a subscription.

SELECT
id,
name,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
moName,
moRefId,
networkIds,
provisioningState,
statuses,
systemData,
tags,
totalCpuMHz,
totalMemoryGB,
type,
usedCpuMHz,
usedMemoryGB,
uuid,
vCenterId
FROM azure_isv.connectedvmware.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements cluster PUT method. Create Or Update cluster.

INSERT INTO azure_isv.connectedvmware.clusters (
location,
extendedLocation,
tags,
kind,
properties,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
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: 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: location
    value: "{{ location }}"
    description: |
      Gets or sets the location. Required.
  - name: extendedLocation
    description: |
      Gets or sets the extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the Resource tags.
  - name: kind
    value: "{{ kind }}"
    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: properties
    value:
      vCenterId: "{{ vCenterId }}"
      moRefId: "{{ moRefId }}"
      inventoryItemId: "{{ inventoryItemId }}"

UPDATE examples

update

Updates a cluster. API to update certain properties of the cluster resource.

UPDATE azure_isv.connectedvmware.clusters
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an cluster. Implements cluster DELETE method.

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