Microsoft Azure

Azure Deviceupdate

Device Update for IoT Hub is an Azure service that enables customers to publish updates for their IoT devices to the cloud, and then deploy that update to…

IoT & devices#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Device Update for IoT Hub is an Azure service that enables customers to publish updates for their IoT devices to the cloud, and then deploy that update to their devices (approve updates to groups of devices managed and provisioned in IoT Hub). It leverages the proven security and reliability of the Windows Update platform, optimized for IoT devices. It works globally and knows when and how to update devices, enabling customers to focus on their business goals and let Device Update for IoT Hub handle the updates.

Endpoints 50

Update management

  • GETDeviceUpdate_ListUpdates/deviceUpdate/:instanceId/updates?api-version=string&search=string&filter=stringGet a list of all updates that have been imported to Device Update for IoT Hub.
  • GETDeviceUpdate_ListOperationStatuses/deviceUpdate/:instanceId/updates/operations?api-version=string&filter=string&top=0Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API…
  • GETDeviceUpdate_GetOperationStatus/deviceUpdate/:instanceId/updates/operations/:operationId?api-version=stringRetrieve operation status.
  • GETDeviceUpdate_ListProviders/deviceUpdate/:instanceId/updates/providers?api-version=stringGet a list of all update providers that have been imported to Device Update for IoT Hub.
  • GETDeviceUpdate_ListNames/deviceUpdate/:instanceId/updates/providers/:provider/names?api-version=stringGet a list of all update names that match the specified provider.
  • GETDeviceUpdate_ListVersions/deviceUpdate/:instanceId/updates/providers/:provider/names/:name/versions?api-version=string&filter=stringGet a list of all update versions that match the specified provider and name.
  • GETDeviceUpdate_GetUpdate/deviceUpdate/:instanceId/updates/providers/:provider/names/:name/versions/:version?api-version=stringGet a specific update version.
  • DELETEDeviceUpdate_DeleteUpdate/deviceUpdate/:instanceId/updates/providers/:provider/names/:name/versions/:version?api-version=stringDelete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
  • GETDeviceUpdate_ListFiles/deviceUpdate/:instanceId/updates/providers/:provider/names/:name/versions/:version/files?api-version=stringGet a list of all update file identifiers for the specified version.
  • GETDeviceUpdate_GetFile/deviceUpdate/:instanceId/updates/providers/:provider/names/:name/versions/:version/files/:fileId?api-version=stringGet a specific update file from the version.
  • POSTDeviceUpdate_ImportUpdate/deviceUpdate/:instanceId/updates:import?api-version=stringImport new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.

Device and deployment management

  • GETDeviceManagement_ListDeviceClasses/deviceUpdate/:instanceId/management/deviceClasses?api-version=string&filter=stringGets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update…
  • GETDeviceManagement_GetDeviceClass/deviceUpdate/:instanceId/management/deviceClasses/:deviceClassId?api-version=stringGets the properties of a device class.
  • DELETEDeviceManagement_DeleteDeviceClass/deviceUpdate/:instanceId/management/deviceClasses/:deviceClassId?api-version=stringDeletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned…
  • PATCHDeviceManagement_UpdateDeviceClass/deviceUpdate/:instanceId/management/deviceClasses/:deviceClassId?api-version=stringUpdate device class details.
  • GETDeviceManagement_ListInstallableUpdatesForDeviceClass/deviceUpdate/:instanceId/management/deviceClasses/:deviceClassId/installableUpdates?api-version=stringGets a list of installable updates for a device class.
  • GETDeviceManagement_ListHealthOfDevices/deviceUpdate/:instanceId/management/deviceDiagnostics/deviceHealth?api-version=string&filter=stringGet list of device health
  • GETDeviceManagement_ListLogCollections/deviceUpdate/:instanceId/management/deviceDiagnostics/logCollections?api-version=stringGet all device diagnostics log collections
  • GETDeviceManagement_GetLogCollection/deviceUpdate/:instanceId/management/deviceDiagnostics/logCollections/:operationId?api-version=stringGet the device diagnostics log collection
  • PUTDeviceManagement_StartLogCollection/deviceUpdate/:instanceId/management/deviceDiagnostics/logCollections/:operationId?api-version=stringStart the device diagnostics log collection on specified devices.
  • GETDeviceManagement_GetLogCollectionDetailedStatus/deviceUpdate/:instanceId/management/deviceDiagnostics/logCollections/:operationId/detailedStatus?api-version=stringGet log collection with detailed status
  • GETDeviceManagement_ListDevices/deviceUpdate/:instanceId/management/devices?api-version=string&filter=stringGets a list of devices connected to Device Update for IoT Hub.
  • GETDeviceManagement_GetDevice/deviceUpdate/:instanceId/management/devices/:deviceId?api-version=stringGets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
  • GETDeviceManagement_GetDeviceModule/deviceUpdate/:instanceId/management/devices/:deviceId/modules/:moduleId?api-version=stringGets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
  • POSTDeviceManagement_ImportDevices/deviceUpdate/:instanceId/management/devices:import?api-version=stringImport existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status.
  • GETDeviceManagement_ListGroups/deviceUpdate/:instanceId/management/groups?api-version=string&orderby=stringGets a list of all device groups. The $default group will always be returned first.
  • GETDeviceManagement_GetGroup/deviceUpdate/:instanceId/management/groups/:groupId?api-version=stringGets the device group properties.
  • DELETEDeviceManagement_DeleteGroup/deviceUpdate/:instanceId/management/groups/:groupId?api-version=stringDeletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups,…
  • GETDeviceManagement_ListBestUpdatesForGroup/deviceUpdate/:instanceId/management/groups/:groupId/bestUpdates?api-version=stringGet the best available updates for a device group and a count of how many devices need each update.
  • GETDeviceManagement_ListDeploymentsForGroup/deviceUpdate/:instanceId/management/groups/:groupId/deployments?api-version=string&orderby=stringGets a list of deployments for a device group.
  • GETDeviceManagement_GetDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deployments/:deploymentId?api-version=stringGets the deployment properties.
  • PUTDeviceManagement_CreateOrUpdateDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deployments/:deploymentId?api-version=stringCreates or updates a deployment.
  • GETDeviceManagement_GetDeploymentStatus/deviceUpdate/:instanceId/management/groups/:groupId/deployments/:deploymentId/status?api-version=stringGets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
  • GETDeviceManagement_ListDeviceClassSubgroupsForGroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups?api-version=string&filter=stringGet the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices…
  • GETDeviceManagement_GetDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId?api-version=stringGets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the…
  • DELETEDeviceManagement_DeleteDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId?api-version=stringDeletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its…
  • GETDeviceManagement_GetBestUpdatesForDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/bestUpdates?api-version=stringGet the best available update for a device class subgroup and a count of how many devices need this update.
  • GETDeviceManagement_ListDeploymentsForDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments?api-version=string&orderby=stringGets a list of deployments for a device class subgroup.
  • GETDeviceManagement_GetDeploymentForDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId?api-version=stringGets the deployment properties.
  • POSTDeviceManagement_StopDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId:cancel?api-version=stringStops a deployment.
  • POSTDeviceManagement_RetryDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId:retry?api-version=stringRetries a deployment with failed devices.
  • GETDeviceManagement_ListDeviceStatesForDeviceClassSubgroupDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId/devicestates?api-version=string&filter=stringGets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.
  • GETDeviceManagement_GetDeviceClassSubgroupDeploymentStatus/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId/status?api-version=stringGets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
  • GETDeviceManagement_GetDeviceClassSubgroupUpdateCompliance/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/updateCompliance?api-version=stringGet device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in…
  • GETDeviceManagement_GetUpdateComplianceForGroup/deviceUpdate/:instanceId/management/groups/:groupId/updateCompliance?api-version=stringGet device 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…
  • GETDeviceManagement_ListOperationStatuses/deviceUpdate/:instanceId/management/operations?api-version=string&filter=string&top=0Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.
  • GETDeviceManagement_GetOperationStatus/deviceUpdate/:instanceId/management/operations/:operationId?api-version=stringRetrieve operation status.
  • GETDeviceManagement_GetUpdateCompliance/deviceUpdate/:instanceId/management/updateCompliance?api-version=stringGets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.

Deployment management

  • DELETEDeviceManagement_DeleteDeployment/deviceUpdate/:instanceId/management/groups/:groupId/deployments/:deploymentId?api-version=stringDeletes a deployment.
  • DELETEDeviceManagement_DeleteDeploymentForDeviceClassSubgroup/deviceUpdate/:instanceId/management/groups/:groupId/deviceClassSubgroups/:deviceClassId/deployments/:deploymentId?api-version=stringDeletes a device class subgroup deployment.

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
50 operations on 41 pathsGET 37DELETE 6POST 4PUT 2PATCH 1
Main resources
Device and deployment management 37Update management 11Deployment management 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-06-01

How to test the Azure Deviceupdate in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Deviceupdate collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “DeviceUpdate_ListUpdates” (GET /deviceUpdate/:instanceId/updates?api-version=string&search=string&filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Deviceupdate?

Device Update for IoT Hub is an Azure service that enables customers to publish updates for their IoT devices to the cloud, and then deploy that update to… It is listed under IoT & devices and has 50 endpoints.

Who publishes the Azure Deviceupdate?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Deviceupdate?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Deviceupdate have?

50 operations on 41 paths (37 GET, 6 DELETE, 4 POST, 2 PUT, 1 PATCH). The largest groups are Device and deployment management, Update management, Deployment management.

Is forking the Azure Deviceupdate free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.