共用方式為


Communication Services - Check Name Availability

檢查名稱可用性
檢查 CommunicationService 名稱是否有效,且尚未使用中。

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

URI 參數

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

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

要用於這項作業的 API 版本。

要求本文

名稱 必要 類型 Description
name True

string

需要檢查可用性的資源名稱。

type True

string

資源類型。

回應

名稱 類型 Description
200 OK

CheckNameAvailabilityResponse

成功。 回應描述名稱可用性。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

範例

Check name availability available
Check name availability unavailable

Check name availability available

範例要求

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

範例回覆

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

範例要求

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

範例回覆

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

定義

名稱 Description
CheckNameAvailabilityReason

指定名稱無法使用的原因。

CheckNameAvailabilityResponse

檢查可用性結果。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

NameAvailabilityParameters

Data POST-ed 至 nameAvailability 動作

CheckNameAvailabilityReason

指定名稱無法使用的原因。

名稱 類型 Description
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

檢查可用性結果。

名稱 類型 Description
message

string

提供指定名稱的詳細原因。

nameAvailable

boolean

指出資源名稱是否可用。

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 物件。

NameAvailabilityParameters

Data POST-ed 至 nameAvailability 動作

名稱 類型 Description
name

string

需要檢查可用性的資源名稱。

type

string

資源類型。