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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureDnsRecord	string	The fully qualified DNS record for alias.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureDnsRecord	string	The fully qualified DNS record for alias.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, dns_alias_name, subscription_id		Gets a server DNS alias.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of server DNS aliases for a server.
create_or_update	insert	resource_group_name, server_name, dns_alias_name, subscription_id		Creates a server DNS alias.
create_or_update	replace	resource_group_name, server_name, dns_alias_name, subscription_id		Creates a server DNS alias.
delete	delete	resource_group_name, server_name, dns_alias_name, subscription_id		Deletes the server DNS alias with the given name.
acquire	exec	resource_group_name, server_name, dns_alias_name, subscription_id, 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
dns_alias_name	string	The name of the server dns alias. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a server DNS alias.

SELECT
id,
name,
azureDnsRecord,
systemData,
type
FROM azure.sql.server_dns_aliases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND dns_alias_name = '{{ dns_alias_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets a list of server DNS aliases for a server.

SELECT
id,
name,
azureDnsRecord,
systemData,
type
FROM azure.sql.server_dns_aliases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a server DNS alias.

INSERT INTO azure.sql.server_dns_aliases (
resource_group_name,
server_name,
dns_alias_name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ dns_alias_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_dns_aliases
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_dns_aliases resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_dns_aliases resource.
  - name: dns_alias_name
    value: "{{ dns_alias_name }}"
    description: Required parameter for the server_dns_aliases resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_dns_aliases resource.

REPLACE examples

create_or_update

Creates a server DNS alias.

REPLACE azure.sql.server_dns_aliases
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND dns_alias_name = '{{ dns_alias_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the server DNS alias with the given name.

DELETE FROM azure.sql.server_dns_aliases
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND dns_alias_name = '{{ dns_alias_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

acquire

Acquires server DNS alias from another server.

EXEC azure.sql.server_dns_aliases.acquire 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@dns_alias_name='{{ dns_alias_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"oldServerDnsAliasId": "{{ oldServerDnsAliasId }}"
}'
;