Servers - Check Name Availability

Servicio:

SQL Database

Versión de la API:

2023-08-01

Determina si se puede crear un recurso con el nombre especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityResponse	Se completó correctamente la comprobación de disponibilidad.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 InvalidNameAvailabilityRequest: la solicitud de disponibilidad check name no es válida. 400 UnknownNameType: tipo de recurso desconocido especificado para una comprobación de disponibilidad de nombre de nivel de suscripción.

Ejemplos

Check for a server name that already exists

Check for a server name that is available

Check for a server name that is invalid

Check for a server name that already exists

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CheckNameAvailabilityServerAlreadyExists.json
// this example is just showing the usage of "Servers_CheckNameAvailability" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CheckNameAvailabilityServerAvailable.json
// this example is just showing the usage of "Servers_CheckNameAvailability" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CheckNameAvailabilityServerInvalid.json
// this example is just showing the usage of "Servers_CheckNameAvailability" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("SERVER1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character."
}

Definiciones

Nombre	Description
CheckNameAvailabilityReason	El código de motivo que explica por qué el nombre no está disponible. No se definirá si el nombre está disponible.
CheckNameAvailabilityRequest	Solicitud para comprobar si el nombre especificado para un recurso está disponible.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Resultado de una comprobación de disponibilidad de nombres.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

CheckNameAvailabilityReason

Enumeración

El código de motivo que explica por qué el nombre no está disponible. No se definirá si el nombre está disponible.

Valor	Description
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Object

Solicitud para comprobar si el nombre especificado para un recurso está disponible.

Nombre	Tipo	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Enumeración

Valor	Description
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Object

Resultado de una comprobación de disponibilidad de nombres.

Nombre	Tipo	Description
available	boolean	True si el nombre está disponible; de lo contrario, false.
message	string	Mensaje que explica por qué el nombre no está disponible. No se definirá si el nombre está disponible.
name	string	Nombre cuya disponibilidad se ha comprobado.
reason	CheckNameAvailabilityReason	El código de motivo que explica por qué el nombre no está disponible. No se definirá si el nombre está disponible.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.