managed_server_dns_aliases

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

Overview

Name	managed_server_dns_aliases
Type	Resource
Id	azure.sql.managed_server_dns_aliases

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified managed server DNS alias.

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, managedInstanceName, dnsAliasName, subscriptionId		Gets a server DNS alias.
create_or_update	insert	resourceGroupName, managedInstanceName, dnsAliasName, subscriptionId		Creates a managed server DNS alias.
delete	delete	resourceGroupName, managedInstanceName, dnsAliasName, subscriptionId		Deletes the managed server DNS alias with the given name.
acquire	exec	resourceGroupName, managedInstanceName, dnsAliasName, subscriptionId, oldManagedServerDnsAliasResourceId		Acquires managed server DNS alias from another managed 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
managedInstanceName	string	The name of the managed instance.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a server DNS alias.

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

INSERT examples

create_or_update

Creates a managed server DNS alias.

INSERT INTO azure.sql.managed_server_dns_aliases (
data__createDnsRecord,
resourceGroupName,
managedInstanceName,
dnsAliasName,
subscriptionId
)
SELECT 
{{ createDnsRecord }},
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ dnsAliasName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: managed_server_dns_aliases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_server_dns_aliases resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_server_dns_aliases resource.
    - name: dnsAliasName
      value: string
      description: Required parameter for the managed_server_dns_aliases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_server_dns_aliases resource.
    - name: createDnsRecord
      value: boolean
      description: |
        Whether or not DNS record should be created for this alias.
      default: true

DELETE examples

delete

Deletes the managed server DNS alias with the given name.

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

Lifecycle Methods

acquire

Acquires managed server DNS alias from another managed server.

EXEC azure.sql.managed_server_dns_aliases.acquire 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@dnsAliasName='{{ dnsAliasName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"oldManagedServerDnsAliasResourceId": "{{ oldManagedServerDnsAliasResourceId }}"
}'
;