Iot Dps Resource - Check Provisioning Service Name Availability

服務:

IoT Hub Device Provisioning Service

API 版本:

2022-12-12

檢查布建服務名稱是否可用。 這會驗證名稱是否語法有效，以及名稱是否可用

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	訂用帳戶識別碼。
api-version	query	True	string	API 的版本。

要求本文

名稱	必要	類型	Description
name	True	string	要檢查的布建服務名稱。

回應

名稱	類型	Description
200 OK	NameAvailabilityInfo	這是同步作業。 本文包含 JSON 串行化的回應，指定布建服務名稱是否可用。 如果名稱無法使用，本文會包含原因。
Other Status Codes	ErrorDetails	默認錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

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

範例

DPSCheckName

範例要求

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

{
  "name": "test213123"
}

範例回覆

狀態碼:

200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": "name is valid"
}

定義

名稱	Description
ErrorDetails	錯誤詳細數據。
NameAvailabilityInfo	名稱可用性的描述。
NameUnavailabilityReason	指定名稱無法使用的原因
OperationInputs	作業結果呼叫的輸入值。

ErrorDetails

錯誤詳細數據。

名稱	類型	Description
code	integer	錯誤碼。
details	string	錯誤詳細資料。
httpStatusCode	string	HTTP 狀態碼。
message	string	錯誤訊息。

NameAvailabilityInfo

名稱可用性的描述。

名稱	類型	Description
message	string	包含詳細原因名稱的訊息無法使用
nameAvailable	boolean	指定名稱是否可用
reason	NameUnavailabilityReason	指定名稱無法使用的原因

NameUnavailabilityReason

指定名稱無法使用的原因

名稱	類型	Description
AlreadyExists	string
Invalid	string

OperationInputs

作業結果呼叫的輸入值。

名稱	類型	Description
name	string	要檢查的布建服務名稱。