RegistryManager.ExportDevicesAsync Method

Definition

Overloads

ExportDevicesAsync(String, String, Boolean, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, Boolean, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(JobProperties, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

ExportDevicesAsync(String, String, Boolean, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties> ExportDevicesAsync (string exportBlobContainerUri, string outputBlobName, bool excludeKeys, System.Threading.CancellationToken cancellationToken);
abstract member ExportDevicesAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
override this.ExportDevicesAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
Public Overridable Function ExportDevicesAsync (exportBlobContainerUri As String, outputBlobName As String, excludeKeys As Boolean, cancellationToken As CancellationToken) As Task(Of JobProperties)

Parameters

exportBlobContainerUri
String

Destination blob container URI.

outputBlobName
String

The name of the blob that will be created in the provided output blob container.

excludeKeys
Boolean

Specifies whether to exclude the Device's Keys during the export.

cancellationToken
CancellationToken

Task cancellation token.

Returns

JobProperties of the newly created job.

Applies to

ExportDevicesAsync(String, String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties> ExportDevicesAsync (string exportBlobContainerUri, string outputBlobName, bool excludeKeys);
abstract member ExportDevicesAsync : string * string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
override this.ExportDevicesAsync : string * string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
Public Overridable Function ExportDevicesAsync (exportBlobContainerUri As String, outputBlobName As String, excludeKeys As Boolean) As Task(Of JobProperties)

Parameters

exportBlobContainerUri
String

Destination blob container URI.

outputBlobName
String

The name of the blob that will be created in the provided output blob container.

excludeKeys
Boolean

Specifies whether to exclude the Device's Keys during the export.

Returns

JobProperties of the newly created job.

Applies to

ExportDevicesAsync(String, Boolean, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties> ExportDevicesAsync (string exportBlobContainerUri, bool excludeKeys, System.Threading.CancellationToken cancellationToken);
abstract member ExportDevicesAsync : string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
override this.ExportDevicesAsync : string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
Public Overridable Function ExportDevicesAsync (exportBlobContainerUri As String, excludeKeys As Boolean, cancellationToken As CancellationToken) As Task(Of JobProperties)

Parameters

exportBlobContainerUri
String

Destination blob container URI.

excludeKeys
Boolean

Specifies whether to exclude the Device's Keys during the export.

cancellationToken
CancellationToken

Task cancellation token.

Returns

JobProperties of the newly created job.

Applies to

ExportDevicesAsync(String, Boolean)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties> ExportDevicesAsync (string exportBlobContainerUri, bool excludeKeys);
abstract member ExportDevicesAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
override this.ExportDevicesAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
Public Overridable Function ExportDevicesAsync (exportBlobContainerUri As String, excludeKeys As Boolean) As Task(Of JobProperties)

Parameters

exportBlobContainerUri
String

Destination blob container URI.

excludeKeys
Boolean

Specifies whether to exclude the Device's Keys during the export.

Returns

JobProperties of the newly created job.

Applies to

ExportDevicesAsync(JobProperties, CancellationToken)

Creates a new bulk job to export device registrations to the container specified by the provided URI.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties> ExportDevicesAsync (Microsoft.Azure.Devices.JobProperties jobParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member ExportDevicesAsync : Microsoft.Azure.Devices.JobProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
override this.ExportDevicesAsync : Microsoft.Azure.Devices.JobProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobProperties>
Public Overridable Function ExportDevicesAsync (jobParameters As JobProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobProperties)

Parameters

jobParameters
JobProperties

Parameters for the job.

cancellationToken
CancellationToken

Task cancellation token.

Returns

JobProperties of the newly created job.

Remarks

Conditionally includes configurations, if specified.

Applies to