Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-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=2021-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se 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		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

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * CheckNameAvailabilityServerAlreadyExists.json
     */
    /**
     * Sample code: Check for a server name that already exists.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatAlreadyExists(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), 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

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

Check for a server name that is available

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerAvailable.
     * json
     */
    /**
     * Sample code: Check for a server name that is available.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsAvailable(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), 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

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

Check for a server name that is invalid

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerInvalid.
     * json
     */
    /**
     * Sample code: Check for a server name that is invalid.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsInvalid(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("SERVER1"), 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

{
  "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 de un recurso está disponible.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Resultado de una comprobación de disponibilidad de nombres.

CheckNameAvailabilityReason

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

Nombre	Tipo	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

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

Nombre	Tipo	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nombre	Tipo	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

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.