Microsoft Azure
Microsoft Azure Device and Deployment Management API

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

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Device and Deployment Management API
schemes:
- https
tags:
- name: Device and Deployment Management
paths:
  /deviceUpdate/{instanceId}/management/deviceClasses:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.
      operationId: microsoftAzureDevicemanagementListdeviceclasses
      x-ms-examples:
        DeviceManagement_ListDeviceClasses:
          $ref: ./examples/DeviceManagement_ListDeviceClasses.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: All device classes.
          schema:
            $ref: '#/definitions/DeviceClassesList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses
  /deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the properties of a device class.
      operationId: microsoftAzureDevicemanagementGetdeviceclass
      x-ms-examples:
        DeviceManagement_GetDeviceClass:
          $ref: ./examples/DeviceManagement_GetDeviceClass.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device class properties.
          schema:
            $ref: '#/definitions/DeviceClass'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses Deviceclassid
    patch:
      tags:
      - Device and Deployment Management
      description: Update device class details.
      operationId: microsoftAzureDevicemanagementUpdatedeviceclass
      consumes:
      - application/merge-patch+json
      x-ms-examples:
        DeviceManagement_UpdateDeviceClass:
          $ref: ./examples/DeviceManagement_UpdateDeviceClass.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: deviceClassPatch
        in: body
        required: true
        schema:
          $ref: '#/definitions/PatchBody'
        description: The device class json merge patch body. Currently only supports patching friendlyName
      responses:
        '200':
          description: The updated device class subgroup details.
          schema:
            $ref: '#/definitions/DeviceClass'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Patch Deviceupdate Instanceid Management Deviceclasses Deviceclassid
    delete:
      tags:
      - Device and Deployment Management
      description: Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.
      operationId: microsoftAzureDevicemanagementDeletedeviceclass
      x-ms-examples:
        DeviceManagement_DeleteDeviceClass:
          $ref: ./examples/DeviceManagement_DeleteDeviceClass.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: No content.
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Deviceupdate Instanceid Management Deviceclasses Deviceclassid
  /deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}/installableUpdates:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of installable updates for a device class.
      operationId: microsoftAzureDevicemanagementListinstallableupdatesfordeviceclass
      x-ms-examples:
        DeviceManagement_ListInstallableUpdatesForDeviceClass:
          $ref: ./examples/DeviceManagement_ListInstallableUpdatesForDeviceClass.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The installable update information for the device class.  Returns empty list in case of no installable updates
          schema:
            $ref: '#/definitions/UpdateInfoList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Deviceclasses Deviceclassid Installableupdates
  /deviceUpdate/{instanceId}/management/devices:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of devices connected to Device Update for IoT Hub.
      operationId: microsoftAzureDevicemanagementListdevices
      x-ms-examples:
        DeviceManagement_ListDevices:
          $ref: ./examples/DeviceManagement_ListDevices.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - name: filter
        in: query
        required: false
        type: string
        description: Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: All devices connected to Device Update for IoT Hub.
          schema:
            $ref: '#/definitions/DevicesList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/DeviceFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Devices
  /deviceUpdate/{instanceId}/management/devices:import:
    post:
      tags:
      - Device and Deployment Management
      operationId: microsoftAzureDevicemanagementImportdevices
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceManagement_ImportDevices:
          $ref: ./examples/DeviceManagement_ImportDevices.json
      description: Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status.
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: importType
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportType'
        description: The types of devices to import.
      responses:
        '202':
          description: Accepted device import request; background operation location to track status is specified in Operation-Location response header.
          headers:
            Operation-Location:
              type: string
              description: Url to retrieve the device import operation status.
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Deviceupdate Instanceid Management Devices:import
  /deviceUpdate/{instanceId}/management/devices/{deviceId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
      operationId: microsoftAzureDevicemanagementGetdevice
      x-ms-examples:
        DeviceManagement_GetDevice:
          $ref: ./examples/DeviceManagement_GetDevice.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device properties and latest deployment status.
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Devices Deviceid
  /deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
      operationId: microsoftAzureDevicemanagementGetdevicemodule
      x-ms-examples:
        DeviceManagement_GetDevice:
          $ref: ./examples/DeviceManagement_GetDeviceModule.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/DeviceIdParameter'
      - $ref: '#/parameters/ModuleIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device properties and latest deployment status.
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Devices Deviceid Modules Moduleid
  /deviceUpdate/{instanceId}/management/updateCompliance:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
      operationId: microsoftAzureDevicemanagementGetupdatecompliance
      x-ms-examples:
        DeviceManagement_GetUpdateCompliance:
          $ref: ./examples/DeviceManagement_GetUpdateCompliance.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The count of devices that have the latest update, have updates available, or are in progress receiving new updates.
          schema:
            $ref: '#/definitions/UpdateCompliance'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Updatecompliance
  /deviceUpdate/{instanceId}/management/groups:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of all device groups.  The $default group will always be returned first.
      operationId: microsoftAzureDevicemanagementListgroups
      x-ms-examples:
        DeviceManagement_ListGroups:
          $ref: ./examples/DeviceManagement_ListGroups.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - name: orderby
        in: query
        required: false
        type: string
        x-ms-client-name: orderBy
        description: Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device groups.
          schema:
            $ref: '#/definitions/GroupsList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/GroupOrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups
  /deviceUpdate/{instanceId}/management/groups/{groupId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the device group properties.
      operationId: microsoftAzureDevicemanagementGetgroup
      x-ms-examples:
        DeviceManagement_GetGroup:
          $ref: ./examples/DeviceManagement_GetGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device group properties.
          schema:
            $ref: '#/definitions/Group'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid
    delete:
      tags:
      - Device and Deployment Management
      description: Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.
      operationId: microsoftAzureDevicemanagementDeletegroup
      x-ms-examples:
        DeviceManagement_DeleteGroup:
          $ref: ./examples/DeviceManagement_DeleteGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: No content.
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Deviceupdate Instanceid Management Groups Groupid
  /deviceUpdate/{instanceId}/management/groups/{groupId}/updateCompliance:
    get:
      tags:
      - Device and Deployment Management
      description: Get 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 receiving a new update.
      operationId: microsoftAzureDevicemanagementGetupdatecomplianceforgroup
      x-ms-examples:
        DeviceManagement_GetUpdateComplianceForGroup:
          $ref: ./examples/DeviceManagement_GetUpdateComplianceForGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device group update compliance information.
          schema:
            $ref: '#/definitions/UpdateCompliance'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Updatecompliance
  /deviceUpdate/{instanceId}/management/groups/{groupId}/bestUpdates:
    get:
      tags:
      - Device and Deployment Management
      description: Get the best available updates for a device group and a count of how many devices need each update.
      operationId: microsoftAzureDevicemanagementListbestupdatesforgroup
      x-ms-examples:
        DeviceManagement_ListBestUpdatesForGroup:
          $ref: ./examples/DeviceManagement_ListBestUpdatesForGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - name: filter
        in: query
        required: false
        type: string
        description: Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version property. This filter is deprecated and should not be used.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The best available updates for a device group, the device class subgroup, and a count of how many devices need each update.
          schema:
            $ref: '#/definitions/DeviceClassSubgroupUpdatableDevicesList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/GroupBestUpdatesFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Bestupdates
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of deployments for a device group.
      operationId: microsoftAzureDevicemanagementListdeploymentsforgroup
      x-ms-examples:
        DeviceManagement_ListDeploymentsForGroup:
          $ref: ./examples/DeviceManagement_ListDeploymentsForGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: orderby
        in: query
        required: false
        type: string
        x-ms-client-name: orderBy
        description: Orders the set of deployments returned. You can order by start date.
      responses:
        '200':
          description: All deployments for the group.
          schema:
            $ref: '#/definitions/DeploymentsList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/DeploymentOrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the deployment properties.
      operationId: microsoftAzureDevicemanagementGetdeployment
      x-ms-examples:
        DeviceManagement_GetDeployment:
          $ref: ./examples/DeviceManagement_GetDeployment.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The deployment properties.
          schema:
            $ref: '#/definitions/Deployment'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid
    put:
      tags:
      - Device and Deployment Management
      description: Creates or updates a deployment.
      operationId: microsoftAzureDevicemanagementCreateorupdatedeployment
      x-ms-examples:
        DeviceManagement_CreateOrUpdateDeployment:
          $ref: ./examples/DeviceManagement_CreateOrUpdateDeployment.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: deployment
        in: body
        required: true
        schema:
          $ref: '#/definitions/Deployment'
        description: The deployment properties.
      responses:
        '200':
          description: The deployment properties.
          schema:
            $ref: '#/definitions/Deployment'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
      operationId: microsoftAzureDevicemanagementGetdeploymentstatus
      x-ms-examples:
        DeviceManagement_GetDeploymentStatus:
          $ref: ./examples/DeviceManagement_GetDeploymentStatus.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The status of the deployment.
          schema:
            $ref: '#/definitions/DeploymentStatus'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deployments Deploymentid Status
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups:
    get:
      tags:
      - Device and Deployment Management
      description: Get the device class subgroups for the group.
      operationId: microsoftAzureDevicemanagementListdeviceclasssubgroupsforgroup
      x-ms-examples:
        DeviceManagement_ListDeviceClassSubgroupsForGroup:
          $ref: ./examples/DeviceManagement_ListDeviceClassSubgroupsForGroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - name: filter
        in: query
        required: false
        type: string
        description: Restricts the set of device class subgroups returned. You can filter on compat properties by name and value.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device class subgroup details.
          schema:
            $ref: '#/definitions/DeviceClassSubgroupsList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/DeviceClassSubgroupFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets device class subgroup details.
      operationId: microsoftAzureDevicemanagementGetdeviceclasssubgroup
      x-ms-examples:
        DeviceManagement_GetGroupUpdateCompliance:
          $ref: ./examples/DeviceManagement_GetDeviceClassSubgroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device class subgroup details.
          schema:
            $ref: '#/definitions/DeviceClassSubgroup'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid
    delete:
      tags:
      - Device and Deployment Management
      description: Deletes a device class subgroup.
      operationId: microsoftAzureDevicemanagementDeletedeviceclasssubgroup
      x-ms-examples:
        DeviceManagement_DeleteDeviceClassSubgroup:
          $ref: ./examples/DeviceManagement_DeleteDeviceClassSubgroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: No content.
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/updateCompliance:
    get:
      tags:
      - Device and Deployment Management
      description: Get 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 progress on receiving a new update.
      operationId: microsoftAzureDevicemanagementGetdeviceclasssubgroupupdatecompliance
      x-ms-examples:
        DeviceManagement_GetDeviceClassSubgroupUpdateCompliance:
          $ref: ./examples/DeviceManagement_GetDeviceClassSubgroupUpdateCompliance.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The device class subgroup update compliance information.
          schema:
            $ref: '#/definitions/UpdateCompliance'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Updatecompliance
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/bestUpdates:
    get:
      tags:
      - Device and Deployment Management
      description: Get the best available update for a device class subgroup and a count of how many devices need this update.
      operationId: microsoftAzureDevicemanagementGetbestupdatesfordeviceclasssubgroup
      x-ms-examples:
        DeviceManagement_ListBestUpdatesForDeviceClassSubgroup:
          $ref: ./examples/DeviceManagement_GetBestUpdatesForDeviceClassSubgroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The best available update for a device class subgroup and a count of how many devices need this update.
          schema:
            $ref: '#/definitions/DeviceClassSubgroupUpdatableDevices'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Bestupdates
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments:
    get:
      tags:
      - Device and Deployment Management
      description: Gets a list of deployments for a device class subgroup.
      operationId: microsoftAzureDevicemanagementListdeploymentsfordeviceclasssubgroup
      x-ms-examples:
        DeviceManagement_ListDeploymentsForDeviceClassSubgroup:
          $ref: ./examples/DeviceManagement_ListDeploymentsForDeviceClassSubgroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: orderby
        in: query
        required: false
        type: string
        x-ms-client-name: orderBy
        description: Orders the set of deployments returned. You can order by start date.
      responses:
        '200':
          description: All deployments for the device class subgroup.
          schema:
            $ref: '#/definitions/DeploymentsList'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/DeploymentOrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments
  /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:
    get:
      tags:
      - Device and Deployment Management
      description: Gets the deployment properties.
      operationId: microsoftAzureDevicemanagementGetdeploymentfordeviceclasssubgroup
      x-ms-examples:
        DeviceManagement_GetDeploymentForDeviceClassSubgroup:
          $ref: ./examples/DeviceManagement_GetDeploymentForDeviceClassSubgroup.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The deployment properties.
          schema:
            $ref: '#/definitions/Deployment'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid
  ? /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:cancel
  : post:
      tags:
      - Device and Deployment Management
      description: Stops a deployment.
      operationId: microsoftAzureDevicemanagementStopdeployment
      x-ms-examples:
        DeviceManagement_CancelOrRetryDeployment:
          $ref: ./examples/DeviceManagement_StopDeployment.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The deployment properties.
          schema:
            $ref: '#/definitions/Deployment'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid:cancel
  ? /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:retry
  : post:
      tags:
      - Device and Deployment Management
      description: Retries a deployment with failed devices.
      operationId: microsoftAzureDevicemanagementRetrydeployment
      x-ms-examples:
        DeviceManagement_CancelOrRetryDeployment:
          $ref: ./examples/DeviceManagement_RetryDeployment.json
      parameters:
      - $ref: '#/parameters/InstanceIdParameter'
      - $ref: '#/parameters/GroupIdParameter'
      - $ref: '#/parameters/DeviceClassIdParameter'
      - $ref: '#/parameters/DeploymentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The deployment properties.
          schema:
            $ref: '#/definitions/Deployment'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Deviceupdate Instanceid Management Groups Groupid Deviceclasssubgroups Deviceclassid Deployments Deploymentid:retry
  ? /deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/status
  : get:
      tags:
      - Device and Deployment Management
      description: Gets the status of a deployme

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-device-and-deployment-management-api-openapi.yml
Microsoft Azure Device and Deployment Management API

Documentation

Specifications

Other Resources

OpenAPI Specification
