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

vw_sql_virtual_machine_groups

Name	Datatype	Description
cluster_configuration	text	field from the properties object
cluster_manager_type	text	field from the properties object
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
scale_type	text	field from the properties object
sqlVirtualMachineGroupName	text	field from the properties object
sql_image_offer	text	field from the properties object
sql_image_sku	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
wsfc_domain_profile	text	field from the properties object

sql_virtual_machine_groups

Name	Datatype	Description
location	string	Resource location.
properties	object	The properties of a SQL virtual machine group.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId	Gets a SQL virtual machine group.
list	SELECT	subscriptionId	Gets all SQL virtual machine groups in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets all SQL virtual machine groups in a resource group.
create_or_update	INSERT	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId, data__location	Creates or updates a SQL virtual machine group.
delete	DELETE	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId	Deletes a SQL virtual machine group.
update	UPDATE	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId	Updates SQL virtual machine group tags.

SELECT examples

Gets all SQL virtual machine groups in a subscription.

vw_sql_virtual_machine_groups

SELECT
cluster_configuration,
cluster_manager_type,
location,
provisioning_state,
resourceGroupName,
scale_type,
sqlVirtualMachineGroupName,
sql_image_offer,
sql_image_sku,
subscriptionId,
system_data,
tags,
wsfc_domain_profile
FROM azure.sql_vm.vw_sql_virtual_machine_groups
WHERE subscriptionId = '{{ subscriptionId }}';

sql_virtual_machine_groups

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_virtual_machine_groups resource.

All Properties

/*+ create */
INSERT INTO azure.sql_vm.sql_virtual_machine_groups (
resourceGroupName,
sqlVirtualMachineGroupName,
subscriptionId,
data__location,
location,
tags,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ sqlVirtualMachineGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: sqlImageOffer
          value: string
        - name: sqlImageSku
          value: string
        - name: scaleType
          value: string
        - name: clusterManagerType
          value: string
        - name: clusterConfiguration
          value: string
        - name: wsfcDomainProfile
          value:
            - name: domainFqdn
              value: string
            - name: ouPath
              value: string
            - name: clusterBootstrapAccount
              value: string
            - name: clusterOperatorAccount
              value: string
            - name: sqlServiceAccount
              value: string
            - name: isSqlServiceAccountGmsa
              value: boolean
            - name: fileShareWitnessPath
              value: string
            - name: storageAccountUrl
              value: string
            - name: storageAccountPrimaryKey
              value: string
            - name: clusterSubnetType
              value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a sql_virtual_machine_groups resource.

/*+ update */
UPDATE azure.sql_vm.sql_virtual_machine_groups
SET 
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified sql_virtual_machine_groups resource.

/*+ delete */
DELETE FROM azure.sql_vm.sql_virtual_machine_groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';