你当前正在访问 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.NetApp/locations/{location}/checkNameAvailability?api-version=2019-07-01

URI 参数

名称 必需 类型 说明
location
path True

string

位置

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

请求正文

名称 必需 类型 说明
name True

string

要验证的资源名称。

resourceGroup True

string

资源组名称。

type True

CheckNameResourceTypes

用于验证的资源类型。

响应

名称 类型 说明
200 OK

ResourceNameAvailability

确定

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CheckNameAvailability

示例请求

POST https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetApp/locations/eastus/checkNameAvailability?api-version=2019-07-01

{
  "name": "accName",
  "type": "Microsoft.NetApp/netAppAccounts",
  "resourceGroup": "myrg"
}

示例响应

{
  "isAvailable": true
}

定义

名称 说明
CheckNameResourceTypes

用于验证的资源类型。

InAvailabilityReasonType

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

ResourceNameAvailability

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

ResourceNameAvailabilityRequest

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

CheckNameResourceTypes

用于验证的资源类型。

名称 类型 说明
Microsoft.NetApp/netAppAccounts

string

Microsoft.NetApp/netAppAccounts/capacityPools

string

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

string

Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots

string

InAvailabilityReasonType

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

名称 类型 说明
AlreadyExists

string

Invalid

string

ResourceNameAvailability

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

名称 类型 说明
isAvailable

boolean

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

message

string

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

reason

InAvailabilityReasonType

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

ResourceNameAvailabilityRequest

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

名称 类型 说明
name

string

要验证的资源名称。

resourceGroup

string

资源组名称。

type

CheckNameResourceTypes

用于验证的资源类型。