servers

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

Overview

Name	servers
Type	Resource
Id	azure.sql.servers

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified server.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the server.
kind	string	Kind of sql server. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved the list of servers.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the server.
kind	string	Kind of sql server. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

list

Successfully retrieved the list of servers.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the server.
kind	string	Kind of sql server. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, subscriptionId	$expand	Gets a server.
list_by_resource_group	select	resourceGroupName, subscriptionId	$expand	Gets a list of servers in a resource groups.
list	select	subscriptionId	$expand	Gets a list of all servers in the subscription.
create_or_update	insert	resourceGroupName, serverName, subscriptionId, data__location		Creates or updates a server.
update	update	resourceGroupName, serverName, subscriptionId		Updates a server.
delete	delete	resourceGroupName, serverName, subscriptionId		Deletes a server.
check_name_availability	exec	subscriptionId		Determines whether a resource can be created with the specified name.
import_database	exec	resourceGroupName, serverName, subscriptionId, storageKeyType, storageKey, storageUri, administratorLogin, administratorLoginPassword		Imports a bacpac into a new database.
refresh_status	exec	resourceGroupName, serverName, subscriptionId		Refresh external governance enablement status.

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 resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
$expand	string	The child resources to include in the response.

SELECT examples

get

Gets a server.

SELECT
identity,
kind,
location,
properties,
tags
FROM azure.sql.servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets a list of servers in a resource groups.

SELECT
identity,
kind,
location,
properties,
tags
FROM azure.sql.servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets a list of all servers in the subscription.

SELECT
identity,
kind,
location,
properties,
tags
FROM azure.sql.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Creates or updates a server.

INSERT INTO azure.sql.servers (
data__location,
data__tags,
data__identity,
data__properties,
resourceGroupName,
serverName,
subscriptionId
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ identity }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}'
RETURNING
identity,
kind,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: servers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the servers resource.
    - name: serverName
      value: string
      description: Required parameter for the servers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the servers resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: identity
      value: object
      description: |
        The Azure Active Directory identity of the server.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates a server.

UPDATE azure.sql.servers
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
kind,
location,
properties,
tags;

DELETE examples

delete

Deletes a server.

DELETE FROM azure.sql.servers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Determines whether a resource can be created with the specified name.

EXEC azure.sql.servers.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

import_database

Imports a bacpac into a new database.

EXEC azure.sql.servers.import_database 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"databaseName": "{{ databaseName }}", 
"edition": "{{ edition }}", 
"serviceObjectiveName": "{{ serviceObjectiveName }}", 
"maxSizeBytes": "{{ maxSizeBytes }}", 
"storageKeyType": "{{ storageKeyType }}", 
"storageKey": "{{ storageKey }}", 
"storageUri": "{{ storageUri }}", 
"administratorLogin": "{{ administratorLogin }}", 
"administratorLoginPassword": "{{ administratorLoginPassword }}", 
"authenticationType": "{{ authenticationType }}", 
"networkIsolation": "{{ networkIsolation }}"
}'
;

refresh_status

Refresh external governance enablement status.

EXEC azure.sql.servers.refresh_status 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;