Accounts - Check Name Availability

Tjänst:

Azure Video Indexer

API-version:

2024-01-01

Kontrollerar att Video Indexer-kontonamnet är giltigt och inte redan används.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	VideoIndexer-kontonamnet.
type	True	Type	Typen av resurs, Microsoft.VideoIndexer/accounts

Svar

Name	Typ	Description
200 OK	CheckNameAvailabilityResult	OK – Åtgärden för att kontrollera tillgängligheten för Video Indexer-kontots namn lyckades. Ok anger inte att namnet är tillgängligt. Svarets brödtext gör det.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Check free account name availability

Check taken account name availability

Check free account name availability

Exempelbegäran

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

Exempelsvar

Statuskod:

200

{
  "nameAvailable": true
}

Check taken account name availability

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
AccountCheckNameAvailabilityParameters	De parametrar som används för att kontrollera tillgängligheten för Video Indexer-kontonamnet.
CheckNameAvailabilityResult	Åtgärdssvaret CheckNameAvailability.
ErrorDefinition	Feldefinition.
ErrorResponse	Felsvar.
Reason	Hämtar anledningen till att ett Video Indexer-kontonamn inte kunde användas. Reason-elementet returneras endast om NameAvailable är falskt.
Type	Typen av resurs, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

De parametrar som används för att kontrollera tillgängligheten för Video Indexer-kontonamnet.

Name	Typ	Description
name	string	VideoIndexer-kontonamnet.
type	Type	Typen av resurs, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Åtgärdssvaret CheckNameAvailability.

Name	Typ	Description
message	string	Får ett felmeddelande som förklarar värdet Orsak i detalj.
nameAvailable	boolean	Hämtar ett booleskt värde som anger om namnet är tillgängligt för dig att använda. Om det är sant är namnet tillgängligt. Om det är falskt har namnet redan tagits.
reason	Reason	Hämtar anledningen till att ett Video Indexer-kontonamn inte kunde användas. Reason-elementet returneras endast om NameAvailable är falskt.

ErrorDefinition

Feldefinition.

Name	Typ	Description
code	string	Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.
details	ErrorDefinition[]	Intern felinformation.
message	string	Beskrivning av felet.

ErrorResponse

Felsvar.

Name	Typ	Description
error	ErrorDefinition	Felinformationen.

Reason

Hämtar anledningen till att ett Video Indexer-kontonamn inte kunde användas. Reason-elementet returneras endast om NameAvailable är falskt.

Name	Typ	Description
AlreadyExists	string

Type

Typen av resurs, Microsoft.VideoIndexer/accounts

Name	Typ	Description
Microsoft.VideoIndexer/accounts	string