Compartir a través de


Communication Services - Check Name Availability

Comprueba la disponibilidad del nombre
Comprueba que el nombre communicationService es válido y que aún no está en uso.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

Parámetros de identificador URI

Nombre En Requerido Tipo Description
subscriptionId
path True

string

uuid

Identificador de la suscripción de destino. El valor debe ser un UUID.

api-version
query True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
name True

string

Nombre del recurso para el que se debe comprobar la disponibilidad.

type True

string

El tipo de recurso.

Respuestas

Nombre Tipo Description
200 OK

CheckNameAvailabilityResponse

Correcto. La respuesta describe la disponibilidad del nombre.

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Ejemplos

Check name availability available
Check name availability unavailable

Check name availability available

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

Respuesta de muestra

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

Respuesta de muestra

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

Definiciones

Nombre Description
CheckNameAvailabilityReason

Motivo por el que el nombre especificado no está disponible.

CheckNameAvailabilityResponse

Resultado de comprobación de disponibilidad.

ErrorAdditionalInfo

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

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

NameAvailabilityParameters

Datos POST-ed a la acción nameAvailability

CheckNameAvailabilityReason

Motivo por el que el nombre especificado no está disponible.

Nombre Tipo Description
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Resultado de comprobación de disponibilidad.

Nombre Tipo Description
message

string

Motivo detallado por el que el nombre especificado está disponible.

nameAvailable

boolean

Indica si el nombre del recurso está disponible.

reason

CheckNameAvailabilityReason

Motivo por el que el nombre especificado no está disponible.

ErrorAdditionalInfo

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

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

NameAvailabilityParameters

Datos POST-ed a la acción nameAvailability

Nombre Tipo Description
name

string

Nombre del recurso para el que se debe comprobar la disponibilidad.

type

string

El tipo de recurso.