共用方式為


Servers - Check Name Availability

判斷是否可以使用指定的名稱建立資源。

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

URI 參數

名稱 位於 必要 類型 Description
subscriptionId
path True

string

識別 Azure 訂用帳戶的訂用帳戶標識碼。

api-version
query True

string

要用於要求的 API 版本。

要求本文

名稱 必要 類型 Description
name True

string

type True

CheckNameAvailabilityResourceType

回應

名稱 類型 Description
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"
}

範例回覆

{
  "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"
}

範例回覆

{
  "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"
}

範例回覆

{
  "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."
}

定義

名稱 Description
CheckNameAvailabilityReason

說明為何無法使用名稱的原因程序代碼。 如果名稱可用,則不會定義。

CheckNameAvailabilityRequest

檢查資源指定名稱是否可用的要求。

CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse

名稱可用性檢查的結果。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

CheckNameAvailabilityReason

說明為何無法使用名稱的原因程序代碼。 如果名稱可用,則不會定義。

Description
Invalid
AlreadyExists

CheckNameAvailabilityRequest

檢查資源指定名稱是否可用的要求。

名稱 類型 Description
name

string

type

CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Description
Microsoft.Sql/servers

CheckNameAvailabilityResponse

名稱可用性檢查的結果。

名稱 類型 Description
available

boolean

如果名稱可用,則為 True,否則為 false。

message

string

說明名稱為何無法使用的訊息。 如果名稱可用,則不會定義。

name

string

已檢查其可用性的名稱。

reason

CheckNameAvailabilityReason

說明為何無法使用名稱的原因程序代碼。 如果名稱可用,則不會定義。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。