Accounts - Check Name Availability

Serviço:

Azure Video Indexer

Versão da API:

2024-01-01

Verifica se o nome da conta do Video Indexer é válido e ainda não está a ser utilizado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar 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 - Operação para verificar se a disponibilidade do nome da conta do Video Indexer foi efetuada com êxito. Ok não indica que o nome está disponível, o corpo da resposta indica.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar 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=2024-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=2024-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 utilizados para verificar a disponibilidade do nome da conta do 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 não foi possível utilizar um nome de conta do Video Indexer. O elemento Motivo só é devolvido se Nome Disponível for falso.
Type	O tipo de recurso, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

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

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

CheckNameAvailabilityResult

A resposta da operação CheckNameAvailability.

Name	Tipo	Description
message	string	Recebe uma mensagem de erro a explicar o valor Motivo mais detalhadamente.
nameAvailable	boolean	Obtém um valor booleano que indica se o nome está disponível para utilização. Se for verdadeiro, o nome está disponível. Se for falso, o nome já foi tomado.
reason	Reason	Obtém o motivo pelo qual não foi possível utilizar um nome de conta do Video Indexer. O elemento Motivo só é devolvido se Nome Disponível for falso.

ErrorDefinition

Definição de erro.

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

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

Reason

Obtém o motivo pelo qual não foi possível utilizar um nome de conta do Video Indexer. O elemento Motivo só é devolvido se Nome Disponível for falso.

Name	Tipo	Description
AlreadyExists	string

Type

O tipo de recurso, Microsoft.VideoIndexer/accounts

Name	Tipo	Description
Microsoft.VideoIndexer/accounts	string