DevicesClient.CreateAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Overloads

CreateAsync(Device, CancellationToken)	Create a device identity in your IoT hub's registry.
CreateAsync(IEnumerable<Device>, CancellationToken)	Create up to 100 new device identities in your IoT hub's registry in bulk.

CreateAsync(Device, CancellationToken)

Create a device identity in your IoT hub's registry.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device> CreateAsync (Microsoft.Azure.Devices.Device device, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function CreateAsync (device As Device, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Device)

Parameters

device

Device

The device identity to register.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task<Device>

The registered device with the generated keys and ETags.

Exceptions

ArgumentNullException

When the provided device 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.

CreateAsync(IEnumerable<Device>, CancellationToken)

Create up to 100 new device identities in your IoT hub's registry in bulk.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> CreateAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Device> devices, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateAsync : seq<Microsoft.Azure.Devices.Device> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.CreateAsync : seq<Microsoft.Azure.Devices.Device> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>

Public Overridable Function CreateAsync (devices As IEnumerable(Of Device), Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

Parameters

devices

IEnumerable<Device>

The device identities to create in your IoT hub's registry. May not exceed 100 devices.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task<BulkRegistryOperationResult>

The result of the bulk operation.

Exceptions

ArgumentNullException

When the provided device collection is null.

ArgumentException

When the provided device collection is empty.

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

For larger scale operations, consider using ImportAsync(ImportJobProperties, CancellationToken) which allows you to import devices from an Azure Storage container.