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

Check Name Availability - Check Name Availability

有关检查资源名称是否可用的说明。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability?api-version=2022-03-01

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

Azure 订阅 ID。 这是 GUID 格式的字符串, (例如 000000000-0000-0000-0000-00000000000000) 。

api-version
query True
  • string

API 版本

请求正文

Name Required Type Description
name True
  • string

要验证的资源名称。

type True

用于验证的资源类型。

isFqdn
  • boolean

是完全限定的域名。

响应

Name Type Description
200 OK

确定

Other Status Codes

App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

定义

CheckNameResourceTypes

用于验证的资源类型。

DefaultErrorResponse

App 服务错误响应。

Details
Error

错误模型。

InAvailabilityReasonType

Invalid指示提供的名称与Azure 应用服务命名要求不匹配。 AlreadyExists 指示名称已在使用中,因此不可用。

ResourceNameAvailability

有关资源名称可用性的信息。

ResourceNameAvailabilityRequest

资源名称可用性请求内容。

CheckNameResourceTypes

用于验证的资源类型。

Name Type Description
HostingEnvironment
  • string
Microsoft.Web/hostingEnvironments
  • string
Microsoft.Web/publishingUsers
  • string
Microsoft.Web/sites
  • string
Microsoft.Web/sites/slots
  • string
PublishingUser
  • string
Site
  • string
Slot
  • string

DefaultErrorResponse

App 服务错误响应。

Name Type Description
error

错误模型。

Details

Name Type Description
code
  • string

标准化字符串以编程方式标识错误。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

Error

错误模型。

Name Type Description
code
  • string

标准化字符串以编程方式标识错误。

details

详细错误。

innererror
  • string

有关调试错误的详细信息。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

InAvailabilityReasonType

Invalid指示提供的名称与Azure 应用服务命名要求不匹配。 AlreadyExists 指示名称已在使用中,因此不可用。

Name Type Description
AlreadyExists
  • string
Invalid
  • string

ResourceNameAvailability

有关资源名称可用性的信息。

Name Type Description
message
  • string

如果 reason == 无效,请向用户提供给定名称无效的原因,并提供资源命名要求,以便用户可以选择有效的名称。 如果原因 == AlreadyExists,请解释资源名称已在使用中,并指示它们选择其他名称。

nameAvailable
  • boolean

true 指示名称有效且可用。 false 指示名称无效、不可用或两者均无效。

reason

Invalid指示提供的名称与Azure 应用服务命名要求不匹配。 AlreadyExists 指示名称已在使用中,因此不可用。

ResourceNameAvailabilityRequest

资源名称可用性请求内容。

Name Type Description
isFqdn
  • boolean

是完全限定的域名。

name
  • string

要验证的资源名称。

type

用于验证的资源类型。