Class DeviceRegistrationResult

Namespace

Microsoft.Azure.Devices.Provisioning.Client

Assembly

Microsoft.Azure.Devices.Provisioning.Client.dll

The result of a registration operation.

public class DeviceRegistrationResult

Inheritance

object

DeviceRegistrationResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DeviceRegistrationResult(string, DateTime?, string, string, ProvisioningRegistrationStatusType, ProvisioningRegistrationSubstatusType, string, DateTime?, int, string, string)

Used internally by the SDK to create a new instance of the DeviceRegistrationResult class. This constructor is exposed to allow serialization and unit testing of applications using this SDK.

public DeviceRegistrationResult(string registrationId, DateTime? createdDateTimeUtc, string assignedHub, string deviceId, ProvisioningRegistrationStatusType status, ProvisioningRegistrationSubstatusType substatus, string generationId, DateTime? lastUpdatedDateTimeUtc, int errorCode, string errorMessage, string etag)

Parameters

registrationId string

createdDateTimeUtc DateTime?

assignedHub string

deviceId string

status ProvisioningRegistrationStatusType

substatus ProvisioningRegistrationSubstatusType

generationId string

lastUpdatedDateTimeUtc DateTime?

errorCode int

errorMessage string

etag string

DeviceRegistrationResult(string, DateTime?, string, string, ProvisioningRegistrationStatusType, ProvisioningRegistrationSubstatusType, string, DateTime?, int, string, string, string)

. Constructor to allow return data

public DeviceRegistrationResult(string registrationId, DateTime? createdDateTimeUtc, string assignedHub, string deviceId, ProvisioningRegistrationStatusType status, ProvisioningRegistrationSubstatusType substatus, string generationId, DateTime? lastUpdatedDateTimeUtc, int errorCode, string errorMessage, string etag, string returnData)

Parameters

registrationId string

createdDateTimeUtc DateTime?

assignedHub string

deviceId string

status ProvisioningRegistrationStatusType

substatus ProvisioningRegistrationSubstatusType

generationId string

lastUpdatedDateTimeUtc DateTime?

errorCode int

errorMessage string

etag string

returnData string

DeviceRegistrationResult(string, DateTime?, string, string, ProvisioningRegistrationStatusType, string, DateTime?, int, string, string)

Used internally by the SDK to create a new instance of the DeviceRegistrationResult class. This constructor is exposed to allow serialization and unit testing of applications using this SDK.

public DeviceRegistrationResult(string registrationId, DateTime? createdDateTimeUtc, string assignedHub, string deviceId, ProvisioningRegistrationStatusType status, string generationId, DateTime? lastUpdatedDateTimeUtc, int errorCode, string errorMessage, string etag)

Parameters

registrationId string

createdDateTimeUtc DateTime?

assignedHub string

deviceId string

status ProvisioningRegistrationStatusType

generationId string

lastUpdatedDateTimeUtc DateTime?

errorCode int

errorMessage string

etag string

Properties

AssignedHub

The assigned Azure IoT Hub.

public string AssignedHub { get; protected set; }

Property Value

string

CreatedDateTimeUtc

The time when the device originally registered with the service.

public DateTime? CreatedDateTimeUtc { get; protected set; }

Property Value

DateTime?

DeviceId

The Device Id.

public string DeviceId { get; protected set; }

Property Value

string

ErrorCode

Error code.

public int? ErrorCode { get; protected set; }

Property Value

int?

ErrorMessage

Error message.

public string ErrorMessage { get; protected set; }

Property Value

string

Etag

The Etag.

public string Etag { get; protected set; }

Property Value

string

GenerationId

The generation Id.

public string GenerationId { get; protected set; }

Property Value

string

JsonPayload

The Custom data returned from the webhook to the device.

public string JsonPayload { get; }

Property Value

string

LastUpdatedDateTimeUtc

The time when the device last refreshed the registration.

public DateTime? LastUpdatedDateTimeUtc { get; protected set; }

Property Value

DateTime?

RegistrationId

The registration id.

public string RegistrationId { get; protected set; }

Property Value

string

Status

The status of the operation.

public ProvisioningRegistrationStatusType Status { get; protected set; }

Property Value

ProvisioningRegistrationStatusType

Substatus

The substatus of the operation.

public ProvisioningRegistrationSubstatusType Substatus { get; protected set; }

Property Value

ProvisioningRegistrationSubstatusType