通过

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

Check Name Availability - Namespaces - Check Name Availability

服务:
Event Hubs
API 版本:
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

事件中心错误响应，描述作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

NamespacesCheckNameAvailability

示例请求

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

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

示例响应

状态代码:
200 
{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

定义

名称 说明
CheckNameAvailabilityParameter

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

CheckNameAvailability作的结果
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

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

指定服务不可用的原因。

CheckNameAvailabilityParameter

Object

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

名称 类型 说明
name

string

用于检查命名空间名称可用性的名称

CheckNameAvailabilityResult

Object

CheckNameAvailability作的结果

名称 类型 说明
message

string

有关与命名空间关联的原因的详细信息。
nameAvailable

boolean

指示命名空间的可用性的值，如果命名空间可用，则为 true;否则为 false。
reason

UnavailableReason

命名空间不可用的原因。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

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

名称 类型 说明
error

ErrorDetail

错误对象。

UnavailableReason

枚举

指定服务不可用的原因。

值 说明
None
InvalidName
SubscriptionIsDisabled
NameInUse
NameInLockdown
TooManyNamespaceInCurrentSubscription