Accounts - Check Name Availability

Service:

Azure Video Indexer

API-versie:

2024-01-01

Controleert of de naam van het Video Indexer-account geldig is en nog niet in gebruik is.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van het VideoIndexer-account.
type	True	Type	Het type resource, Microsoft.VideoIndexer/accounts

Antwoorden

Name	Type	Description
200 OK	CheckNameAvailabilityResult	OK: bewerking om te controleren of de beschikbaarheid van de Video Indexer-accountnaam is geslaagd. Ok geeft niet aan dat de naam beschikbaar is, de hoofdtekst van het antwoord wel.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Check free account name availability

Check taken account name availability

Check free account name availability

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

{
  "nameAvailable": true
}

Check taken account name availability

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
AccountCheckNameAvailabilityParameters	De parameters die worden gebruikt om de beschikbaarheid van de Video Indexer-accountnaam te controleren.
CheckNameAvailabilityResult	Het antwoord van de bewerking CheckNameAvailability.
ErrorDefinition	Foutdefinitie.
ErrorResponse	Foutreactie.
Reason	Hiermee wordt de reden ophaalt dat de naam van een Video Indexer-account niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.
Type	Het type resource, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

De parameters die worden gebruikt om de beschikbaarheid van de Video Indexer-accountnaam te controleren.

Name	Type	Description
name	string	De naam van het VideoIndexer-account.
type	Type	Het type resource, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Het antwoord van de bewerking CheckNameAvailability.

Name	Type	Description
message	string	Er wordt een foutbericht weergegeven waarin de redenwaarde gedetailleerder wordt uitgelegd.
nameAvailable	boolean	Hiermee wordt een booleaanse waarde opgehaald die aangeeft of de naam beschikbaar is voor gebruik. Als waar is, is de naam beschikbaar. Als onwaar is, is de naam al in gebruik.
reason	Reason	Hiermee wordt de reden ophaalt dat de naam van een Video Indexer-account niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.

ErrorDefinition

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	ErrorDefinition[]	Interne foutdetails.
message	string	Beschrijving van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	ErrorDefinition	De foutdetails.

Reason

Hiermee wordt de reden ophaalt dat de naam van een Video Indexer-account niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.

Name	Type	Description
AlreadyExists	string

Type

Het type resource, Microsoft.VideoIndexer/accounts

Name	Type	Description
Microsoft.VideoIndexer/accounts	string