Freigeben über


Communication Services - Check Name Availability

Dient zum Prüfen der Verfügbarkeit des Namens.
Überprüft, ob der Name von CommunicationService gültig ist und noch nicht verwendet wird.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

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 mit Beschreibung des Grunds für den Fehler.

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-03-31

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

{
  "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 Ergebnis der Verfügbarkeitsprüfung.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

NameAvailabilityParameters

Daten posted an die Aktion "NameAvailability"

CheckNameAvailabilityReason

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

Name Typ Beschreibung
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Das Ergebnis der Verfügbarkeitsprüfung.

Name Typ Beschreibung
message

string

Ausführlicher 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

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

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

Daten posted an die Aktion "NameAvailability"

Name Typ Beschreibung
name

string

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

type

string

Der Ressourcentyp.