DevicesClient.ImportAsync(ImportJobProperties, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Creates a new bulk job to import device registrations into the IoT hub.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ImportJobProperties> ImportAsync (Microsoft.Azure.Devices.ImportJobProperties jobParameters, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function ImportAsync (jobParameters As ImportJobProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ImportJobProperties)

Parameters

jobParameters

ImportJobProperties

Parameters for the job.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task<ImportJobProperties>

Exceptions

ArgumentNullException

When the provided connection string or container name is null.

ArgumentException

When the provided connection string or container name is empty or whitespace.

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.