共用方式為


Iot Hub Resource - Check Name Availability

檢查 IoT 中樞名稱是否可用。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

URI 參數

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

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

要求本文

名稱 必要 類型 Description
name True

string

要檢查的IoT中樞名稱。

回應

名稱 類型 Description
200 OK

IotHubNameAvailabilityInfo

這是同步作業。 本文包含 JSON 串行化回應,指定 IoT 中樞名稱是否可用。 如果名稱無法使用,本文會包含原因。

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

IotHubResource_CheckNameAvailability

範例要求

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

{
  "name": "test-request"
}

範例回覆

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": ""
}

定義

名稱 Description
ErrorDetails

錯誤詳細數據。

IotHubNameAvailabilityInfo

屬性,指出指定的IoT中樞名稱是否可用。

IotHubNameUnavailabilityReason

無法使用的原因。

OperationInputs

輸入值。

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

IotHubNameAvailabilityInfo

屬性,指出指定的IoT中樞名稱是否可用。

名稱 類型 Description
message

string

詳細的原因訊息。

nameAvailable

boolean

值,指出提供的名稱是否可用。

reason

IotHubNameUnavailabilityReason

無法使用的原因。

IotHubNameUnavailabilityReason

無法使用的原因。

名稱 類型 Description
AlreadyExists

string

Invalid

string

OperationInputs

輸入值。

名稱 類型 Description
name

string

要檢查的IoT中樞名稱。