Freigeben über


Communication Services - Check Name Availability

Überprüfen der Namensverfügbarkeit
Überprüft, ob der Name des CommunicationService gültig ist und noch nicht verwendet wird.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

uuid

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

Der Name der Ressource, für die die Verfügbarkeit überprüft werden muss.

type True

string

Der Ressourcentyp.

Antworten

Name Typ Beschreibung
200 OK

CheckNameAvailabilityResponse

Erfolg. Die Antwort beschreibt die Namensverfügbarkeit.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Check name availability available
Check name availability unavailable

Check name availability available

Beispielanforderung

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

Beispiel für eine Antwort

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

Check name availability unavailable

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CheckNameAvailabilityReason

Der Grund, warum der angegebene Name nicht verfügbar ist.

CheckNameAvailabilityResponse

Das Verfügbarkeitsergebnis der Überprüfung.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

NameAvailabilityParameters

Data POST-ed to the nameAvailability action

CheckNameAvailabilityReason

Der Grund, warum der angegebene Name nicht verfügbar ist.

Name Typ Beschreibung
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Das Verfügbarkeitsergebnis der Überprüfung.

Name Typ Beschreibung
message

string

Detaillierter Grund, warum der angegebene Name verfügbar ist.

nameAvailable

boolean

Gibt an, ob der Ressourcenname verfügbar ist.

reason

CheckNameAvailabilityReason

Der Grund, warum der angegebene Name nicht verfügbar ist.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

NameAvailabilityParameters

Data POST-ed to the nameAvailability action

Name Typ Beschreibung
name

string

Der Name der Ressource, für die die Verfügbarkeit überprüft werden muss.

type

string

Der Ressourcentyp.