Api Management Service - Check Name Availability

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Sprawdza dostępność i poprawność nazwy usługi API Management.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-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 do sprawdzenia dostępności.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiManagementServiceNameAvailabilityResult	Wynik sprawdzania dostępności nazwy.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementServiceCheckNameAvailability

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-01

{
  "name": "apimService1"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "nameAvailable": true,
  "reason": "Valid",
  "message": ""
}

Definicje

Nazwa	Opis
ApiManagementServiceCheckNameAvailabilityParameters	Parametry dostarczone do operacji CheckNameAvailability.
ApiManagementServiceNameAvailabilityResult	Odpowiedź operacji CheckNameAvailability.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
NameAvailabilityReason	Nieprawidłowy wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa dostawcy zasobów (nieprawidłowa długość, nieobsługiwane znaki itp.) AlreadyExists wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

ApiManagementServiceCheckNameAvailabilityParameters

Objekt

Parametry dostarczone do operacji CheckNameAvailability.

Nazwa	Typ	Opis
name	string	Nazwa do sprawdzenia dostępności.

ApiManagementServiceNameAvailabilityResult

Objekt

Odpowiedź operacji CheckNameAvailability.

Nazwa	Typ	Opis
message	string	Jeśli przyczyna == jest nieprawidłowa, podaj użytkownikowi powód, dla którego dana nazwa jest nieprawidłowa, i podaj wymagania dotyczące nazewnictwa zasobów, aby użytkownik mógł wybrać prawidłową nazwę. Jeśli przyczyna == AlreadyExists, wyjaśnij, że jest już używany, i przekierowuj je, aby wybrać inną nazwę.
nameAvailable	boolean	Prawda, jeśli nazwa jest dostępna i może służyć do utworzenia nowej usługi API Management; w przeciwnym razie wartość false.
reason	NameAvailabilityReason	Nieprawidłowy wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa dostawcy zasobów (nieprawidłowa długość, nieobsługiwane znaki itp.) AlreadyExists wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

ErrorAdditionalInfo

Objekt

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

NameAvailabilityReason

Wyliczanie

Nieprawidłowy wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa dostawcy zasobów (nieprawidłowa długość, nieobsługiwane znaki itp.) AlreadyExists wskazuje, że nazwa jest już używana i dlatego jest niedostępna.

Wartość	Opis
AlreadyExists
Invalid
Valid