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

Servers - Name Availability - Check Name Availability

  • 参考
Service:
SQL Database
API Version:
2014-04-01

判断是否能使用指定名称创建资源。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01

URI 参数

名称 在 必需 类型 说明
subscriptionId
 path True

string

用于标识 Azure 订阅的订阅 ID。
api-version
 query True

string

要用于请求的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

要检查其可用性的名称。
type True

CheckNameAvailabilityResourceType

用作可用性检查范围的资源类型。

响应

名称 类型 说明
200 OK

CheckNameAvailabilityResponse

确定

示例

Check for a server name that already exists
Check for a server name that is available
Check for a server name that is invalid

Check for a server name that already exists

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Sample Response

Status code:
200 
{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Sample Response

Status code:
200 
{
  "name": "server1",
  "available": true,
  "reason": null,
  "message": null
}

Check for a server name that is invalid

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Sample Response

Status code:
200 
{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character."
}

定义

名称 说明
CheckNameAvailabilityReason

解释名称不可用的原因代码。 如果该名称可用，则为 null。
CheckNameAvailabilityRequest

请求检查资源的指定名称是否可用。
CheckNameAvailabilityResourceType

用作可用性检查范围的资源类型。
CheckNameAvailabilityResponse

一个响应，指示资源的指定名称是否可用。

CheckNameAvailabilityReason

解释名称不可用的原因代码。 如果该名称可用，则为 null。

名称 类型 说明
AlreadyExists

string

Invalid

string

CheckNameAvailabilityRequest

请求检查资源的指定名称是否可用。

名称 类型 说明
name

string

要检查其可用性的名称。
type

CheckNameAvailabilityResourceType

用作可用性检查范围的资源类型。

CheckNameAvailabilityResourceType

用作可用性检查范围的资源类型。

名称 类型 说明
Microsoft.Sql/servers

string

CheckNameAvailabilityResponse

一个响应，指示资源的指定名称是否可用。

名称 类型 说明
available

boolean

如果名称可用，则为 True，否则为 false。
message

string

说明名称不可用的原因的消息。 如果该名称可用，则为 null。
name

string

已检查其可用性的名称。
reason

CheckNameAvailabilityReason

解释名称不可用的原因代码。 如果该名称可用，则为 null。