Iot Hub Resource - Export Devices

Service:
IoT Hub
API Version:
2017-01-19

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 https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices?api-version={api-version}

URI Parameters

Name In Required Type Description
subscriptionId
 path True
  • string

The subscription identifier.
resourceGroupName
 path True
  • string

The name of the resource group that contains the IoT hub.
resourceName
 path True
  • string

The name of the IoT hub.
api-version
 query True
  • string

The version of the API.

Request Body

Name Required Type Description
ExcludeKeys True
  • boolean

The value indicating whether keys should be excluded during export.
ExportBlobContainerUri True
  • string

The export blob container URI.

Responses

Name Type Description
200 OK

OK
Other Status Codes

DefaultErrorResponse

Definitions

ErrorDetails
JobResponse
Name Type Description
Code
  • string

The error code.
Details
  • string

The error details.
HttpStatusCode
  • string

The HTTP status code.
Message
  • string

The error message.
Name Type Description
endTimeUtc
  • string
    date-time-rfc1123

The time the job stopped processing.
failureReason
  • string

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

The job identifier.
parentJobId
  • string

The job identifier of the parent job, if any.
startTimeUtc
  • string
    date-time-rfc1123

The start time of the job.
status
  • enum:
    • unknown
    • enqueued
    • running
    • completed
    • failed
    • cancelled

The status of the job.
statusMessage
  • string

The status message for the job.
type
  • enum:
    • unknown
    • export
    • import
    • backup
    • readDeviceProperties
    • writeDeviceProperties
    • updateDeviceConfiguration
    • rebootDevice
    • factoryResetDevice
    • firmwareUpdate

The type of the job.