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_vm.sql_virtual_machine_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the SQL virtual machine group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved all SQL virtual machine groups in the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

Successfully retrieved all SQL virtual machine groups in the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId		Gets a SQL virtual machine group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all SQL virtual machine groups in a resource group.
list	select	subscriptionId		Gets all SQL virtual machine groups in a subscription.
create_or_update	insert	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId, data__location		Creates or updates a SQL virtual machine group.
update	update	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId		Updates SQL virtual machine group tags.
delete	delete	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId		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
resourceGroupName	string	Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlVirtualMachineGroupName	string	Name of the SQL virtual machine group.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a SQL virtual machine group.

SELECT
location,
properties,
systemData,
tags
FROM azure.sql_vm.sql_virtual_machine_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets all SQL virtual machine groups in a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.sql_vm.sql_virtual_machine_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all SQL virtual machine groups in a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.sql_vm.sql_virtual_machine_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SQL virtual machine group.

INSERT INTO azure.sql_vm.sql_virtual_machine_groups (
data__tags,
data__location,
data__properties,
resourceGroupName,
sqlVirtualMachineGroupName,
subscriptionId
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlVirtualMachineGroupName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sql_virtual_machine_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_virtual_machine_groups resource.
    - name: sqlVirtualMachineGroupName
      value: string
      description: Required parameter for the sql_virtual_machine_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_virtual_machine_groups resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates SQL virtual machine group tags.

UPDATE azure.sql_vm.sql_virtual_machine_groups
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes a SQL virtual machine group.

DELETE FROM azure.sql_vm.sql_virtual_machine_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;