How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Device and Deployment Management API

The Device and Deployment Management API from Microsoft Azure — 31 operation(s) for device and deployment management.

Microsoft Azure Device and Deployment Management API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Device and Deployment Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 37 operations across 31 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

37 operations 31 paths 49 schemas 3 DELETE28 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 37

Across 31 paths, the API surfaces 37 operations — 3 DELETE, 28 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Device and Deployment Management 37
GET
/deviceUpdate/{instanceId}/management/deviceClasses
Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses
microsoftAzureDevicemanagementListdeviceclasses 2 params → 200default
GET
/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}
Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses Deviceclassid
microsoftAzureDevicemanagementGetdeviceclass 3 params → 200default
PATCH
/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}
Microsoft Azure Patch Deviceupdate Instanceid Management Deviceclasses Deviceclassid
microsoftAzureDevicemanagementUpdatedeviceclass 3 params body → 200default
DELETE
/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}
Microsoft Azure Delete Deviceupdate Instanceid Management Deviceclasses Deviceclassid
microsoftAzureDevicemanagementDeletedeviceclass 3 params → 204default
GET
/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}/installableUpdates
Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses Deviceclassid Installableupdates
microsoftAzureDevicemanagementListinstallableupdatesfordeviceclass 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/devices
Microsoft Azure Get Deviceupdate Instanceid Management Devices
microsoftAzureDevicemanagementListdevices 3 params → 200default
POST
/deviceUpdate/{instanceId}/management/devices:import
Microsoft Azure Post Deviceupdate Instanceid Management Devices:import
microsoftAzureDevicemanagementImportdevices 2 params body → 202default
GET
/deviceUpdate/{instanceId}/management/devices/{deviceId}
Microsoft Azure Get Deviceupdate Instanceid Management Devices Deviceid
microsoftAzureDevicemanagementGetdevice 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}
Microsoft Azure Get Deviceupdate Instanceid Management Devices Deviceid Modules Moduleid
microsoftAzureDevicemanagementGetdevicemodule 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/updateCompliance
Microsoft Azure Get Deviceupdate Instanceid Management Updatecompliance
microsoftAzureDevicemanagementGetupdatecompliance 2 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups
Microsoft Azure Get Deviceupdate Instanceid Management Groups
microsoftAzureDevicemanagementListgroups 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid
microsoftAzureDevicemanagementGetgroup 3 params → 200default
DELETE
/deviceUpdate/{instanceId}/management/groups/{groupId}
Microsoft Azure Delete Deviceupdate Instanceid Management Groups Groupid
microsoftAzureDevicemanagementDeletegroup 3 params → 204default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/updateCompliance
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Updatecompliance
microsoftAzureDevicemanagementGetupdatecomplianceforgroup 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/bestUpdates
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Bestupdates
microsoftAzureDevicemanagementListbestupdatesforgroup 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments
microsoftAzureDevicemanagementListdeploymentsforgroup 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid
microsoftAzureDevicemanagementGetdeployment 4 params → 200default
PUT
/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}
Microsoft Azure Put Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid
microsoftAzureDevicemanagementCreateorupdatedeployment 4 params body → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid Status
microsoftAzureDevicemanagementGetdeploymentstatus 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups
microsoftAzureDevicemanagementListdeviceclasssubgroupsforgroup 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid
microsoftAzureDevicemanagementGetdeviceclasssubgroup 4 params → 200default
DELETE
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}
Microsoft Azure Delete Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid
microsoftAzureDevicemanagementDeletedeviceclasssubgroup 4 params → 204default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/updateCompliance
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Updatecompliance
microsoftAzureDevicemanagementGetdeviceclasssubgroupupdatecompliance 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/bestUpdates
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Bestupdates
microsoftAzureDevicemanagementGetbestupdatesfordeviceclasssubgroup 4 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments
microsoftAzureDevicemanagementListdeploymentsfordeviceclasssubgroup 5 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid
microsoftAzureDevicemanagementGetdeploymentfordeviceclasssubgroup 5 params → 200default
POST
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:cancel
Microsoft Azure Post Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid:cancel
microsoftAzureDevicemanagementStopdeployment 5 params → 200default
POST
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:retry
Microsoft Azure Post Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid:retry
microsoftAzureDevicemanagementRetrydeployment 5 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/status
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid Status
microsoftAzureDevicemanagementGetdeviceclasssubgroupdeploymentstatus 5 params → 200default
GET
/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/devicestates
Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid Devicestates
microsoftAzureDevicemanagementListdevicestatesfordeviceclasssubgroupdeployment 6 params → 200default
GET
/deviceUpdate/{instanceId}/management/operations/{operationId}
Microsoft Azure Get Deviceupdate Instanceid Management Operations Operationid
microsoftAzureDevicemanagementGetoperation 4 params → 200304default
GET
/deviceUpdate/{instanceId}/management/operations
Microsoft Azure Get Deviceupdate Instanceid Management Operations
microsoftAzureDevicemanagementListoperations 4 params → 200default
PUT
/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}
Microsoft Azure Put Deviceupdate Instanceid Management Devicediagnostics Logcollections Operationid
microsoftAzureDevicemanagementStartlogcollection 3 params body → 201default
GET
/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}
Microsoft Azure Get Deviceupdate Instanceid Management Devicediagnostics Logcollections Operationid
microsoftAzureDevicemanagementGetlogcollection 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections
Microsoft Azure Get Deviceupdate Instanceid Management Devicediagnostics Logcollections
microsoftAzureDevicemanagementListlogcollections 2 params → 200default
GET
/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}/detailedStatus
Microsoft Azure Get Deviceupdate Instanceid Management Devicediagnostics Logcollections Operationid Detailedstatus
microsoftAzureDevicemanagementGetlogcollectiondetailedstatus 3 params → 200default
GET
/deviceUpdate/{instanceId}/management/deviceDiagnostics/deviceHealth
Microsoft Azure Get Deviceupdate Instanceid Management Devicediagnostics Devicehealth
microsoftAzureDevicemanagementListdevicehealth 3 params → 200default

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Device (10 properties), DeviceClassSubgroupDeploymentStatus (9 properties), Deployment (9 properties), Group (8 properties). Each schema is shown below with its type and property counts.

ContractModel
object
The Device Update agent contract model.
2 properties 2 required
Error
object
Error details.
6 properties 2 required
DeviceOperationsList
object
The list of device operations with server paging support.
2 properties 1 required
HealthCheckResult
string
Health check result
GroupType
string
Supported group types.
LogCollectionList
object
The list of log collections with server paging support.
2 properties 1 required
LogCollection
object
Diagnostics request body
6 properties 1 required
ImportType
string
The device import type.
OperationStatusWithoutUndefinedOption
string
Operation status.
Deployment
object
Deployment metadata.
9 properties 4 required
DeploymentDeviceStatesList
object
The list of deployment device states.
2 properties 1 required
DeploymentStatus
object
Deployment status metadata.
4 properties 3 required
DeploymentDeviceState
object
Deployment device status.
5 properties 4 required
Device
object
Device metadata.
10 properties 3 required
InnerError
object
An object containing more specific information than the current object about the error.
4 properties 1 required
CloudInitiatedRollbackPolicyFailure
object
Failure conditions to initiate rollback policy
2 properties 2 required
DeviceClassesList
object
The list of device classes.
2 properties 1 required
DeviceClassSubgroupsList
object
The list of device class subgroups within a group.
2 properties 1 required
DevicesList
object
The list of devices.
2 properties 1 required
DeviceUpdateAgentId
object
Device Update agent id
2 properties 1 required
UpdateCompliance
object
Update compliance information.
4 properties 4 required
DeviceHealthList
object
Array of Device Health, with server paging support.
2 properties 1 required
LogCollectionOperationDeviceStatus
object
Diagnostics operation device status
6 properties 2 required
DeploymentState
string
Deployment state.
DeviceClassSubgroupUpdatableDevices
object
Device class subgroup, update information, and the number of devices for which the update is applicable.
4 properties 4 required
UpdateInfo
object
Update information.
3 properties 1 required
PatchBody
object
Device Class JSON Merge Patch request body
1 property 1 required
DeviceOperation
object
Operation metadata.
7 properties 4 required
OperationStatus
string
Operation status.
DeviceClass
object
Device class metadata.
4 properties 2 required
DeploymentsList
object
The list of deployments.
2 properties 1 required
Group
object
Group details.
8 properties 3 required
LogCollectionOperationDetailedStatus
object
Device diagnostics operation detailed status
6 properties
DeviceDeploymentState
string
Deployment state.
UpdateInfoList
object
List of update information.
2 properties 1 required
ErrorResponse
object
Common error response.
1 property 1 required
DeviceClassProperties
object
The device class properties that are used to calculate the device class Id
2 properties 1 required
StepResult
object
The step result under an update.
5 properties 2 required
InstallResult
object
The install result of an update and any step results under it.
4 properties 2 required
DeviceClassSubgroupUpdatableDevicesList
object
The list of updatable devices for a device class subgroup.
2 properties 1 required
DeviceClassSubgroup
object
Device class subgroup details. A device class subgroup is a subset of devices in a group that share the same device class id.
5 properties 3 required
HealthCheck
object
Health check
2 properties
DeviceClassSubgroupDeploymentState
string
Device class subgroup deployment state.
DeviceClassSubgroupDeploymentStatus
object
Device class subgroup deployment status metadata.
9 properties 3 required
GroupsList
object
The list of groups.
2 properties 1 required
DeviceHealthState
string
Device health states
UpdateId
object
Update identifier.
3 properties 3 required
DeviceHealth
object
Device Health
5 properties 3 required
CloudInitiatedRollbackPolicy
object
Rollback policy for deployment
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-device-and-deployment-management-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Device and Deployment Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.