Server Dns Aliases - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Creates a server DNS alias.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
dnsAliasName	path	True	string	The name of the server dns alias.
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	ServerDnsAlias	The server DNS alias already exists.
201 Created	ServerDnsAlias	Successfully created a server DNS alias.
202 Accepted		Accepted
Other Status Codes		*** Error Responses: *** 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 ServerDnsAliasDoesNotExist - Server DNS Alias does not exist on a server. 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 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 TokenTooLong - The provided token is too long. 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues. 400 InvalidServerName - Invalid server name specified. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 InvalidServerDnsAliasName - Invalid Server DNS Alias name was supplied. 400 ServerNotFound - The requested server was not found. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 404 OperationIdNotFound - The operation with Id does not exist. 409 ServerDnsAliasBusy - Server DNS Alias is busy with another operation. 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 ConflictingServerOperation - An operation is currently in progress for the server. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 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. 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. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - 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

Create server DNS alias

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-name-1?api-version=2021-11-01

Java

/**
 * Samples for ServerDnsAliases CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDnsAliasCreateOrUpdate.json
     */
    /**
     * Sample code: Create server DNS alias.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createServerDNSAlias(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDnsAliases().createOrUpdate("Default", "dns-alias-server",
            "dns-alias-name-1", com.azure.core.util.Context.NONE);
    }
}

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

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

Status code:

201

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

Status code:

202

Definitions

ServerDnsAlias

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.