Servers - Check Name Availability

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-02-01-preview

Parámetros de identificador URI

Name In Required Type 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

Name Required Type Description
name True
  • string
type True

Respuestas

Name Type Description
200 OK

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

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

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

Sample Response

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

Check for a server name that is available

Sample Request

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

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

Sample Response

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

Check for a server name that is invalid

Sample Request

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

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

Sample Response

{
  "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

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.

Name Type Description
AlreadyExists
  • string
Invalid
  • string

CheckNameAvailabilityRequest

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

Name Type Description
name
  • string
type

CheckNameAvailabilityResourceType

Name Type Description
Microsoft.Sql/servers
  • string

CheckNameAvailabilityResponse

Resultado de una comprobación de disponibilidad de nombres.

Name Type 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

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