Accounts - Check Name Availability

Service:

Azure Video Indexer

Version d'API:

2024-01-01

Vérifie que le nom du compte Video Indexer est valide et qu’il n’est pas déjà utilisé.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du compte VideoIndexer.
type	True	Type	Type de ressource, Microsoft.VideoIndexer/accounts

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityResult	OK : l’opération de case activée la disponibilité du nom du compte Video Indexer a réussi. Ok n’indique pas que le nom est disponible, mais que le corps de la réponse le fait.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Check free account name availability

Check taken account name availability

Check free account name availability

Exemple de requête

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

Exemple de réponse

Code d’état:

200

{
  "nameAvailable": true
}

Check taken account name availability

Exemple de requête

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
AccountCheckNameAvailabilityParameters	Les paramètres utilisés pour case activée la disponibilité du nom du compte Video Indexer.
CheckNameAvailabilityResult	Réponse de l’opération CheckNameAvailability.
ErrorDefinition	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
Reason	Obtient la raison pour laquelle un nom de compte Video Indexer n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false.
Type	Type de ressource, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Les paramètres utilisés pour case activée la disponibilité du nom du compte Video Indexer.

Nom	Type	Description
name	string	Nom du compte VideoIndexer.
type	Type	Type de ressource, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Réponse de l’opération CheckNameAvailability.

Nom	Type	Description
message	string	Obtient un message d’erreur expliquant plus en détail la valeur Reason.
nameAvailable	boolean	Obtient une valeur booléenne qui indique si le nom est disponible. Si la valeur est true, le nom est disponible. Si la valeur est false, le nom a déjà été pris.
reason	Reason	Obtient la raison pour laquelle un nom de compte Video Indexer n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false.

ErrorDefinition

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	ErrorDefinition[]	Détails de l’erreur interne.
message	string	Description de l'erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	ErrorDefinition	Détails de l’erreur.

Reason

Obtient la raison pour laquelle un nom de compte Video Indexer n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false.

Nom	Type	Description
AlreadyExists	string

Type

Type de ressource, Microsoft.VideoIndexer/accounts

Nom	Type	Description
Microsoft.VideoIndexer/accounts	string