Accounts - Check Name Availability

Servicio:

Azure Video Indexer

Versión de la API:

2024-01-01

Comprueba que el nombre de la cuenta de Video Indexer es válido y que aún no está en uso.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre de la cuenta de VideoIndexer.
type	True	Type	Tipo de recurso, Microsoft.VideoIndexer/accounts

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityResult	Aceptar: operación para comprobar que la disponibilidad del nombre de la cuenta de Video Indexer se realizó correctamente. Ok no indica que el nombre está disponible, lo hace el cuerpo de la respuesta.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Check free account name availability

Check taken account name availability

Check free account name availability

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

{
  "nameAvailable": true
}

Check taken account name availability

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AccountCheckNameAvailabilityParameters	Parámetros usados para comprobar la disponibilidad del nombre de la cuenta de Video Indexer.
CheckNameAvailabilityResult	Respuesta de la operación CheckNameAvailability.
ErrorDefinition	Definición de error.
ErrorResponse	Respuesta de error.
Reason	Obtiene el motivo por el que no se pudo usar un nombre de cuenta de Video Indexer. El elemento Reason solo se devuelve si NameAvailable es false.
Type	Tipo de recurso, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Parámetros usados para comprobar la disponibilidad del nombre de la cuenta de Video Indexer.

Nombre	Tipo	Description
name	string	Nombre de la cuenta de VideoIndexer.
type	Type	Tipo de recurso, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Respuesta de la operación CheckNameAvailability.

Nombre	Tipo	Description
message	string	Obtiene un mensaje de error que explica el valor reason con más detalle.
nameAvailable	boolean	Obtiene un valor booleano que indica si el nombre está disponible para su uso. Si es true, el nombre está disponible. Si es false, ya se ha tomado el nombre.
reason	Reason	Obtiene el motivo por el que no se pudo usar un nombre de cuenta de Video Indexer. El elemento Reason solo se devuelve si NameAvailable es false.

ErrorDefinition

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	ErrorDefinition[]	Detalles internos del error.
message	string	Descripción del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	ErrorDefinition	Los detalles del error.

Reason

Obtiene el motivo por el que no se pudo usar un nombre de cuenta de Video Indexer. El elemento Reason solo se devuelve si NameAvailable es false.

Nombre	Tipo	Description
AlreadyExists	string

Type

Tipo de recurso, Microsoft.VideoIndexer/accounts

Nombre	Tipo	Description
Microsoft.VideoIndexer/accounts	string