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

Check Name Availability - Namespaces - Check Name Availability

参考

Service:: Event Hubs

API Version:: 2024-01-01

检查为命名空间名称提供可用性。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	必需	类型	说明
name	True	string	用于检查命名空间名称可用性的名称

响应

名称	类型	说明
200 OK	CheckNameAvailabilityResult	检查成功返回可用性。
Other Status Codes	ErrorResponse	描述操作失败原因的 Eventhub 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

NamespacesCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.EventHub/checkNameAvailability?api-version=2024-01-01

{
  "name": "sdk-Namespace-8458"
}

Sample Response

Status code:: 200

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

定义

名称	说明
CheckNameAvailabilityParameter	提供给检查命名空间名称可用性操作的参数
CheckNameAvailabilityResult	CheckNameAvailability 操作的结果
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应指示事件中心服务无法处理传入请求。错误消息中提供了原因。
UnavailableReason	指定服务不可用的原因。

CheckNameAvailabilityParameter

提供给检查命名空间名称可用性操作的参数

名称	类型	说明
name	string	用于检查命名空间名称可用性的名称

CheckNameAvailabilityResult

CheckNameAvailability 操作的结果

名称	类型	说明
message	string	有关与命名空间关联的原因的详细信息。
nameAvailable	boolean	指示命名空间为可用性的值，如果命名空间可用，则为 true;否则为 false。
reason	UnavailableReason	命名空间不可用的原因。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应指示事件中心服务无法处理传入请求。错误消息中提供了原因。

名称	类型	说明
error	ErrorDetail	错误对象。

UnavailableReason

指定服务不可用的原因。

名称	类型	说明
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string

Share via