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

Namespaces - CheckNameAvailability - Check Name Availability

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

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

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Required Type Description
name True
  • string

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

响应

Name Type Description
200 OK

检查成功返回的可用性。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

NamespacesCheckNameAvailability

Sample Request

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

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

Sample Response

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

定义

CheckNameAvailabilityParameter

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

CheckNameAvailabilityResult

CheckNameAvailability 操作的结果

ErrorResponse

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

UnavailableReason

指定服务不可用的原因。

CheckNameAvailabilityParameter

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

Name Type Description
name
  • string

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

CheckNameAvailabilityResult

CheckNameAvailability 操作的结果

Name Type Description
message
  • string

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

nameAvailable
  • boolean

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

reason

命名空间不可用的原因。

ErrorResponse

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

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

UnavailableReason

指定服务不可用的原因。

Name Type Description
InvalidName
  • string
NameInLockdown
  • string
NameInUse
  • string
None
  • string
SubscriptionIsDisabled
  • string
TooManyNamespaceInCurrentSubscription
  • string