Jobs - Create Import Export Job

Service:

IoT Hub

API Version:

2020-05-31-preview

IoT Hubに新しいインポートまたはエクスポート ジョブを作成します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 」を参照してください。

POST https://fully-qualified-iothubname.azure-devices.net/jobs/create?api-version=2020-05-31-preview

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	Api のバージョン。

要求本文

名前	型	説明
configurationsBlobName	string	既定値は configurations.txt です。 構成をエクスポートまたはインポートするときに使用する BLOB の名前を指定します。
endTimeUtc	string	システムが生成されました。 作成時に無視されます。 ジョブの終了日時 (UTC)。
excludeKeysInExport	boolean	エクスポート ジョブの場合は省略可能です。他のジョブでは無視されます。 指定しない場合、サービスの既定値は false になります。 false の場合、承認キーはエクスポート出力に含まれます。 それ以外の場合、キーは null としてエクスポートされます。
failureReason	string	システムが遺伝子導入されました。 作成時に無視されます。 エラーが発生した場合のエラーの理由。
includeConfigurations	boolean	既定値は false です。 true の場合、構成はデータのエクスポート/インポートに含まれます。
inputBlobContainerUri	string	同期するレジストリ データを含む BLOB コンテナーへの SAS トークンを含む URI。
inputBlobName	string	入力 BLOB コンテナーからインポートするときに使用する BLOB 名。
jobId	string	ジョブの一意識別子。
outputBlobContainerUri	string	BLOB コンテナーにアクセスするための SAS トークン。 これは、ジョブの状態と結果を出力するために使用されます。
outputBlobName	string	出力 BLOB コンテナーに作成される BLOB 名。 この BLOB には、IoT Hubのエクスポートされたデバイス レジストリ情報が含まれます。
progress	integer	システムが生成されました。 作成時に無視されます。 ジョブの完了率。
startTimeUtc	string	システムが生成されました。 作成時に無視されます。 ジョブの開始日時 (UTC)。
status	enum: unknown enqueued running completed failed cancelled scheduled queued	システムが生成されました。 作成時に無視されます。 ジョブの状態。
storageAuthenticationType	enum: keyBased identityBased	ストレージ アカウントへの接続に使用される認証の種類。
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	ジョブの種類。

応答

名前	型	説明
200 OK	JobProperties	OK です。

定義

JobProperties

名前	型	説明
configurationsBlobName	string	既定値は configurations.txt です。 構成をエクスポートまたはインポートするときに使用する BLOB の名前を指定します。
endTimeUtc	string	システムが生成されました。 作成時に無視されます。 ジョブの終了日時 (UTC)。
excludeKeysInExport	boolean	エクスポート ジョブの場合は省略可能です。他のジョブでは無視されます。 指定しない場合、サービスの既定値は false になります。 false の場合、承認キーはエクスポート出力に含まれます。 それ以外の場合、キーは null としてエクスポートされます。
failureReason	string	システムが遺伝子導入されました。 作成時に無視されます。 エラーが発生した場合のエラーの理由。
includeConfigurations	boolean	既定値は false です。 true の場合、構成はデータのエクスポート/インポートに含まれます。
inputBlobContainerUri	string	同期するレジストリ データを含む BLOB コンテナーへの SAS トークンを含む URI。
inputBlobName	string	入力 BLOB コンテナーからインポートするときに使用する BLOB 名。
jobId	string	ジョブの一意識別子。
outputBlobContainerUri	string	BLOB コンテナーにアクセスするための SAS トークン。 これは、ジョブの状態と結果を出力するために使用されます。
outputBlobName	string	出力 BLOB コンテナーに作成される BLOB 名。 この BLOB には、IoT Hubのエクスポートされたデバイス レジストリ情報が含まれます。
progress	integer	システムが生成されました。 作成時に無視されます。 ジョブの完了率。
startTimeUtc	string	システムが生成されました。 作成時に無視されます。 ジョブの開始日時 (UTC)。
status	enum: cancelled completed enqueued failed queued running scheduled unknown	システムが生成されました。 作成時に無視されます。 ジョブの状態。
storageAuthenticationType	enum: identityBased keyBased	ストレージ アカウントへの接続に使用される認証の種類。
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	ジョブの種類。