Servers - Check Name Availability

服務:: SQL Database

API 版本:: 2014-04-01

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

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	用來識別 Azure 訂閱的訂閱 ID。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	類型	Description
parameters	CheckNameAvailabilityRequest	請求名稱可用性的參數。

回應

名稱	類型	Description
200 OK	CheckNameAvailabilityResponse	OK

範例

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

範例要求

HTTP

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

範例回覆

狀態碼:: 200

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

Check for a server name that is available

範例要求

HTTP

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

範例回覆

狀態碼:: 200

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

Check for a server name that is invalid

範例要求

HTTP

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

範例回覆

狀態碼:: 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."
}

定義

名稱	Description
CheckNameAvailabilityReason	說明為何無法使用名稱的原因程序代碼。如果名稱可用，則為空。
CheckNameAvailabilityRequest	請求名稱可用性的參數。
CheckNameAvailabilityResourceType	可用性檢查範圍所使用的資源類型。
CheckNameAvailabilityResponse	一個回應，表示該資源的指定名稱是否可用。

CheckNameAvailabilityReason

列舉型別

說明為何無法使用名稱的原因程序代碼。如果名稱可用，則為空。

值	Description
Invalid
AlreadyExists

CheckNameAvailabilityRequest

Object

請求名稱可用性的參數。

名稱	類型	Description
name	string	需確認其可用性的名稱。
type	CheckNameAvailabilityResourceType	可用性檢查範圍所使用的資源類型。

CheckNameAvailabilityResourceType

列舉型別

可用性檢查範圍所使用的資源類型。

值	Description
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Object

一個回應，表示該資源的指定名稱是否可用。

名稱	類型	Description
available	boolean	如果名稱可用，則為 True，否則為 false。
message	string	說明名稱為何無法使用的訊息。如果名稱可用，則為空。
name	string	已檢查其可用性的名稱。
reason	CheckNameAvailabilityReason	說明為何無法使用名稱的原因程序代碼。如果名稱可用，則為空。