Udostępnij za pośrednictwem


Communication Services - Check Name Availability

Sprawdzanie dostępności nazwy
Sprawdza, czy nazwa usługi CommunicationService jest prawidłowa i nie jest jeszcze używana.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Wymagane Typ Opis
name True

string

Nazwa zasobu, dla którego należy sprawdzić dostępność.

type True

string

Typ zasobu.

Odpowiedzi

Nazwa Typ Opis
200 OK

CheckNameAvailabilityResponse

Sukces. Odpowiedź opisuje dostępność nazwy.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

Check name availability available
Check name availability unavailable

Check name availability available

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Check name availability unavailable

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CheckNameAvailabilityReason

Powód, dla którego dana nazwa jest niedostępna.

CheckNameAvailabilityResponse

Wynik sprawdzania dostępności.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

NameAvailabilityParameters

Dane POST-ed do akcji nameAvailability

CheckNameAvailabilityReason

Powód, dla którego dana nazwa jest niedostępna.

Wartość Opis
AlreadyExists
Invalid

CheckNameAvailabilityResponse

Wynik sprawdzania dostępności.

Nazwa Typ Opis
message

string

Szczegółowy powód, dla którego dana nazwa jest dostępna.

nameAvailable

boolean

Wskazuje, czy nazwa zasobu jest dostępna.

reason

CheckNameAvailabilityReason

Powód, dla którego dana nazwa jest niedostępna.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

NameAvailabilityParameters

Dane POST-ed do akcji nameAvailability

Nazwa Typ Opis
name

string

Nazwa zasobu, dla którego należy sprawdzić dostępność.

type

string

Typ zasobu.