Skip to main content

cloud_vm_clusters

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

Overview​

Namecloud_vm_clusters
TypeResource
Idazure_isv.oracle_database.cloud_vm_clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
displayNamestringPrivateIpAddresses displayName. Required.
hostnameLabelstringPrivateIpAddresses hostnameLabel. Required.
ipAddressstringPrivateIpAddresses ipAddress. Required.
ocidstringPrivateIpAddresses Id. Required.
subnetIdstringPrivateIpAddresses subnetId. Required.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_private_ip_addressesselectresource_group_name, cloudvmclustername, subscription_idList Private IP Addresses by the provided filter.
getselectresource_group_name, cloudvmclustername, subscription_idGet a CloudVmCluster.
list_by_resource_groupselectresource_group_name, subscription_idList CloudVmCluster resources by resource group.
list_by_subscriptionselectsubscription_idList CloudVmCluster resources by subscription ID.
create_or_updateinsertresource_group_name, cloudvmclustername, subscription_id, locationCreate a CloudVmCluster.
updateupdateresource_group_name, cloudvmclustername, subscription_idUpdate a CloudVmCluster.
create_or_updatereplaceresource_group_name, cloudvmclustername, subscription_id, locationCreate a CloudVmCluster.
deletedeleteresource_group_name, cloudvmclustername, subscription_idDelete a CloudVmCluster.
add_vmsexecresource_group_name, cloudvmclustername, subscription_id, dbServersAdd VMs to the VM Cluster.
remove_vmsexecresource_group_name, cloudvmclustername, subscription_id, dbServersRemove 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.

NameDatatypeDescription
cloudvmclusternamestringCloudVmCluster name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

List Private IP Addresses by the provided filter.

SELECT
displayName,
hostnameLabel,
ipAddress,
ocid,
subnetId
FROM azure_isv.oracle_database.cloud_vm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudvmclustername = '{{ cloudvmclustername }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a CloudVmCluster.

INSERT INTO azure_isv.oracle_database.cloud_vm_clusters (
tags,
location,
properties,
resource_group_name,
cloudvmclustername,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cloudvmclustername }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

Update a CloudVmCluster.

UPDATE azure_isv.oracle_database.cloud_vm_clusters
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloudvmclustername = '{{ cloudvmclustername }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples​

Create a CloudVmCluster.

REPLACE azure_isv.oracle_database.cloud_vm_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloudvmclustername = '{{ cloudvmclustername }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Delete a CloudVmCluster.

DELETE FROM azure_isv.oracle_database.cloud_vm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloudvmclustername = '{{ cloudvmclustername }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods​

Add VMs to the VM Cluster.

EXEC azure_isv.oracle_database.cloud_vm_clusters.add_vms 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloudvmclustername='{{ cloudvmclustername }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"dbServers": "{{ dbServers }}"
}'
;