Class ProvisioningDeviceClient

Namespace

Microsoft.Azure.Devices.Provisioning.Client

Assembly

Microsoft.Azure.Devices.Provisioning.Client.dll

Allows devices to use the Device Provisioning Service.

public class ProvisioningDeviceClient

Inheritance

object

ProvisioningDeviceClient

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

ProductInfo

Stores product information that will be appended to the user agent string that is sent to IoT Hub.

public string ProductInfo { get; set; }

Property Value

string

Methods

Create(string, string, SecurityProvider, ProvisioningTransportHandler)

Creates an instance of the Device Provisioning Client.

public static ProvisioningDeviceClient Create(string globalDeviceEndpoint, string idScope, SecurityProvider securityProvider, ProvisioningTransportHandler transport)

Parameters

globalDeviceEndpoint string

The GlobalDeviceEndpoint for the Device Provisioning Service.

idScope string

The IDScope for the Device Provisioning Service.

securityProvider SecurityProvider

The security provider instance.

transport ProvisioningTransportHandler

The type of transport (e.g. HTTP, AMQP, MQTT).

Returns

ProvisioningDeviceClient

An instance of the ProvisioningDeviceClient

RegisterAsync()

Registers the current device using the Device Provisioning Service and assigns it to an IoT Hub.

public Task<DeviceRegistrationResult> RegisterAsync()

Returns

Task<DeviceRegistrationResult>

The registration result.

RegisterAsync(ProvisioningRegistrationAdditionalData)

Registers the current device using the Device Provisioning Service and assigns it to an IoT Hub.

public Task<DeviceRegistrationResult> RegisterAsync(ProvisioningRegistrationAdditionalData data)

Parameters

data ProvisioningRegistrationAdditionalData

The optional additional data.

Returns

Task<DeviceRegistrationResult>

The registration result.

RegisterAsync(ProvisioningRegistrationAdditionalData, CancellationToken)

Registers the current device using the Device Provisioning Service and assigns it to an IoT Hub.

public Task<DeviceRegistrationResult> RegisterAsync(ProvisioningRegistrationAdditionalData data, CancellationToken cancellationToken)

Parameters

data ProvisioningRegistrationAdditionalData

The custom content.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DeviceRegistrationResult>

The registration result.

RegisterAsync(CancellationToken)

Registers the current device using the Device Provisioning Service and assigns it to an IoT Hub.

public Task<DeviceRegistrationResult> RegisterAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DeviceRegistrationResult>

The registration result.