virtual_clusters

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

Overview

Name	virtual_clusters
Type	Resource
Id	azure.sql.virtual_clusters

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified virtual cluster.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved the list of virtual clusters.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

list

Successfully retrieved the list of virtual clusters.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualClusterName, subscriptionId		Gets a virtual cluster.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets a list of virtual clusters in a resource group.
list	select	subscriptionId		Gets a list of all virtualClusters in the subscription.
update	update	resourceGroupName, virtualClusterName, subscriptionId		Updates an existing virtual cluster.
delete	delete	resourceGroupName, virtualClusterName, subscriptionId		Deletes a virtual 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
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
virtualClusterName	string	The name of the virtual cluster.

SELECT examples

get

Gets a virtual cluster.

SELECT
location,
properties,
tags
FROM azure.sql.virtual_clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualClusterName = '{{ virtualClusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets a list of virtual clusters in a resource group.

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

list

Gets a list of all virtualClusters in the subscription.

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

UPDATE examples

update

Updates an existing virtual cluster.

UPDATE azure.sql.virtual_clusters
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualClusterName = '{{ virtualClusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a virtual cluster.

DELETE FROM azure.sql.virtual_clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualClusterName = '{{ virtualClusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;