Accounts - Check Name Availability

Služba:

Azure Video Indexer

Verze rozhraní API:

2024-01-01

Zkontroluje, jestli je název účtu Video Indexeru platný a už se nepoužívá.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název účtu VideoIndexer.
type	True	Type	Typ prostředku Microsoft.VideoIndexer/accounts

Odpovědi

Name	Typ	Description
200 OK	CheckNameAvailabilityResult	OK – Operace pro kontrolu dostupnosti názvu účtu Video Indexeru proběhla úspěšně. Ok neznamená, že je název k dispozici, text odpovědi provede.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Check free account name availability

Check taken account name availability

Check free account name availability

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

{
  "nameAvailable": true
}

Check taken account name availability

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AccountCheckNameAvailabilityParameters	Parametry použité ke kontrole dostupnosti názvu účtu Video Indexeru.
CheckNameAvailabilityResult	Odpověď operace CheckNameAvailability.
ErrorDefinition	Definice chyby
ErrorResponse	Chybová odpověď.
Reason	Získá důvod, proč nelze použít název účtu Video Indexeru. Prvek Reason je vrácen pouze v případě, že NameAvailable je false.
Type	Typ prostředku Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Objekt

Parametry použité ke kontrole dostupnosti názvu účtu Video Indexeru.

Name	Typ	Description
name	string	Název účtu VideoIndexer.
type	Type	Typ prostředku Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Objekt

Odpověď operace CheckNameAvailability.

Name	Typ	Description
message	string	Získá chybovou zprávu vysvětlující hodnotu důvod podrobněji.
nameAvailable	boolean	Získá logickou hodnotu, která označuje, zda je název k dispozici pro použití. Pokud je hodnota true, název je k dispozici. Pokud je hodnota false, název už byl pořízen.
reason	Reason	Získá důvod, proč nelze použít název účtu Video Indexeru. Prvek Reason je vrácen pouze v případě, že NameAvailable je false.

ErrorDefinition

Objekt

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav kódu chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	ErrorDefinition	Podrobnosti o chybě.

Reason

Výčet

Získá důvod, proč nelze použít název účtu Video Indexeru. Prvek Reason je vrácen pouze v případě, že NameAvailable je false.

Hodnota	Description
AlreadyExists

Type

Výčet

Typ prostředku Microsoft.VideoIndexer/accounts

Hodnota	Description
Microsoft.VideoIndexer/accounts