Partilhar via


Communication Services - Check Name Availability

Verificar disponibilidade de nomes
Verifica se o nome CommunicationService é válido e ainda não está em uso.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

uuid

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
name True

string

O nome do recurso cuja disponibilidade precisa ser verificada.

type True

string

O tipo de recurso.

Respostas

Name Tipo Description
200 OK

CheckNameAvailabilityResponse

Sucesso. A resposta descreve a disponibilidade do nome.

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Exemplos

Check name availability available
Check name availability unavailable

Check name availability available

Pedido de amostra

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

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

Resposta da amostra

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

Check name availability unavailable

Pedido de amostra

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

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

Resposta da amostra

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

Definições

Name Description
CheckNameAvailabilityReason

A razão pela qual o nome próprio não está disponível.

CheckNameAvailabilityResponse

O resultado da verificação da disponibilidade.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

NameAvailabilityParameters

Dados POST-ed para a ação nameAvailability

CheckNameAvailabilityReason

A razão pela qual o nome próprio não está disponível.

Name Tipo Description
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

O resultado da verificação da disponibilidade.

Name Tipo Description
message

string

Razão detalhada pela qual o nome próprio está disponível.

nameAvailable

boolean

Indica se o nome do recurso está disponível.

reason

CheckNameAvailabilityReason

A razão pela qual o nome próprio não está disponível.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

NameAvailabilityParameters

Dados POST-ed para a ação nameAvailability

Name Tipo Description
name

string

O nome do recurso cuja disponibilidade precisa ser verificada.

type

string

O tipo de recurso.