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

SignalR - Check Name Availability

检查资源名称是否有效且尚未使用。

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

URI 参数

名称 必需 类型 说明
location
path True

string

区域

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

要验证的资源名称。 例如“my-resource-name”

type True

string

资源类型。 可以是“Microsoft.SignalRService/SignalR”、“Microsoft.SignalRService/WebPubSub”、“Microsoft.SignalRService/SignalR/replicas”或“Microsoft.SignalRService/WebPubSub/replicas”

响应

名称 类型 说明
200 OK

NameAvailability

成功。 响应描述名称可用性。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

SignalR_CheckNameAvailability

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/checkNameAvailability?api-version=2024-03-01

{
  "type": "Microsoft.SignalRService/SignalR",
  "name": "mySignalRService"
}

示例响应

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "The name is already taken. Please try a different name."
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

NameAvailability

请求检查名称可用性的结果。 它包含标志和可能的失败原因。

NameAvailabilityParameters

数据 POSTed 到 nameAvailability 操作

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

NameAvailability

请求检查名称可用性的结果。 它包含标志和可能的失败原因。

名称 类型 说明
message

string

操作的消息。

nameAvailable

boolean

指示名称是否可用。

reason

string

可用性的原因。 如果名称不可用,则为必需项。

NameAvailabilityParameters

数据 POSTed 到 nameAvailability 操作

名称 类型 说明
name

string

要验证的资源名称。 例如“my-resource-name”

type

string

资源类型。 可以是“Microsoft.SignalRService/SignalR”、“Microsoft.SignalRService/WebPubSub”、“Microsoft.SignalRService/SignalR/replicas”或“Microsoft.SignalRService/WebPubSub/replicas”