Class Devices

Package version

Class representing a Devices.

Hierarchy

Devices

Index

Constructors

constructor

Methods

Constructors

constructor

new Devices(client: DeviceUpdateClientContext): Devices

- Defined in operations/devices.ts:52
Initialize a new instance of the class Devices class.

Parameters
- client: DeviceUpdateClientContext
  
  Reference to the service client
Returns Devices

Methods

createOrUpdateGroup

createOrUpdateGroup(groupId: string, group: Group, options?: coreHttp.OperationOptions): Promise<DevicesCreateOrUpdateGroupResponse>

- Defined in operations/devices.ts:742
Create or update a device group.

Parameters
- groupId: string
  
  Group identifier.
- group: Group
  
  The group properties.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesCreateOrUpdateGroupResponse>

deleteGroup

deleteGroup(groupId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in operations/devices.ts:778
Deletes a device group.

Parameters
- groupId: string
  
  Group identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

getDevice

getDevice(deviceId: string, options?: coreHttp.OperationOptions): Promise<DevicesGetDeviceResponse>

- Defined in operations/devices.ts:545
Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.

Parameters
- deviceId: string
  
  Device identifier in Azure IOT Hub.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetDeviceResponse>

getDeviceClass

getDeviceClass(deviceClassId: string, options?: coreHttp.OperationOptions): Promise<DevicesGetDeviceClassResponse>

- Defined in operations/devices.ts:411
Gets the properties of a device class.

Parameters
- deviceClassId: string
  
  Device class identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetDeviceClassResponse>

getDeviceTag

getDeviceTag(tagName: string, options?: coreHttp.OperationOptions): Promise<DevicesGetDeviceTagResponse>

- Defined in operations/devices.ts:642
Gets a count of how many devices have a device tag.

Parameters
- tagName: string
  
  Tag name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetDeviceTagResponse>

getGroup

getGroup(groupId: string, options?: coreHttp.OperationOptions): Promise<DevicesGetGroupResponse>

- Defined in operations/devices.ts:707
Gets the properties of a group.

Parameters
- groupId: string
  
  Group identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetGroupResponse>

getGroupUpdateCompliance

getGroupUpdateCompliance(groupId: string, options?: coreHttp.OperationOptions): Promise<DevicesGetGroupUpdateComplianceResponse>

- Defined in operations/devices.ts:813
Get group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.

Parameters
- groupId: string
  
  Group identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetGroupUpdateComplianceResponse>

getUpdateCompliance

getUpdateCompliance(options?: coreHttp.OperationOptions): Promise<DevicesGetUpdateComplianceResponse>

- Defined in operations/devices.ts:579
Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DevicesGetUpdateComplianceResponse>

listAllDeviceClasses

listAllDeviceClasses(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<DeviceClass>

- Defined in operations/devices.ts:67
Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeviceClass>

listAllDeviceTags

listAllDeviceTags(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<DeviceTag>

- Defined in operations/devices.ts:250
Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeviceTag>

listAllDevices

listAllDevices(options?: DevicesGetAllDevicesOptionalParams): PagedAsyncIterableIterator<Device>

- Defined in operations/devices.ts:208
Gets a list of devices connected to Device Update for IoT Hub.

Parameters
- Optional options: DevicesGetAllDevicesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Device>

listAllGroups

listAllGroups(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<Group>

- Defined in operations/devices.ts:292
Gets a list of all device groups.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<Group>

listDeviceClassDeviceIds

listDeviceClassDeviceIds(deviceClassId: string, options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<string>

- Defined in operations/devices.ts:110
Gets a list of device identifiers in a device class.

Parameters
- deviceClassId: string
  
  Device class identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<string>

listDeviceClassInstallableUpdates

listDeviceClassInstallableUpdates(deviceClassId: string, options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<UpdateId>

- Defined in operations/devices.ts:156
Gets a list of installable updates for a device class.

Parameters
- deviceClassId: string
  
  Device class identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<UpdateId>

listGroupBestUpdates

listGroupBestUpdates(groupId: string, options?: DevicesGetGroupBestUpdatesOptionalParams): PagedAsyncIterableIterator<UpdatableDevices>

- Defined in operations/devices.ts:333
Get the best available updates for a group and a count of how many devices need each update.

Parameters
- groupId: string
  
  Group identifier.
- Optional options: DevicesGetGroupBestUpdatesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<UpdatableDevices>

Generated using TypeDoc