cloud_vm_clusters

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

Overview

Name	cloud_vm_clusters
Type	Resource
Id	azure_isv.oracle.cloud_vm_clusters

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, cloudvmclustername		Get a CloudVmCluster
list_by_resource_group	select	subscriptionId, resourceGroupName		List CloudVmCluster resources by resource group
list_by_subscription	select	subscriptionId		List CloudVmCluster resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, cloudvmclustername		Create a CloudVmCluster
update	update	subscriptionId, resourceGroupName, cloudvmclustername		Update a CloudVmCluster
delete	delete	subscriptionId, resourceGroupName, cloudvmclustername		Delete a CloudVmCluster
add_vms	exec	subscriptionId, resourceGroupName, cloudvmclustername, dbServers		Add VMs to the VM Cluster
remove_vms	exec	subscriptionId, resourceGroupName, cloudvmclustername, dbServers		Remove VMs from the VM 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
cloudvmclustername	string	CloudVmCluster name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a CloudVmCluster

SELECT
location,
properties,
tags
FROM azure_isv.oracle.cloud_vm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudvmclustername = '{{ cloudvmclustername }}' -- required
;

list_by_resource_group

List CloudVmCluster resources by resource group

SELECT
location,
properties,
tags
FROM azure_isv.oracle.cloud_vm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List CloudVmCluster resources by subscription ID

SELECT
location,
properties,
tags
FROM azure_isv.oracle.cloud_vm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a CloudVmCluster

INSERT INTO azure_isv.oracle.cloud_vm_clusters (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
cloudvmclustername
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ cloudvmclustername }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cloud_vm_clusters
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cloud_vm_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_vm_clusters resource.
    - name: cloudvmclustername
      value: string
      description: Required parameter for the cloud_vm_clusters resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a CloudVmCluster

UPDATE azure_isv.oracle.cloud_vm_clusters
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudvmclustername = '{{ cloudvmclustername }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a CloudVmCluster

DELETE FROM azure_isv.oracle.cloud_vm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudvmclustername = '{{ cloudvmclustername }}' --required
;

Lifecycle Methods

add_vms

Add VMs to the VM Cluster

EXEC azure_isv.oracle.cloud_vm_clusters.add_vms 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudvmclustername='{{ cloudvmclustername }}' --required 
@@json=
'{
"dbServers": "{{ dbServers }}"
}'
;

remove_vms

Remove VMs from the VM Cluster

EXEC azure_isv.oracle.cloud_vm_clusters.remove_vms 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudvmclustername='{{ cloudvmclustername }}' --required 
@@json=
'{
"dbServers": "{{ dbServers }}"
}'
;