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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
childResources	array	List of resources in this virtual cluster.
location	string	The geo-location where the resource lives. Required.
subnetId	string	Subnet resource ID for the virtual cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Virtual cluster version.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
childResources	array	List of resources in this virtual cluster.
location	string	The geo-location where the resource lives. Required.
subnetId	string	Subnet resource ID for the virtual cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Virtual cluster version.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
childResources	array	List of resources in this virtual cluster.
location	string	The geo-location where the resource lives. Required.
subnetId	string	Subnet resource ID for the virtual cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Virtual cluster version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_cluster_name, subscription_id		Gets a virtual cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of virtual clusters in a resource group.
list	select	subscription_id		Gets a list of all virtualClusters in the subscription.
create_or_update	insert	resource_group_name, virtual_cluster_name, subscription_id, location		Creates virtual cluster.
update	update	resource_group_name, virtual_cluster_name, subscription_id		Updates an existing virtual cluster.
create_or_update	replace	resource_group_name, virtual_cluster_name, subscription_id, location		Creates virtual cluster.
delete	delete	resource_group_name, virtual_cluster_name, subscription_id		Deletes a virtual cluster.
update_dns_servers	exec	resource_group_name, virtual_cluster_name, subscription_id		Synchronizes the DNS server settings used by the managed instances inside the given 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_cluster_name	string	The name of the virtual cluster. Required.

SELECT examples

get

Gets a virtual cluster.

SELECT
id,
name,
childResources,
location,
subnetId,
systemData,
tags,
type,
version
FROM azure.sql.virtual_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_cluster_name = '{{ virtual_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of virtual clusters in a resource group.

SELECT
id,
name,
childResources,
location,
subnetId,
systemData,
tags,
type,
version
FROM azure.sql.virtual_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of all virtualClusters in the subscription.

SELECT
id,
name,
childResources,
location,
subnetId,
systemData,
tags,
type,
version
FROM azure.sql.virtual_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates virtual cluster.

INSERT INTO azure.sql.virtual_clusters (
tags,
location,
properties,
resource_group_name,
virtual_cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_clusters resource.
  - name: virtual_cluster_name
    value: "{{ virtual_cluster_name }}"
    description: Required parameter for the virtual_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Resource properties.
    value:
      subnetId: "{{ subnetId }}"
      version: "{{ version }}"
      childResources:
        - "{{ childResources }}"

UPDATE examples

update

Updates an existing virtual cluster.

UPDATE azure.sql.virtual_clusters
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_cluster_name = '{{ virtual_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates virtual cluster.

REPLACE azure.sql.virtual_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_cluster_name = '{{ virtual_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a virtual cluster.

DELETE FROM azure.sql.virtual_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_cluster_name = '{{ virtual_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_dns_servers

Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

EXEC azure.sql.virtual_clusters.update_dns_servers 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_cluster_name='{{ virtual_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;