通过

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

Servers - Check Name Availability

  • 参考
服务:
SQL Database
API 版本:
2023-08-01

确定是否可以使用指定名称创建资源。

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

URI 参数

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

string

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

string

要用于请求的 API 版本。

请求正文

名称 必需 类型 说明
name True

string

type True

CheckNameAvailabilityResourceType

响应

名称 类型 说明
200 OK

CheckNameAvailabilityResponse

成功完成可用性检查。
Other Status Codes

ErrorResponse

错误响应： ***

  • 400 InvalidNameAvailabilityRequest - 检查名称可用性请求无效。

  • 400 UnknownNameType - 为订阅级别名称可用性检查指定的未知资源类型。

示例

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

示例请求

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

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

示例响应

状态代码:
200 
{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

示例请求

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

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

示例响应

状态代码:
200 
{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

示例请求

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

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

示例响应

状态代码:
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

说明名称不可用的原因代码。 如果名称可用，则不会定义。
CheckNameAvailabilityRequest

一个请求，用于检查资源的指定名称是否可用。
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse

名称可用性检查的结果。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应

CheckNameAvailabilityReason

枚举

说明名称不可用的原因代码。 如果名称可用，则不会定义。

值 说明
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Object

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

名称 类型 说明
name

string

type

CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

枚举
值 说明
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Object

名称可用性检查的结果。

名称 类型 说明
available

boolean

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

string

说明名称不可用的原因的消息。 如果名称可用，则不会定义。
name

string

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

CheckNameAvailabilityReason

说明名称不可用的原因代码。 如果名称可用，则不会定义。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。