Accounts - Check Name Availability

Service:

Azure Video Indexer

API Version:

2024-01-01

Verifica che il nome dell'account Video Indexer sia valido e non sia già in uso.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Nome dell'account VideoIndexer.
type	True	Type	Tipo di risorsa, Microsoft.VideoIndexer/accounts

Risposte

Nome	Tipo	Descrizione
200 OK	CheckNameAvailabilityResult	OK- Operazione per verificare che la disponibilità del nome dell'account Video Indexer sia riuscita. Ok non indica che il nome è disponibile, il corpo della risposta lo fa.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Check free account name availability

Check taken account name availability

Check free account name availability

Sample Request

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

Sample Response

Status code:

200

{
  "nameAvailable": true
}

Check taken account name availability

Sample Request

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

Sample Response

Status code:

200

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

Definizioni

Nome	Descrizione
AccountCheckNameAvailabilityParameters	I parametri usati per controllare la disponibilità del nome dell'account Video Indexer.
CheckNameAvailabilityResult	Risposta dell'operazione CheckNameAvailability.
ErrorDefinition	Definizione di errore.
ErrorResponse	Risposta di errore.
Reason	Ottiene il motivo per cui non è stato possibile usare un nome dell'account Video Indexer. L'elemento Reason viene restituito solo se NameAvailable è false.
Type	Tipo di risorsa, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

I parametri usati per controllare la disponibilità del nome dell'account Video Indexer.

Nome	Tipo	Descrizione
name	string	Nome dell'account VideoIndexer.
type	Type	Tipo di risorsa, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Risposta dell'operazione CheckNameAvailability.

Nome	Tipo	Descrizione
message	string	Ottiene un messaggio di errore che spiega il valore Motivo in modo più dettagliato.
nameAvailable	boolean	Ottiene un valore booleano che indica se il nome è disponibile per l'uso. Se true, il nome è disponibile. Se false, il nome è già stato preso.
reason	Reason	Ottiene il motivo per cui non è stato possibile usare un nome dell'account Video Indexer. L'elemento Reason viene restituito solo se NameAvailable è false.

ErrorDefinition

Definizione di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico del servizio che funge da sottostatus per il codice di errore HTTP.
details	ErrorDefinition[]	Dettagli dell'errore interno.
message	string	Descrizione dell'errore.

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	ErrorDefinition	Dettagli dell'errore.

Reason

Ottiene il motivo per cui non è stato possibile usare un nome dell'account Video Indexer. L'elemento Reason viene restituito solo se NameAvailable è false.

Nome	Tipo	Descrizione
AlreadyExists	string

Type

Tipo di risorsa, Microsoft.VideoIndexer/accounts

Nome	Tipo	Descrizione
Microsoft.VideoIndexer/accounts	string