你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	目标订阅的 ID。
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

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	获取无法使用视频索引器帐户名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。
Type	资源类型，Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

用于检查视频索引器帐户名称的可用性的参数。

名称	类型	说明
name	string	VideoIndexer 帐户名称。
type	Type	资源类型，Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

CheckNameAvailability 操作响应。

名称	类型	说明
message	string	获取更详细地解释 Reason 值的错误消息。
nameAvailable	boolean	获取一个布尔值，该值指示名称是否可供你使用。 如果为 true，则名称可用。 如果为 false，则表示该名称已被采用。
reason	Reason	获取无法使用视频索引器帐户名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。

ErrorDefinition

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	ErrorDefinition[]	内部错误详细信息。
message	string	错误的说明。

ErrorResponse

错误响应。

名称	类型	说明
error	ErrorDefinition	错误详细信息。

Reason

获取无法使用视频索引器帐户名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。

名称	类型	说明
AlreadyExists	string

Type

资源类型，Microsoft.VideoIndexer/accounts

名称	类型	说明
Microsoft.VideoIndexer/accounts	string