Server Dns Aliases - Get

Service:: SQL Database

Version d'API:: 2023-08-01

Obtient un alias DNS de serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dnsAliasName	path	True	string	Nom de l’alias dns du serveur.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur vers lequel l’alias pointe.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	ServerDnsAlias	Récupération réussie de l’alias DNS du serveur spécifié.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 400 InvalidServerDnsAliasAcquireRequest : le corps de la demande d’alias DNS du serveur est vide ou non valide (il doit contenir l’ancien ID d’alias de serveur, par exemple : /subscriptions/0000000-1111-2222-3333-44444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1). 400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId : l’ancien ID d’alias DNS du serveur dans le corps de la demande est vide ou non valide (il doit avoir le formulaire : /subscriptions/00000000-1111-- 2222-3333-4444444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1). 400 UnableToResolveRemoteServer : le nom du serveur partenaire distant n’a pas pu être résolu en raison d’un nom de serveur non valide ou d’un problème de connectivité DNS. 400 CannotUseReservedDatabaseName - Impossible d’utiliser le nom de la base de données réservée dans cette opération. 400 InvalidServerName - Nom du serveur non valide spécifié. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 400 TokenTooLong : le jeton fourni est trop long. 400 InvalidServerDnsAliasName - Nom d’alias DNS du serveur non valide a été fourni. 400 ServerDnsAliasDoesNotExist - L’alias DNS du serveur n’existe pas sur un serveur. 400 ServerNotFound : le serveur demandé est introuvable. 400 UnableToTurnOnTableAuditingForDbOnServerWithServerDnsAlias - Les alias DNS du serveur ne fonctionnent pas correctement pour la base de données sur laquelle l’audit table est activé 400 UnableToCreateServerDnsAliasDueToTableAuditing : l’alias DNS du serveur ne peut pas être créé pour le serveur sur lequel l’audit de table est activé. 400 UnableToCreateServerDnsAliasDueToTableAuditingForDb - L’alias DNS du serveur ne peut pas être créé pour le serveur '{0}' car la base de données '{1}' a activé la fonctionnalité d’audit de table ou d’accès activé pour la sécurité. 400 LimitOfServerDnsAliasesPerServerExceedededed : la création d’un alias DNS de serveur dépasse le nombre autorisé d’alias DNS de serveur par serveur. 400 UnableToTurnOnTableAuditingForServerWithServerDnsAlias - Les alias DNS du serveur ne fonctionnent pas correctement pour le serveur sur lequel l’audit table est activé 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 ResourceNotFound : la ressource demandée est introuvable. 404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 409 ConflictingServerOperation : une opération est en cours pour le serveur. 409 SubscriptionDisabled : l’abonnement est désactivé. 409 ServerDnsAliasDnsRecordInUse : un enregistrement DNS en double existe pour le point de terminaison demandé. 409 ServerDnsAliasAlreadyExists - L’alias DNS du serveur existe déjà sur un serveur donné. 409 ServerDnsAliasBusy : l’alias DNS du serveur est occupé avec une autre opération. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 504 RequestTimeout : la demande de service a dépassé le délai d’expiration autorisé.

Nom

Type

Description

200 OK

ServerDnsAlias

Récupération réussie de l’alias DNS du serveur spécifié.

Other Status Codes

ErrorResponse

Réponses d’erreur : ***

400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
400 InvalidServerDnsAliasAcquireRequest : le corps de la demande d’alias DNS du serveur est vide ou non valide (il doit contenir l’ancien ID d’alias de serveur, par exemple : /subscriptions/0000000-1111-2222-3333-44444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).
400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId : l’ancien ID d’alias DNS du serveur dans le corps de la demande est vide ou non valide (il doit avoir le formulaire : /subscriptions/00000000-1111-- 2222-3333-4444444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).
400 UnableToResolveRemoteServer : le nom du serveur partenaire distant n’a pas pu être résolu en raison d’un nom de serveur non valide ou d’un problème de connectivité DNS.
400 CannotUseReservedDatabaseName - Impossible d’utiliser le nom de la base de données réservée dans cette opération.
400 InvalidServerName - Nom du serveur non valide spécifié.
400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide.
400 TokenTooLong : le jeton fourni est trop long.
400 InvalidServerDnsAliasName - Nom d’alias DNS du serveur non valide a été fourni.
400 ServerDnsAliasDoesNotExist - L’alias DNS du serveur n’existe pas sur un serveur.
400 ServerNotFound : le serveur demandé est introuvable.
400 UnableToTurnOnTableAuditingForDbOnServerWithServerDnsAlias - Les alias DNS du serveur ne fonctionnent pas correctement pour la base de données sur laquelle l’audit table est activé
400 UnableToCreateServerDnsAliasDueToTableAuditing : l’alias DNS du serveur ne peut pas être créé pour le serveur sur lequel l’audit de table est activé.
400 UnableToCreateServerDnsAliasDueToTableAuditingForDb - L’alias DNS du serveur ne peut pas être créé pour le serveur '{0}' car la base de données '{1}' a activé la fonctionnalité d’audit de table ou d’accès activé pour la sécurité.
400 LimitOfServerDnsAliasesPerServerExceedededed : la création d’un alias DNS de serveur dépasse le nombre autorisé d’alias DNS de serveur par serveur.
400 UnableToTurnOnTableAuditingForServerWithServerDnsAlias - Les alias DNS du serveur ne fonctionnent pas correctement pour le serveur sur lequel l’audit table est activé
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 ResourceNotFound : la ressource demandée est introuvable.
404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié.
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
409 ConflictingServerOperation : une opération est en cours pour le serveur.
409 SubscriptionDisabled : l’abonnement est désactivé.
409 ServerDnsAliasDnsRecordInUse : un enregistrement DNS en double existe pour le point de terminaison demandé.
409 ServerDnsAliasAlreadyExists - L’alias DNS du serveur existe déjà sur un serveur donné.
409 ServerDnsAliasBusy : l’alias DNS du serveur est occupé avec une autre opération.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
504 RequestTimeout : la demande de service a dépassé le délai d’expiration autorisé.

Exemples

Get server DNS alias

GET 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=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/ServerDnsAliasGet.json
// this example is just showing the usage of "ServerDnsAliases_Get" 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 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
string dnsAliasName = "dns-alias-name-1";
NullableResponse<SqlServerDnsAliasResource> response = await collection.GetIfExistsAsync(dnsAliasName);
SqlServerDnsAliasResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ServerDnsAlias	Alias DNS du serveur.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ServerDnsAlias

Object

Alias DNS du serveur.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.azureDnsRecord	string	Enregistrement DNS complet pour l’alias
type	string	Type de ressource.

Partager via

Server Dns Aliases - Get

Paramètres URI

Réponses

Exemples

Get server DNS alias

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDnsAlias