ExportDevicesRequest interface

Use to provide parameters when requesting an export of all devices in the IoT hub.

Properties

authenticationType

Specifies authentication type being used for connecting to the storage account.

configurationsBlobName

The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.

excludeKeys

The value indicating whether keys should be excluded during export.

exportBlobContainerUri

The export blob container URI.

exportBlobName

The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.

identity

Managed identity properties of storage endpoint for export devices.

includeConfigurations

The value indicating whether configurations should be exported.

Property Details

authenticationType

Specifies authentication type being used for connecting to the storage account.

authenticationType?: string

Property Value

string

configurationsBlobName

The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.

configurationsBlobName?: string

Property Value

string

excludeKeys

The value indicating whether keys should be excluded during export.

excludeKeys: boolean

Property Value

boolean

exportBlobContainerUri

The export blob container URI.

exportBlobContainerUri: string

Property Value

string

exportBlobName

The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.

exportBlobName?: string

Property Value

string

identity

Managed identity properties of storage endpoint for export devices.

identity?: ManagedIdentity

Property Value

includeConfigurations

The value indicating whether configurations should be exported.

includeConfigurations?: boolean

Property Value

boolean