你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Check Front Door Name Availability - Check Front Door Name Availability
检查 Front Door 资源名称的可用性。
POST https://management.azure.com/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2019-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
name | True |
string |
要验证的资源名称。 |
type | True |
要验证其名称的资源的类型。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 请求已成功。 |
|
Other Status Codes |
描述操作失败原因的 Front Door 错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
CheckNameAvailability
Sample Request
POST https://management.azure.com/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2019-05-01
{
"name": "sampleName",
"type": "Microsoft.Network/frontDoors"
}
Sample Response
{
"nameAvailability": "Unavailable",
"reason": "Name is already in use",
"message": "Name not available"
}
定义
名称 | 说明 |
---|---|
Availability |
指示名称是否可用。 |
Check |
CheckNameAvailability API 的输入。 |
Check |
检查名称可用性 API 的输出。 |
Error |
错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。 |
Resource |
CheckNameAvailability 中使用的 Front Door 资源的类型。 |
Availability
指示名称是否可用。
名称 | 类型 | 说明 |
---|---|---|
Available |
string |
|
Unavailable |
string |
CheckNameAvailabilityInput
CheckNameAvailability API 的输入。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
要验证的资源名称。 |
type |
要验证其名称的资源的类型。 |
CheckNameAvailabilityOutput
检查名称可用性 API 的输出。
名称 | 类型 | 说明 |
---|---|---|
message |
string |
描述名称不可用的原因的详细错误消息。 |
nameAvailability |
指示名称是否可用。 |
|
reason |
string |
名称不可用的原因。 |
ErrorResponse
错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
指示操作失败原因的错误消息。 |
ResourceType
CheckNameAvailability 中使用的 Front Door 资源的类型。
名称 | 类型 | 说明 |
---|---|---|
Microsoft.Network/frontDoors |
string |
|
Microsoft.Network/frontDoors/frontendEndpoints |
string |