virtual_clusters

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

Overview

Name	virtual_clusters
Type	Resource
Id	azure.sql.virtual_clusters

Fields

vw_virtual_clusters

Name	Datatype	Description
child_resources	text	field from the properties object
location	text	Resource location.
resourceGroupName	text	field from the properties object
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
version	text	field from the properties object
virtualClusterName	text	field from the properties object

virtual_clusters

Name	Datatype	Description
location	string	Resource location.
properties	object	The properties of a virtual cluster.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualClusterName	Gets a virtual cluster.
list	SELECT	subscriptionId	Gets a list of all virtualClusters in the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of virtual clusters in a resource group.
delete	DELETE	resourceGroupName, subscriptionId, virtualClusterName	Deletes a virtual cluster.
update	UPDATE	resourceGroupName, subscriptionId, virtualClusterName	Updates an existing virtual cluster.

SELECT examples

Gets a list of all virtualClusters in the subscription.

vw_virtual_clusters

SELECT
child_resources,
location,
resourceGroupName,
subnet_id,
subscriptionId,
tags,
version,
virtualClusterName
FROM azure.sql.vw_virtual_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_clusters

SELECT
location,
properties,
tags
FROM azure.sql.virtual_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

UPDATE example

Updates a virtual_clusters resource.

/*+ update */
UPDATE azure.sql.virtual_clusters
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualClusterName = '{{ virtualClusterName }}';

DELETE example

Deletes the specified virtual_clusters resource.

/*+ delete */
DELETE FROM azure.sql.virtual_clusters
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualClusterName = '{{ virtualClusterName }}';