Accounts - Check Name Availability

Dienst:

Azure Video Indexer

API-Version:

2024-01-01

Überprüft, ob der Name des Video Indexer-Kontos gültig ist und noch nicht verwendet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name des VideoIndexer-Kontos.
type	True	Type	Der Ressourcentyp Microsoft.VideoIndexer/accounts

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResult	OK : Vorgang, um zu überprüfen, ob die Verfügbarkeit des Video Indexer-Kontonamens erfolgreich war. Ok gibt nicht an, dass der Name verfügbar ist, der Text der Antwort schon.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Check free account name availability

Check taken account name availability

Check free account name availability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

{
  "nameAvailable": true
}

Check taken account name availability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
AccountCheckNameAvailabilityParameters	Die Parameter, die verwendet werden, um die Verfügbarkeit des Video Indexer-Kontonamens zu überprüfen.
CheckNameAvailabilityResult	Die Antwort des CheckNameAvailability-Vorgangs.
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
Reason	Ruft den Grund ab, warum ein Video Indexer-Kontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.
Type	Der Ressourcentyp Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Die Parameter, die verwendet werden, um die Verfügbarkeit des Video Indexer-Kontonamens zu überprüfen.

Name	Typ	Beschreibung
name	string	Der Name des VideoIndexer-Kontos.
type	Type	Der Ressourcentyp Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Die Antwort des CheckNameAvailability-Vorgangs.

Name	Typ	Beschreibung
message	string	Ruft eine Fehlermeldung ab, in der der Reason-Wert ausführlicher erläutert wird.
nameAvailable	boolean	Ruft einen booleschen Wert ab, der angibt, ob der Name für Sie verfügbar ist. Wenn true, ist der Name verfügbar. Wenn false, wurde der Name bereits übernommen.
reason	Reason	Ruft den Grund ab, warum ein Video Indexer-Kontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.

ErrorDefinition

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	ErrorDefinition[]	Interne Fehlerdetails.
message	string	Beschreibung des Fehlers

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

Reason

Ruft den Grund ab, warum ein Video Indexer-Kontoname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.

Name	Typ	Beschreibung
AlreadyExists	string

Type

Der Ressourcentyp Microsoft.VideoIndexer/accounts

Name	Typ	Beschreibung
Microsoft.VideoIndexer/accounts	string