Accounts - Check Name Availability

Служба:

Azure Video Indexer

Версия API:

2024-01-01

Проверяет, является ли имя учетной записи Индексатора видео допустимым и еще не используется.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя учетной записи VideoIndexer.
type	True	Type	Тип ресурса Microsoft.VideoIndexer/accounts

Ответы

Имя	Тип	Описание
200 OK	CheckNameAvailabilityResult	ОК. Операция проверка доступности имени учетной записи Индексатора видео выполнена успешно. Ок не указывает, что имя доступно, это делает текст ответа.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Check free account name availability

Check taken account name availability

Check free account name availability

Образец запроса

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

Пример ответа

Код состояния:

200

{
  "nameAvailable": true
}

Check taken account name availability

Образец запроса

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

Пример ответа

Код состояния:

200

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

Определения

Имя	Описание
AccountCheckNameAvailabilityParameters	Параметры, используемые для проверка доступности имени учетной записи Индексатора видео.
CheckNameAvailabilityResult	Ответ операции CheckNameAvailability.
ErrorDefinition	Определение ошибки.
ErrorResponse	Ответ об ошибке.
Reason	Возвращает причину, по которой не удалось использовать имя учетной записи Индексатора видео. Элемент Reason возвращается, только если NameAvailable имеет значение false.
Type	Тип ресурса Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Параметры, используемые для проверка доступности имени учетной записи Индексатора видео.

Имя	Тип	Описание
name	string	Имя учетной записи VideoIndexer.
type	Type	Тип ресурса Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Ответ операции CheckNameAvailability.

Имя	Тип	Описание
message	string	Возвращает сообщение об ошибке, объясняющее значение Причины более подробно.
nameAvailable	boolean	Возвращает логическое значение, указывающее, доступно ли имя для использования. Если задано значение true, имя доступно. Если значение равно false, имя уже взято.
reason	Reason	Возвращает причину, по которой не удалось использовать имя учетной записи Индексатора видео. Элемент Reason возвращается, только если NameAvailable имеет значение false.

ErrorDefinition

Определение ошибки.

Имя	Тип	Описание
code	string	Код ошибки службы, который служит подсостояние для кода ошибки HTTP.
details	ErrorDefinition[]	Сведения о внутренней ошибке.
message	string	Описание ошибки.

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
error	ErrorDefinition	Сведения об ошибке.

Reason

Возвращает причину, по которой не удалось использовать имя учетной записи Индексатора видео. Элемент Reason возвращается, только если NameAvailable имеет значение false.

Имя	Тип	Описание
AlreadyExists	string

Type

Тип ресурса Microsoft.VideoIndexer/accounts

Имя	Тип	Описание
Microsoft.VideoIndexer/accounts	string