sql_server_instances

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

Overview

Name	sql_server_instances
Type	Resource
Id	azure.azure_arc_data.sql_server_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	null
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	null
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	null
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, sqlServerInstanceName	api-version	Retrieves a SQL Server Instance resource
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Gets all sqlServerInstances in a resource group.
list	select	subscriptionId	api-version
create	insert	subscriptionId, resourceGroupName, sqlServerInstanceName	api-version	Creates or replaces a SQL Server Instance resource
update	update	subscriptionId, resourceGroupName, sqlServerInstanceName	api-version	Updates a SQL Server Instance resource
delete	delete	subscriptionId, resourceGroupName, sqlServerInstanceName	api-version	Deletes a SQL Server Instance resource

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	The name of the Azure resource group
sqlServerInstanceName	string	Name of SQL Server Instance
subscriptionId	string	The ID of the Azure subscription
api-version	string	The API version to use for the request

SELECT examples

get

Retrieves a SQL Server Instance resource

SELECT
location,
properties,
tags
FROM azure.azure_arc_data.sql_server_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets all sqlServerInstances in a resource group.

SELECT
location,
properties,
tags
FROM azure.azure_arc_data.sql_server_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

OK

SELECT
location,
properties,
tags
FROM azure.azure_arc_data.sql_server_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates or replaces a SQL Server Instance resource

INSERT INTO azure.azure_arc_data.sql_server_instances (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sqlServerInstanceName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sqlServerInstanceName }}',
'{{ api-version }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sql_server_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_server_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_server_instances resource.
    - name: sqlServerInstanceName
      value: string
      description: Required parameter for the sql_server_instances 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: |
        null
    - name: api-version
      value: string
      description: The API version to use for the request

UPDATE examples

update

Updates a SQL Server Instance resource

UPDATE azure.azure_arc_data.sql_server_instances
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a SQL Server Instance resource

DELETE FROM azure.azure_arc_data.sql_server_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' --required
AND api-version = '{{ api-version }}'
;