Share via


NamespaceDeviceProperties interface

Defines the device properties.

Properties

attributes

A set of key-value pairs that contain custom attributes set by the customer.

discoveredDeviceRef

Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided.

enabled

Indicates if the resource is enabled or not.

endpoints

Property bag containing the device's unassigned and assigned endpoints.

externalDeviceId

The Device ID provided by the customer.

lastTransitionTime

A timestamp (in UTC) that is updated each time the resource is modified.

manufacturer

Device manufacturer.

model

Device model.

operatingSystem

Device operating system.

operatingSystemVersion

Device operating system version.

provisioningState

Provisioning state of the resource.

status

Device status updates.

uuid

A unique identifier for the device.

version

An integer that is incremented each time the resource is modified.

Property Details

attributes

A set of key-value pairs that contain custom attributes set by the customer.

attributes?: Record<string, any>

Property Value

Record<string, any>

discoveredDeviceRef

Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided.

discoveredDeviceRef?: string

Property Value

string

enabled

Indicates if the resource is enabled or not.

enabled?: boolean

Property Value

boolean

endpoints

Property bag containing the device's unassigned and assigned endpoints.

endpoints?: MessagingEndpoints

Property Value

externalDeviceId

The Device ID provided by the customer.

externalDeviceId?: string

Property Value

string

lastTransitionTime

A timestamp (in UTC) that is updated each time the resource is modified.

lastTransitionTime?: Date

Property Value

Date

manufacturer

Device manufacturer.

manufacturer?: string

Property Value

string

model

Device model.

model?: string

Property Value

string

operatingSystem

Device operating system.

operatingSystem?: string

Property Value

string

operatingSystemVersion

Device operating system version.

operatingSystemVersion?: string

Property Value

string

provisioningState

Provisioning state of the resource.

provisioningState?: string

Property Value

string

status

Device status updates.

status?: DeviceStatus

Property Value

uuid

A unique identifier for the device.

uuid?: string

Property Value

string

version

An integer that is incremented each time the resource is modified.

version?: number

Property Value

number