DevicesClient.ExportAsync(ExportJobProperties, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Package:: Microsoft.Azure.Devices v2.0.0-preview002

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.ExportJobProperties> ExportAsync (Microsoft.Azure.Devices.ExportJobProperties jobParameters, System.Threading.CancellationToken cancellationToken = default);

abstract member ExportAsync : Microsoft.Azure.Devices.ExportJobProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ExportJobProperties>
override this.ExportAsync : Microsoft.Azure.Devices.ExportJobProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ExportJobProperties>

Public Overridable Function ExportAsync (jobParameters As ExportJobProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ExportJobProperties)

Parameters

jobParameters: ExportJobProperties

Parameters for the job.

cancellationToken: CancellationToken

The token which allows the operation to be canceled.

Returns

Task<ExportJobProperties>

JobProperties of the newly created job.

Exceptions

ArgumentNullException

When the provided job properties instance is null.

IotHubServiceException

If IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellation token has requested cancellation.

Remarks

Conditionally includes configurations, if specified.

Applies to

Share via