通过

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

Namespaces - Check Name Availability

服务:
Relay
API 版本:
2024-01-01

检查指定的命名空间名称可用性。

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

URI 参数

名称 在 必需 类型 说明
subscriptionId
 path True

string

minLength: 1

目标订阅的 ID。
api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

要检查可用性的命名空间名称。 命名空间名称只能包含字母、数字和连字符。 命名空间必须以字母开头，并且必须以字母或数字结尾。

响应

名称 类型 说明
200 OK

CheckNameAvailabilityResult

请求已成功。
Other Status Codes

ErrorResponse

意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

RelayCheckNameAvailability

示例请求

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/checkNameAvailability?api-version=2024-01-01

{
  "name": "example-RelayNamespace1321"
}

示例响应

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

定义

名称 说明
CheckNameAvailability

检查名称可用性请求属性的说明。
CheckNameAvailabilityResult

检查名称可用性请求属性的说明。
ErrorAdditionalInfo

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

错误详细信息。
ErrorResponse

错误响应
UnavailableReason

指定服务不可用的原因。

CheckNameAvailability

Object

检查名称可用性请求属性的说明。

名称 类型 说明
name

string

要检查可用性的命名空间名称。 命名空间名称只能包含字母、数字和连字符。 命名空间必须以字母开头，并且必须以字母或数字结尾。

CheckNameAvailabilityResult

Object

检查名称可用性请求属性的说明。

名称 类型 说明
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