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

Check Domain Availability - Check Domain Availability

检查域是否可用。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability?api-version=2023-05-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
subdomainName True

string

要使用的子域名称。

type True

string

资源的类型。

kind

string

资源的类型。

响应

名称 类型 说明
200 OK

DomainAvailability

没问题。

Other Status Codes

ErrorResponse

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

示例

Check SKU Availability

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/checkDomainAvailability?api-version=2023-05-01

{
  "subdomainName": "contosodemoapp1",
  "type": "Microsoft.CognitiveServices/accounts"
}

Sample Response

{
  "isSubdomainAvailable": false,
  "reason": "Sub domain name 'contosodemoapp1' is not valid",
  "subdomainName": "contosodemoapp1",
  "type": "Microsoft.CognitiveServices/accounts"
}

定义

名称 说明
CheckDomainAvailabilityParameter

检查域可用性参数。

DomainAvailability

域可用性。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

CheckDomainAvailabilityParameter

检查域可用性参数。

名称 类型 说明
kind

string

资源的类型。

subdomainName

string

要使用的子域名称。

type

string

资源的类型。

DomainAvailability

域可用性。

名称 类型 说明
isSubdomainAvailable

boolean

指示给定的 SKU 可用或不可用。

kind

string

资源的类型。

reason

string

SKU 不可用的原因。

subdomainName

string

要使用的子域名称。

type

string

资源的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。