sql_server_databases

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

Overview

Name	sql_server_databases
Type	Resource
Id	azure.azure_arc_data.sql_server_databases

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Arc Sql Server database
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Arc Sql Server database
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, databaseName	api-version	Retrieves an Arc Sql Server database.
list	select	subscriptionId, resourceGroupName, sqlServerInstanceName	api-version
create	insert	subscriptionId, resourceGroupName, sqlServerInstanceName, databaseName, data__properties	api-version	Creates or replaces an Arc Sql Server Database.
update	update	subscriptionId, resourceGroupName, sqlServerInstanceName, databaseName	api-version	Updates an existing database.
delete	delete	subscriptionId, resourceGroupName, sqlServerInstanceName, databaseName	api-version	Deletes an Arc Sql Server database 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
databaseName	string	Name of the database
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 an Arc Sql Server database.

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

list

OK

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

INSERT examples

create

Creates or replaces an Arc Sql Server Database.

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

Manifest

# Description fields are for documentation purposes
- name: sql_server_databases
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_server_databases resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_server_databases resource.
    - name: sqlServerInstanceName
      value: string
      description: Required parameter for the sql_server_databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the sql_server_databases 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: |
        Properties of Arc Sql Server database
    - name: api-version
      value: string
      description: The API version to use for the request

UPDATE examples

update

Updates an existing database.

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

DELETE examples

delete

Deletes an Arc Sql Server database resource.

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