Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2021-04-273265113.0 KB
POST

Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities

Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

post/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices

Path parameters

subscriptionIdstring required

The subscription identifier.

resourceGroupNamestring required

The name of the resource group that contains the IoT hub.

resourceNamestring required

The name of the IoT hub.

Query parameters

api-versionstring required

The version of the API.

Request body

exportBlobContainerUristring required

The export blob container URI.

excludeKeysboolean required

The value indicating whether keys should be excluded during export.

Response

OK

jobIdstring

The job identifier.

startTimeUtcstring date-time-rfc1123

The start time of the job.

endTimeUtcstring date-time-rfc1123

The time the job stopped processing.

type'unknown' | 'export' | 'import' | 'backup' | 'readDeviceProperties' | 'writeDeviceProperties' | 'updateDeviceConfiguration' | 'rebootDevice' | 'factoryResetDevice' | 'firmwareUpdate'

The type of the job.

status'unknown' | 'enqueued' | 'running' | 'completed' | 'failed' | 'cancelled'

The status of the job.

failureReasonstring

If status == failed, this string containing the reason for the failure.

statusMessagestring

The status message for the job.

parentJobIdstring

The job identifier of the parent job, if any.