sql_server_registrations

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

Overview

Name	sql_server_registrations
Type	Resource
Id	azure.azure_data.sql_server_registrations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the SQL Server registration.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Read only system data
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved all SQL Server registrations in the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Read only system data
tags	object	Resource tags.

list

Successfully retrieved all SQL Server registrations in the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
systemData	object	Read only system data
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlServerRegistrationName, subscriptionId		Gets a SQL Server registration.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all SQL Server registrations in a resource group.
list	select	subscriptionId		Gets all SQL Server registrations in a subscription.
create_or_update	insert	resourceGroupName, sqlServerRegistrationName, subscriptionId, data__location		Creates or updates a SQL Server registration.
update	update	resourceGroupName, sqlServerRegistrationName, subscriptionId		Updates SQL Server Registration tags.
delete	delete	resourceGroupName, sqlServerRegistrationName, subscriptionId		Deletes a SQL Server registration.

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.
sqlServerRegistrationName	string	Name of the SQL Server registration.
subscriptionId	string	Subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a SQL Server registration.

SELECT
location,
properties,
systemData,
tags
FROM azure.azure_data.sql_server_registrations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerRegistrationName = '{{ sqlServerRegistrationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets all SQL Server registrations in a resource group.

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

list

Gets all SQL Server registrations in a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.azure_data.sql_server_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SQL Server registration.

INSERT INTO azure.azure_data.sql_server_registrations (
data__tags,
data__location,
data__properties,
resourceGroupName,
sqlServerRegistrationName,
subscriptionId
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlServerRegistrationName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sql_server_registrations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_server_registrations resource.
    - name: sqlServerRegistrationName
      value: string
      description: Required parameter for the sql_server_registrations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_server_registrations 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: |
        Resource properties.

UPDATE examples

update

Updates SQL Server Registration tags.

UPDATE azure.azure_data.sql_server_registrations
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerRegistrationName = '{{ sqlServerRegistrationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes a SQL Server registration.

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