sql_virtual_machine_groups

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

Overview

Name	sql_virtual_machine_groups
Type	Resource
Id	azure.sql_virtual_machine.sql_virtual_machine_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
clusterConfiguration	string	Cluster type. "Domainful"
clusterManagerType	string	Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. "WSFC"
location	string	Resource location. Required.
provisioningState	string	Provisioning state to track the async operation status.
scaleType	string	Scale type. "HA"
sqlImageOffer	string	SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku	string	SQL image sku. Known values are: "Developer" and "Enterprise".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.
wsfcDomainProfile	object	Cluster Active Directory domain profile.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
clusterConfiguration	string	Cluster type. "Domainful"
clusterManagerType	string	Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. "WSFC"
location	string	Resource location. Required.
provisioningState	string	Provisioning state to track the async operation status.
scaleType	string	Scale type. "HA"
sqlImageOffer	string	SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku	string	SQL image sku. Known values are: "Developer" and "Enterprise".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.
wsfcDomainProfile	object	Cluster Active Directory domain profile.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
clusterConfiguration	string	Cluster type. "Domainful"
clusterManagerType	string	Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. "WSFC"
location	string	Resource location. Required.
provisioningState	string	Provisioning state to track the async operation status.
scaleType	string	Scale type. "HA"
sqlImageOffer	string	SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku	string	SQL image sku. Known values are: "Developer" and "Enterprise".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.
wsfcDomainProfile	object	Cluster Active Directory domain profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, sql_virtual_machine_group_name, subscription_id		Gets a SQL virtual machine group.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all SQL virtual machine groups in a resource group.
list	select	subscription_id		Gets all SQL virtual machine groups in a subscription.
create_or_update	insert	resource_group_name, sql_virtual_machine_group_name, subscription_id, location		Creates or updates a SQL virtual machine group.
update	update	resource_group_name, sql_virtual_machine_group_name, subscription_id		Updates SQL virtual machine group tags.
create_or_update	replace	resource_group_name, sql_virtual_machine_group_name, subscription_id, location		Creates or updates a SQL virtual machine group.
delete	delete	resource_group_name, sql_virtual_machine_group_name, subscription_id		Deletes a SQL virtual machine group.

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	Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_group_name	string	Name of the SQL virtual machine group. Required.
subscription_id	string

SELECT examples

get

Gets a SQL virtual machine group.

SELECT
id,
name,
clusterConfiguration,
clusterManagerType,
location,
provisioningState,
scaleType,
sqlImageOffer,
sqlImageSku,
systemData,
tags,
type,
wsfcDomainProfile
FROM azure.sql_virtual_machine.sql_virtual_machine_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sql_virtual_machine_group_name = '{{ sql_virtual_machine_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all SQL virtual machine groups in a resource group.

SELECT
id,
name,
clusterConfiguration,
clusterManagerType,
location,
provisioningState,
scaleType,
sqlImageOffer,
sqlImageSku,
systemData,
tags,
type,
wsfcDomainProfile
FROM azure.sql_virtual_machine.sql_virtual_machine_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all SQL virtual machine groups in a subscription.

SELECT
id,
name,
clusterConfiguration,
clusterManagerType,
location,
provisioningState,
scaleType,
sqlImageOffer,
sqlImageSku,
systemData,
tags,
type,
wsfcDomainProfile
FROM azure.sql_virtual_machine.sql_virtual_machine_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SQL virtual machine group.

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

Manifest

# Description fields are for documentation purposes
- name: sql_virtual_machine_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_virtual_machine_groups resource.
  - name: sql_virtual_machine_group_name
    value: "{{ sql_virtual_machine_group_name }}"
    description: Required parameter for the sql_virtual_machine_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_virtual_machine_groups resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    value:
      sqlImageOffer: "{{ sqlImageOffer }}"
      sqlImageSku: "{{ sqlImageSku }}"
      wsfcDomainProfile:
        domainFqdn: "{{ domainFqdn }}"
        ouPath: "{{ ouPath }}"
        clusterBootstrapAccount: "{{ clusterBootstrapAccount }}"
        clusterOperatorAccount: "{{ clusterOperatorAccount }}"
        sqlServiceAccount: "{{ sqlServiceAccount }}"
        fileShareWitnessPath: "{{ fileShareWitnessPath }}"
        storageAccountUrl: "{{ storageAccountUrl }}"
        storageAccountPrimaryKey: "{{ storageAccountPrimaryKey }}"
        clusterSubnetType: "{{ clusterSubnetType }}"

UPDATE examples

update

Updates SQL virtual machine group tags.

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

REPLACE examples

create_or_update

Creates or updates a SQL virtual machine group.

REPLACE azure.sql_virtual_machine.sql_virtual_machine_groups
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_virtual_machine_group_name = '{{ sql_virtual_machine_group_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 SQL virtual machine group.

DELETE FROM azure.sql_virtual_machine.sql_virtual_machine_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sql_virtual_machine_group_name = '{{ sql_virtual_machine_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;