Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Devices

Package version

Class representing a Devices.

Hierarchy

  • Devices

Index

Constructors

constructor

Methods

createOrUpdateGroup

deleteGroup

  • deleteGroup(groupId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>
  • Deletes a device group.

    Parameters

    • groupId: string

      Group identifier.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<coreHttp.RestResponse>

getDevice

  • 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

getDeviceTag

getGroup

getGroupUpdateCompliance

  • 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

  • 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>
  • 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>
  • 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

listAllGroups

  • listAllGroups(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<Group>
  • 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>
  • 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>
  • 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

Generated using TypeDoc