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

Communication Services - Check Name Availability

检查名称可用性
检查 CommunicationService 名称是否有效且尚未使用。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

uuid

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

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

需要检查其可用性的资源的名称。

type True

string

资源类型。

响应

名称 类型 说明
200 OK

CheckNameAvailabilityResponse

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

Other Status Codes

ErrorResponse

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

示例

Check name availability available
Check name availability unavailable

Check name availability available

示例请求

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

示例响应

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

示例请求

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-03-31

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

示例响应

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

定义

名称 说明
CheckNameAvailabilityReason

给定名称不可用的原因。

CheckNameAvailabilityResponse

检查可用性结果。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

NameAvailabilityParameters

发布到 nameAvailability 操作的数据

CheckNameAvailabilityReason

给定名称不可用的原因。

名称 类型 说明
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

检查可用性结果。

名称 类型 说明
message

string

给定名称可用的详细原因。

nameAvailable

boolean

指示资源名称是否可用。

reason

CheckNameAvailabilityReason

给定名称不可用的原因。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

NameAvailabilityParameters

发布到 nameAvailability 操作的数据

名称 类型 说明
name

string

需要检查其可用性的资源的名称。

type

string

资源类型。