Accounts - Check Name Availability

Usługa:

Azure Video Indexer

Wersja interfejsu API:

2024-01-01

Sprawdza, czy nazwa konta usługi Video Indexer jest prawidłowa i nie jest jeszcze używana.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa konta usługi VideoIndexer.
type	True	Type	Typ zasobu, Microsoft.VideoIndexer/accounts

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckNameAvailabilityResult	OK — operacja sprawdzania dostępności nazwy konta usługi Video Indexer zakończyła się pomyślnie. Ok nie wskazuje, że nazwa jest dostępna, treść odpowiedzi.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ 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

Check free account name availability

Check taken account name availability

Check free account name availability

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2024-01-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "nameAvailable": true
}

Check taken account name availability

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2024-01-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Resource name already exists"
}

Definicje

Nazwa	Opis
AccountCheckNameAvailabilityParameters	Parametry używane do sprawdzania dostępności nazwy konta usługi Video Indexer.
CheckNameAvailabilityResult	Odpowiedź operacji CheckNameAvailability.
ErrorDefinition	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
Reason	Pobiera przyczynę, dla którego nie można użyć nazwy konta usługi Video Indexer. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.
Type	Typ zasobu, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Parametry używane do sprawdzania dostępności nazwy konta usługi Video Indexer.

Nazwa	Typ	Opis
name	string	Nazwa konta usługi VideoIndexer.
type	Type	Typ zasobu, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Odpowiedź operacji CheckNameAvailability.

Nazwa	Typ	Opis
message	string	Pobiera komunikat o błędzie wyjaśniający wartość Przyczyna bardziej szczegółowo.
nameAvailable	boolean	Pobiera wartość logiczną wskazującą, czy nazwa jest dostępna do użycia. Jeśli wartość true, nazwa jest dostępna. Jeśli wartość false, nazwa została już podjęta.
reason	Reason	Pobiera przyczynę, dla którego nie można użyć nazwy konta usługi Video Indexer. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

ErrorDefinition

Definicja błędu.

Nazwa	Typ	Opis
code	string	Kod błędu specyficzny dla usługi, który służy jako podstatu dla kodu błędu HTTP.
details	ErrorDefinition[]	Szczegóły błędu wewnętrznego.
message	string	Opis błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	ErrorDefinition	Szczegóły błędu.

Reason

Pobiera przyczynę, dla którego nie można użyć nazwy konta usługi Video Indexer. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

Nazwa	Typ	Opis
AlreadyExists	string

Type

Typ zasobu, Microsoft.VideoIndexer/accounts

Nazwa	Typ	Opis
Microsoft.VideoIndexer/accounts	string