Iot Hub Resource - Import Devices
從 Blob 匯入、更新或刪除 IoT 中樞身分識別登錄中的裝置身分識別。 如需詳細資訊,請參閱:https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities \(英文\)。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices?api-version=2023-06-30
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
包含IoT中樞的資源組名。 |
resource
|
path | True |
string |
IoT 中樞的名稱。 |
subscription
|
path | True |
string |
訂用帳戶識別碼。 |
api-version
|
query | True |
string |
API 的版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
inputBlobContainerUri | True |
string |
輸入 Blob 容器 URI。 |
outputBlobContainerUri | True |
string |
輸出 Blob 容器 URI。 |
authenticationType |
指定用於連線到記憶體帳戶的驗證類型。 |
||
configurationsBlobName |
string |
從提供的輸入 Blob 容器匯入組態時要使用的 Blob 名稱。 |
|
identity |
用於匯入裝置之記憶體端點的受控識別屬性。 |
||
includeConfigurations |
boolean |
值,指出是否應該匯入組態。 |
|
inputBlobName |
string |
從提供的輸入 Blob 容器匯入時要使用的 Blob 名稱。 |
|
outputBlobName |
string |
用來儲存匯入作業狀態的 Blob 名稱。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
DefaultErrorResponse |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
IotHubResource_ImportDevices
範例要求
POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/importDevices?api-version=2023-06-30
{
"inputBlobContainerUri": "testBlob",
"outputBlobContainerUri": "testBlob"
}
範例回覆
{
"jobId": "test",
"startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
"endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
"type": "unknown",
"status": "unknown"
}
定義
名稱 | Description |
---|---|
Authentication |
指定用於連線到記憶體帳戶的驗證類型。 |
Error |
錯誤詳細數據。 |
Import |
在要求匯入中樞中的所有裝置時,使用 提供參數。 |
Job |
Job Response 對象的屬性。 |
Job |
工作的狀態。 |
Job |
作業的類型。 |
Managed |
受控識別的屬性。 |
AuthenticationType
指定用於連線到記憶體帳戶的驗證類型。
名稱 | 類型 | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
ErrorDetails
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
string |
錯誤詳細資料。 |
httpStatusCode |
string |
HTTP 狀態碼。 |
message |
string |
錯誤訊息。 |
ImportDevicesRequest
在要求匯入中樞中的所有裝置時,使用 提供參數。
名稱 | 類型 | Description |
---|---|---|
authenticationType |
指定用於連線到記憶體帳戶的驗證類型。 |
|
configurationsBlobName |
string |
從提供的輸入 Blob 容器匯入組態時要使用的 Blob 名稱。 |
identity |
用於匯入裝置之記憶體端點的受控識別屬性。 |
|
includeConfigurations |
boolean |
值,指出是否應該匯入組態。 |
inputBlobContainerUri |
string |
輸入 Blob 容器 URI。 |
inputBlobName |
string |
從提供的輸入 Blob 容器匯入時要使用的 Blob 名稱。 |
outputBlobContainerUri |
string |
輸出 Blob 容器 URI。 |
outputBlobName |
string |
用來儲存匯入作業狀態的 Blob 名稱。 |
JobResponse
Job Response 對象的屬性。
名稱 | 類型 | Description |
---|---|---|
endTimeUtc |
string |
作業停止處理的時間。 |
failureReason |
string |
如果 status == 失敗,則此字串包含失敗的原因。 |
jobId |
string |
作業識別碼。 |
parentJobId |
string |
父作業的作業標識碼,如果有的話。 |
startTimeUtc |
string |
工作的開始時間。 |
status |
工作的狀態。 |
|
statusMessage |
string |
作業的狀態消息。 |
type |
作業的類型。 |
JobStatus
工作的狀態。
名稱 | 類型 | Description |
---|---|---|
cancelled |
string |
|
completed |
string |
|
enqueued |
string |
|
failed |
string |
|
running |
string |
|
unknown |
string |
JobType
作業的類型。
名稱 | 類型 | Description |
---|---|---|
backup |
string |
|
export |
string |
|
factoryResetDevice |
string |
|
firmwareUpdate |
string |
|
import |
string |
|
readDeviceProperties |
string |
|
rebootDevice |
string |
|
unknown |
string |
|
updateDeviceConfiguration |
string |
|
writeDeviceProperties |
string |
ManagedIdentity
受控識別的屬性。
名稱 | 類型 | Description |
---|---|---|
userAssignedIdentity |
string |
使用者指派的身分識別。 |