次の方法で共有


Iot Hub Resource - Export Devices

IoT ハブ ID レジストリ内のすべてのデバイス ID を Azure Storage BLOB コンテナーにエクスポートします。 詳細については、「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}/exportDevices?api-version=2023-06-30

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

IoT ハブを含むリソース グループの名前。

resourceName
path True

string

IoT ハブの名前。

subscriptionId
path True

string

サブスクリプションの識別子です。

api-version
query True

string

API のバージョン。

要求本文

名前 必須 説明
excludeKeys True

boolean

エクスポート中にキーを除外するかどうかを示す値。

exportBlobContainerUri True

string

エクスポート BLOB コンテナー URI。

authenticationType

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

configurationsBlobName

string

指定された出力 BLOB コンテナーに作成される BLOB の名前。 この BLOB には、Iot Hub のエクスポートされた構成が含まれます。

exportBlobName

string

指定された出力 BLOB コンテナーに作成される BLOB の名前。 この BLOB には、IoT Hubのエクスポートされたデバイス レジストリ情報が含まれます。

identity

ManagedIdentity

エクスポート デバイスのストレージ エンドポイントのマネージド ID プロパティ。

includeConfigurations

boolean

構成をエクスポートするかどうかを示す値。

応答

名前 説明
200 OK

JobResponse

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

IotHubResource_ExportDevices

要求のサンプル

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

{
  "exportBlobContainerUri": "testBlob",
  "excludeKeys": true
}

応答のサンプル

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

定義

名前 説明
AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

ErrorDetails

エラーの詳細。

ExportDevicesRequest

IoT ハブ内のすべてのデバイスのエクスポートを要求するときにパラメーターを指定するには、 を使用します。

JobResponse

ジョブ応答オブジェクトのプロパティ。

JobStatus

ジョブの状態。

JobType

ジョブの種類。

ManagedIdentity

マネージド ID のプロパティ。

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

名前 説明
identityBased

string

keyBased

string

ErrorDetails

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。

ExportDevicesRequest

IoT ハブ内のすべてのデバイスのエクスポートを要求するときにパラメーターを指定するには、 を使用します。

名前 説明
authenticationType

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

configurationsBlobName

string

指定された出力 BLOB コンテナーに作成される BLOB の名前。 この BLOB には、Iot Hub のエクスポートされた構成が含まれます。

excludeKeys

boolean

エクスポート中にキーを除外するかどうかを示す値。

exportBlobContainerUri

string

エクスポート BLOB コンテナー URI。

exportBlobName

string

指定された出力 BLOB コンテナーに作成される BLOB の名前。 この BLOB には、IoT Hubのエクスポートされたデバイス レジストリ情報が含まれます。

identity

ManagedIdentity

エクスポート デバイスのストレージ エンドポイントのマネージド ID プロパティ。

includeConfigurations

boolean

構成をエクスポートするかどうかを示す値。

JobResponse

ジョブ応答オブジェクトのプロパティ。

名前 説明
endTimeUtc

string

ジョブが処理を停止した時刻。

failureReason

string

status == failed の場合、エラーの理由を含むこの文字列。

jobId

string

ジョブ識別子です。

parentJobId

string

親ジョブのジョブ識別子 (存在する場合)。

startTimeUtc

string

ジョブの開始時刻。

status

JobStatus

ジョブの状態。

statusMessage

string

ジョブのステータス メッセージ。

type

JobType

ジョブの種類。

JobStatus

ジョブの状態。

名前 説明
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

ジョブの種類。

名前 説明
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string

ManagedIdentity

マネージド ID のプロパティ。

名前 説明
userAssignedIdentity

string

ユーザー割り当て ID。