clusters
Creates, updates, deletes, gets or lists a clusters
resource.
Overview
Name | clusters |
Type | Resource |
Id | azure_isv.connected_vsphere.clusters |
Fields
- vw_clusters
- clusters
Name | Datatype | Description |
---|---|---|
id | text | Gets or sets the Id. |
name | text | Gets or sets the name. |
clusterName | text | field from the properties object |
custom_resource_name | text | field from the properties object |
datastore_ids | text | field from the properties object |
extended_location | text | field from the properties object |
inventory_item_id | text | field from the properties object |
kind | text | 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 | text | Gets or sets the location. |
mo_name | text | field from the properties object |
mo_ref_id | text | field from the properties object |
network_ids | text | field from the properties object |
provisioning_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
statuses | text | field from the properties object |
subscriptionId | text | field from the properties object |
system_data | text | field from the properties object |
tags | text | Gets or sets the Resource tags. |
total_cpu_m_hz | text | field from the properties object |
total_memory_gb | text | field from the properties object |
type | text | Gets or sets the type of the resource. |
used_cpu_m_hz | text | field from the properties object |
used_memory_gb | text | field from the properties object |
uuid | text | field from the properties object |
v_center_id | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
id | string | Gets or sets the Id. |
name | string | Gets or sets the name. |
extendedLocation | object | 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 | Describes the properties of a Cluster. |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
tags | object | Gets or sets the Resource tags. |
type | string | Gets or sets the type of the resource. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | clusterName, resourceGroupName, subscriptionId | Implements cluster GET method. |
list | SELECT | subscriptionId | List of clusters in a subscription. |
list_by_resource_group | SELECT | resourceGroupName, subscriptionId | List of clusters in a resource group. |
create | INSERT | clusterName, resourceGroupName, subscriptionId, data__location, data__properties | Create Or Update cluster. |
delete | DELETE | clusterName, resourceGroupName, subscriptionId | Implements cluster DELETE method. |
update | UPDATE | clusterName, resourceGroupName, subscriptionId | API to update certain properties of the cluster resource. |
SELECT
examples
List of clusters in a subscription.
- vw_clusters
- clusters
SELECT
id,
name,
clusterName,
custom_resource_name,
datastore_ids,
extended_location,
inventory_item_id,
kind,
location,
mo_name,
mo_ref_id,
network_ids,
provisioning_state,
resourceGroupName,
statuses,
subscriptionId,
system_data,
tags,
total_cpu_m_hz,
total_memory_gb,
type,
used_cpu_m_hz,
used_memory_gb,
uuid,
v_center_id
FROM azure_isv.connected_vsphere.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
FROM azure_isv.connected_vsphere.clusters
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new clusters
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_isv.connected_vsphere.clusters (
clusterName,
resourceGroupName,
subscriptionId,
data__location,
data__properties,
properties,
location,
extendedLocation,
systemData,
tags,
kind
)
SELECT
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ location }}',
'{{ extendedLocation }}',
'{{ systemData }}',
'{{ tags }}',
'{{ kind }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: uuid
value: string
- name: vCenterId
value: string
- name: moRefId
value: string
- name: inventoryItemId
value: string
- name: moName
value: string
- name: statuses
value:
- - name: type
value: string
- name: status
value: string
- name: reason
value: string
- name: message
value: string
- name: severity
value: string
- name: lastUpdatedAt
value: string
- name: customResourceName
value: string
- name: usedMemoryGB
value: integer
- name: totalMemoryGB
value: integer
- name: usedCpuMHz
value: integer
- name: totalCpuMHz
value: integer
- name: datastoreIds
value:
- string
- name: networkIds
value:
- string
- name: provisioningState
value: []
- name: location
value: string
- name: extendedLocation
value:
- name: type
value: string
- name: name
value: string
- name: systemData
value:
- name: createdBy
value: string
- name: createdByType
value: string
- name: createdAt
value: string
- name: lastModifiedBy
value: string
- name: lastModifiedByType
value: string
- name: lastModifiedAt
value: string
- name: tags
value: object
- name: name
value: string
- name: id
value: string
- name: type
value: string
- name: kind
value: string
UPDATE
example
Updates a clusters
resource.
/*+ update */
UPDATE azure_isv.connected_vsphere.clusters
SET
tags = '{{ tags }}'
WHERE
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
DELETE
example
Deletes the specified clusters
resource.
/*+ delete */
DELETE FROM azure_isv.connected_vsphere.clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';