sql_virtual_machines

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

Overview

Name	sql_virtual_machines
Type	Resource
Id	azure.sql_vm.sql_virtual_machines

Fields

The following fields are returned by SELECT queries:

list_by_sql_vm_group

Successfully retrieved the list of sql virtual machines in a SQL virtual machine group.

Name	Datatype	Description
identity	object	DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
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.

get

Successfully retrieved the SQL virtual machine.

Name	Datatype	Description
identity	object	DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
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 machines in the resource group.

Name	Datatype	Description
identity	object	DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
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 machines in the subscription.

Name	Datatype	Description
identity	object	DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
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
list_by_sql_vm_group	select	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId		Gets the list of sql virtual machines in a SQL virtual machine group.
get	select	resourceGroupName, sqlVirtualMachineName, subscriptionId	$expand	Gets a SQL virtual machine.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all SQL virtual machines in a resource group.
list	select	subscriptionId		Gets all SQL virtual machines in a subscription.
create_or_update	insert	resourceGroupName, sqlVirtualMachineName, subscriptionId, data__location		Creates or updates a SQL virtual machine.
update	update	resourceGroupName, sqlVirtualMachineName, subscriptionId		Updates SQL virtual machine tags.
delete	delete	resourceGroupName, sqlVirtualMachineName, subscriptionId		Deletes a SQL virtual machine.
start_assessment	exec	resourceGroupName, sqlVirtualMachineName, subscriptionId		Starts SQL best practices Assessment on SQL virtual machine.
fetch_dc_assessment	exec	resourceGroupName, sqlVirtualMachineName, subscriptionId		Starts SQL best practices Assessment with Disk Config rules on SQL virtual machine
redeploy	exec	resourceGroupName, sqlVirtualMachineName, subscriptionId		Uninstalls and reinstalls the SQL IaaS Extension.

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.
sqlVirtualMachineName	string	Name of the SQL virtual machine.
subscriptionId	string	The ID of the target subscription.
$expand	string	The child resources to include in the response.

SELECT examples

list_by_sql_vm_group

Gets the list of sql virtual machines in a SQL virtual machine group.

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

get

Gets a SQL virtual machine.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.sql_vm.sql_virtual_machines
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlVirtualMachineName = '{{ sqlVirtualMachineName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all SQL virtual machines in a resource group.

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

list

Gets all SQL virtual machines in a subscription.

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

INSERT examples

create_or_update

Creates or updates a SQL virtual machine.

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

Manifest

# Description fields are for documentation purposes
- name: sql_virtual_machines
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_virtual_machines resource.
    - name: sqlVirtualMachineName
      value: string
      description: Required parameter for the sql_virtual_machines resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_virtual_machines resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates SQL virtual machine tags.

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

DELETE examples

delete

Deletes a SQL virtual machine.

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

Lifecycle Methods

start_assessment

Starts SQL best practices Assessment on SQL virtual machine.

EXEC azure.sql_vm.sql_virtual_machines.start_assessment 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlVirtualMachineName='{{ sqlVirtualMachineName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

fetch_dc_assessment

Starts SQL best practices Assessment with Disk Config rules on SQL virtual machine

EXEC azure.sql_vm.sql_virtual_machines.fetch_dc_assessment 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlVirtualMachineName='{{ sqlVirtualMachineName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"runDiskConfigRules": {{ runDiskConfigRules }}
}'
;

redeploy

Uninstalls and reinstalls the SQL IaaS Extension.

EXEC azure.sql_vm.sql_virtual_machines.redeploy 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlVirtualMachineName='{{ sqlVirtualMachineName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;