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

AFD Profiles - Check Host Name Availability

验证自定义域映射,确保它映射到 DNS 中的正确 Azure Front Door 终结点。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability?api-version=2023-05-01

URI 参数

名称 必需 类型 说明
profileName
path True

string

资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称。

resourceGroupName
path True

string

Azure 订阅中的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure 订阅 ID。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。 当前版本为 2023-05-01。

请求正文

名称 必需 类型 说明
hostName True

string

要验证的主机名。

响应

名称 类型 说明
200 OK

CheckNameAvailabilityOutput

没问题。 请求已成功。

Other Status Codes

AfdErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

AFDProfiles_CheckHostNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/checkHostNameAvailability?api-version=2023-05-01

{
  "hostName": "www.someDomain.net"
}

Sample Response

{
  "nameAvailable": false,
  "reason": "Conflict",
  "message": "The hostname 'www.someDomain.net' is already owned by another profile."
}

定义

名称 说明
AfdErrorResponse

错误响应

CheckHostNameAvailabilityInput

CheckHostNameAvailability API 的输入。

CheckNameAvailabilityOutput

检查名称可用性 API 的输出。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

AfdErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

CheckHostNameAvailabilityInput

CheckHostNameAvailability API 的输入。

名称 类型 说明
hostName

string

要验证的主机名。

CheckNameAvailabilityOutput

检查名称可用性 API 的输出。

名称 类型 说明
message

string

描述名称不可用的原因的详细错误消息。

nameAvailable

boolean

指示名称是否可用。

reason

string

名称不可用的原因。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。