Server Dns Aliases - List By Server

Service:: SQL Database

API Version:: 2023-08-01

Gets a list of server DNS aliases for a server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	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	path	True	string	The name of the server that the alias is pointing to.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	ServerDnsAliasListResult	Successfully retrieved the list of server DNS aliases.
Other Status Codes	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 400 InvalidServerDnsAliasAcquireRequest - The acquire server DNS alias request body is empty or invalid (it should contain the old server alias id, for example: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1). 400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId - The old server DNS alias id in request body is empty or invalid (it should have the form: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1). 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues. 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 InvalidServerName - Invalid server name specified. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 TokenTooLong - The provided token is too long. 400 InvalidServerDnsAliasName - Invalid Server DNS Alias name was supplied. 400 ServerDnsAliasDoesNotExist - Server DNS Alias does not exist on a server. 400 ServerNotFound - The requested server was not found. 400 UnableToTurnOnTableAuditingForDbOnServerWithServerDnsAlias - Server Dns Aliases are not working correctly for database that has Table Auditing turned on 400 UnableToCreateServerDnsAliasDueToTableAuditing - The Server DNS Alias cannot be created for server that has table auditing turned on. 400 UnableToCreateServerDnsAliasDueToTableAuditingForDb - Server DNS Alias cannot be created for server '{0}' because database '{1}' has Table Auditing or Security Enabled Access feature enabled. 400 LimitOfServerDnsAliasesPerServerExceeded - Creating new Server Dns Alias will exceed the allowed number of Server DNS Aliases per server. 400 UnableToTurnOnTableAuditingForServerWithServerDnsAlias - Server Dns Aliases are not working correctly for server that has Table Auditing turned on 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ResourceNotFound - The requested resource was not found. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 409 ConflictingServerOperation - An operation is currently in progress for the server. 409 SubscriptionDisabled - Subscription is disabled. 409 ServerDnsAliasDnsRecordInUse - A duplicate DNS record exists for the requested endpoint. 409 ServerDnsAliasAlreadyExists - Server DNS Alias already exists on a given server. 409 ServerDnsAliasBusy - Server DNS Alias is busy with another operation. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout.

Name

Type

Description

200 OK

ServerDnsAliasListResult

Successfully retrieved the list of server DNS aliases.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
400 InvalidServerDnsAliasAcquireRequest - The acquire server DNS alias request body is empty or invalid (it should contain the old server alias id, for example: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).
400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId - The old server DNS alias id in request body is empty or invalid (it should have the form: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).
400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.
400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.
400 InvalidServerName - Invalid server name specified.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
400 TokenTooLong - The provided token is too long.
400 InvalidServerDnsAliasName - Invalid Server DNS Alias name was supplied.
400 ServerDnsAliasDoesNotExist - Server DNS Alias does not exist on a server.
400 ServerNotFound - The requested server was not found.
400 UnableToTurnOnTableAuditingForDbOnServerWithServerDnsAlias - Server Dns Aliases are not working correctly for database that has Table Auditing turned on
400 UnableToCreateServerDnsAliasDueToTableAuditing - The Server DNS Alias cannot be created for server that has table auditing turned on.
400 UnableToCreateServerDnsAliasDueToTableAuditingForDb - Server DNS Alias cannot be created for server '{0}' because database '{1}' has Table Auditing or Security Enabled Access feature enabled.
400 LimitOfServerDnsAliasesPerServerExceeded - Creating new Server Dns Alias will exceed the allowed number of Server DNS Aliases per server.
400 UnableToTurnOnTableAuditingForServerWithServerDnsAlias - Server Dns Aliases are not working correctly for server that has Table Auditing turned on
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ResourceNotFound - The requested resource was not found.
404 ServerNotInSubscription - Specified server does not exist on the specified subscription.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
409 ConflictingServerOperation - An operation is currently in progress for the server.
409 SubscriptionDisabled - Subscription is disabled.
409 ServerDnsAliasDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.
409 ServerDnsAliasAlreadyExists - Server DNS Alias already exists on a given server.
409 ServerDnsAliasBusy - Server DNS Alias is busy with another operation.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

List server DNS aliases

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerDnsAliasList.json
// this example is just showing the usage of "ServerDnsAliases_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "dns-alias-server";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerDnsAliasResource
SqlServerDnsAliasCollection collection = sqlServer.GetSqlServerDnsAliases();

// invoke the operation and iterate over the result
await foreach (SqlServerDnsAliasResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerDnsAliasData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-1",
      "name": "server-dns-alias-1",
      "type": "Microsoft.Sql/servers/dnsAliases",
      "properties": {
        "azureDnsRecord": "dns-alias-1.database.windows.net"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-2",
      "name": "server-dns-alias-2",
      "type": "Microsoft.Sql/servers/dnsAliases",
      "properties": {
        "azureDnsRecord": "dns-alias-2.database.windows.net"
      }
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ServerDnsAlias	A server DNS alias.
ServerDnsAliasListResult	A list of server DNS aliases.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ServerDnsAlias

Object

A server DNS alias.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.azureDnsRecord	string	The fully qualified DNS record for alias
type	string	Resource type.

ServerDnsAliasListResult

Object

A list of server DNS aliases.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ServerDnsAlias[]	Array of results.

Share via

Server Dns Aliases - List By Server

URI Parameters

Responses

Examples

List server DNS aliases

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDnsAlias

ServerDnsAliasListResult