Accounts - Check Name Availability

Serviço:

Azure Video Indexer

Versão da API:

2025-01-01

Verifica se o nome da conta do Video Indexer é válido e ainda não está em uso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome da conta VideoIndexer.
type	True	Type	O tipo de recurso, Microsoft.VideoIndexer/accounts

Respostas

Name	Tipo	Description
200 OK	CheckNameAvailabilityResult	OK - A operação para verificar a disponibilidade do nome da conta do Video Indexer foi bem-sucedida. Ok não indica que o nome está disponível, o corpo da resposta sim.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Check free account name availability

Check taken account name availability

Check free account name availability

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

{
  "nameAvailable": true
}

Check taken account name availability

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
AccountCheckNameAvailabilityParameters	Os parâmetros usados para verificar a disponibilidade do nome da conta Video Indexer.
CheckNameAvailabilityResult	A resposta da operação CheckNameAvailability.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
Reason	Obtém o motivo pelo qual um nome de conta do Video Indexer não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.
Type	O tipo de recurso, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Object

Os parâmetros usados para verificar a disponibilidade do nome da conta Video Indexer.

Name	Tipo	Description
name	string	O nome da conta VideoIndexer.
type	Type	O tipo de recurso, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Object

A resposta da operação CheckNameAvailability.

Name	Tipo	Description
message	string	Obtém uma mensagem de erro explicando o valor Reason com mais detalhes.
nameAvailable	boolean	Obtém um valor booleano que indica se o nome está disponível para uso. Se verdadeiro, o nome está disponível. Se falso, o nome já foi tirado.
reason	Reason	Obtém o motivo pelo qual um nome de conta do Video Indexer não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

ErrorDefinition

Object

Definição de erro.

Name	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes do erro interno.
message	string	Descrição do erro.

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

Reason

Enumeration

Obtém o motivo pelo qual um nome de conta do Video Indexer não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

Valor	Description
AlreadyExists

Type

Enumeration

O tipo de recurso, Microsoft.VideoIndexer/accounts

Valor	Description
Microsoft.VideoIndexer/accounts