sql_servers

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

Overview

Name	sql_servers
Type	Resource
Id	azure.azure_data.sql_servers

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the SQL Server.

Name	Datatype	Description
properties	object	Resource properties.

list_by_resource_group

Successfully retrieved all SQL Servers in the SQL Server Registration.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlServerRegistrationName, sqlServerName, subscriptionId	$expand	Gets a SQL Server.
list_by_resource_group	select	resourceGroupName, sqlServerRegistrationName, subscriptionId	$expand	Gets all SQL Servers in a SQL Server Registration.
create_or_update	insert	resourceGroupName, sqlServerRegistrationName, sqlServerName, subscriptionId		Creates or updates a SQL Server.
delete	delete	resourceGroupName, sqlServerRegistrationName, sqlServerName, subscriptionId		Deletes a SQL Server.

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.
sqlServerName	string	Name of the SQL Server.
sqlServerRegistrationName	string	Name of the SQL Server registration.
subscriptionId	string	Subscription ID that identifies an Azure subscription.
$expand	string	The child resources to include in the response.

SELECT examples

get

Gets a SQL Server.

SELECT
properties
FROM azure.azure_data.sql_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerRegistrationName = '{{ sqlServerRegistrationName }}' -- required
AND sqlServerName = '{{ sqlServerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all SQL Servers in a SQL Server Registration.

SELECT
properties
FROM azure.azure_data.sql_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerRegistrationName = '{{ sqlServerRegistrationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Creates or updates a SQL Server.

INSERT INTO azure.azure_data.sql_servers (
data__properties,
resourceGroupName,
sqlServerRegistrationName,
sqlServerName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlServerRegistrationName }}',
'{{ sqlServerName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_servers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_servers resource.
    - name: sqlServerRegistrationName
      value: string
      description: Required parameter for the sql_servers resource.
    - name: sqlServerName
      value: string
      description: Required parameter for the sql_servers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_servers resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a SQL Server.

DELETE FROM azure.azure_data.sql_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerRegistrationName = '{{ sqlServerRegistrationName }}' --required
AND sqlServerName = '{{ sqlServerName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;