server_dns_aliases

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

Overview

Name	server_dns_aliases
Type	Resource
Id	azure.sql.server_dns_aliases

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified server DNS alias.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of server DNS aliases.

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, serverName, dnsAliasName, subscriptionId		Gets a server DNS alias.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of server DNS aliases for a server.
create_or_update	insert	resourceGroupName, serverName, dnsAliasName, subscriptionId		Creates a server DNS alias.
delete	delete	resourceGroupName, serverName, dnsAliasName, subscriptionId		Deletes the server DNS alias with the given name.
acquire	exec	resourceGroupName, serverName, dnsAliasName, subscriptionId, oldServerDnsAliasId		Acquires server DNS alias from another 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
dnsAliasName	string	The name of the server dns alias.
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 that the alias is pointing to.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a server DNS alias.

SELECT
properties
FROM azure.sql.server_dns_aliases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND dnsAliasName = '{{ dnsAliasName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Gets a list of server DNS aliases for a server.

SELECT
properties
FROM azure.sql.server_dns_aliases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a server DNS alias.

INSERT INTO azure.sql.server_dns_aliases (
resourceGroupName,
serverName,
dnsAliasName,
subscriptionId
)
SELECT 
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ dnsAliasName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_dns_aliases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_dns_aliases resource.
    - name: serverName
      value: string
      description: Required parameter for the server_dns_aliases resource.
    - name: dnsAliasName
      value: string
      description: Required parameter for the server_dns_aliases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the server_dns_aliases resource.

DELETE examples

delete

Deletes the server DNS alias with the given name.

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

Lifecycle Methods

acquire

Acquires server DNS alias from another server.

EXEC azure.sql.server_dns_aliases.acquire 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@dnsAliasName='{{ dnsAliasName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"oldServerDnsAliasId": "{{ oldServerDnsAliasId }}"
}'
;