Communication Services - Check Name Availability

Controlla la disponibilità del nome
Verifica che il nome di CommunicationService sia valido e non sia già in uso.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

uuid

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
name True

string

Nome della risorsa per cui è necessario controllare la disponibilità.

type True

string

Tipo di risorsa.

Risposte

Nome Tipo Descrizione
200 OK

CheckNameAvailabilityResponse

Operazione completata. La risposta descrive la disponibilità del nome.

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

Check name availability available
Check name availability unavailable

Check name availability available

Esempio di richiesta

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

Risposta di esempio

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

Check name availability unavailable

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CheckNameAvailabilityReason

Motivo per cui il nome specificato non è disponibile.

CheckNameAvailabilityResponse

Risultato della disponibilità del controllo.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

NameAvailabilityParameters

Data POST-ed nell'azione nameAvailability

CheckNameAvailabilityReason

Motivo per cui il nome specificato non è disponibile.

Nome Tipo Descrizione
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Risultato della disponibilità del controllo.

Nome Tipo Descrizione
message

string

Motivo dettagliato per cui il nome specificato è disponibile.

nameAvailable

boolean

Indica se il nome della risorsa è disponibile.

reason

CheckNameAvailabilityReason

Motivo per cui il nome specificato non è disponibile.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

NameAvailabilityParameters

Data POST-ed nell'azione nameAvailability

Nome Tipo Descrizione
name

string

Nome della risorsa per cui è necessario controllare la disponibilità.

type

string

Tipo di risorsa.