Server Dns Aliases - Acquire

Dienst:: SQL Database

API-Version:: 2025-01-01

Erwirbt server-DNS-Alias von einem anderen Server.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dnsAliasName	path	True	string	Der Name des Server-DNS-Alias.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
oldServerDnsAliasId	True	string	Die ID des Serveralias, der stattdessen auf diesen Server verweist.

Antworten

Name	Typ	Beschreibung
200 OK	ServerDnsAlias	Azure-Operation erfolgreich abgeschlossen.
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

ServerDnsAlias

Azure-Operation erfolgreich abgeschlossen.

202 Accepted

Ressourcenvorgang akzeptiert.

Header

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Acquire server DNS alias

Beispielanforderung

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

{
  "oldServerDnsAliasId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1"
}


import com.azure.resourcemanager.sql.models.ServerDnsAliasAcquisition;

/**
 * Samples for ServerDnsAliases Acquire.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ServerDnsAliasAcquire.json
     */
    /**
     * Sample code: Acquire server DNS alias.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void acquireServerDNSAlias(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServerDnsAliases().acquire("Default", "dns-alias-new-server", "dns-alias-name-1",
            new ServerDnsAliasAcquisition().withOldServerDnsAliasId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python server_dns_alias_acquire.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.server_dns_aliases.begin_acquire(
        resource_group_name="Default",
        server_name="dns-alias-new-server",
        dns_alias_name="dns-alias-name-1",
        parameters={
            "oldServerDnsAliasId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1"
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ServerDnsAliasAcquire.json
if __name__ == "__main__":
    main()

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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to acquires server DNS alias from another server.
 *
 * @summary acquires server DNS alias from another server.
 * x-ms-original-file: 2025-01-01/ServerDnsAliasAcquire.json
 */
async function acquireServerDNSAlias() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.serverDnsAliases.acquire(
    "Default",
    "dns-alias-new-server",
    "dns-alias-name-1",
    {
      oldServerDnsAliasId:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1",
    },
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ServerDnsAliasAcquire.json
// this example is just showing the usage of "ServerDnsAliases_Acquire" 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://learn.microsoft.com/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 SqlServerDnsAliasResource created on azure
// for more information of creating SqlServerDnsAliasResource, please refer to the document of SqlServerDnsAliasResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "dns-alias-new-server";
string dnsAliasName = "dns-alias-name-1";
ResourceIdentifier sqlServerDnsAliasResourceId = SqlServerDnsAliasResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, dnsAliasName);
SqlServerDnsAliasResource sqlServerDnsAlias = client.GetSqlServerDnsAliasResource(sqlServerDnsAliasResourceId);

// invoke the operation
ServerDnsAliasAcquisition serverDnsAliasAcquisition = new ServerDnsAliasAcquisition(new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1"));
ArmOperation<SqlServerDnsAliasResource> lro = await sqlServerDnsAlias.AcquireAsync(WaitUntil.Completed, serverDnsAliasAcquisition);
SqlServerDnsAliasResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/serverDnsAliasOperationResults/00000000-1111-2222-3333-444444444444?api-version=2017-03-01-preview

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerDnsAlias	Ein Server-DNS-Alias.
ServerDnsAliasAcquisition	Eine Dns-Alias-Kaufanforderung des Servers.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ServerDnsAlias

Objekt

Ein Server-DNS-Alias.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.azureDnsRecord	string	Der vollqualifizierte DNS-Eintrag für Alias
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

ServerDnsAliasAcquisition

Objekt

Eine Dns-Alias-Kaufanforderung des Servers.

Name	Typ	Beschreibung
oldServerDnsAliasId	string	Die ID des Serveralias, der stattdessen auf diesen Server verweist.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.