Microsoft Azure Devices API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Devices API
schemes:
- https
tags:
- name: Devices
paths:
  /sensor-partners/{sensorPartnerId}/devices:
    get:
      tags:
      - Devices
      description: Returns a paginated list of device resources.
      operationId: microsoftAzureDevicesList
      produces:
      - application/json
      parameters:
      - in: query
        name: parentDeviceIds
        description: Id's of the parent devices.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: deviceDataModelIds
        description: Id's of the device data models.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: path
        name: sensorPartnerId
        description: Id of the associated sensor partner.
        required: true
        type: string
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Devices_List:
          $ref: ./examples/Devices_List.json
      summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices
  /sensor-partners/{sensorPartnerId}/devices/{deviceId}:
    patch:
      tags:
      - Devices
      description: Create a device entity.
      operationId: microsoftAzureDevicesCreateorupdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: deviceDetails
        description: Device object details.
        required: true
        schema:
          $ref: '#/definitions/Device'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_CreateOrUpdate:
          $ref: ./examples/Devices_CreateOrUpdate.json
      summary: Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid
    get:
      tags:
      - Devices
      description: Gets a device entity.
      operationId: microsoftAzureDevicesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_Get:
          $ref: ./examples/Devices_Get.json
      summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid
    delete:
      tags:
      - Devices
      description: Deletes a device entity.
      operationId: microsoftAzureDevicesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_Delete:
          $ref: ./examples/Devices_Delete.json
      summary: Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid
  /devices:
    get:
      operationId: microsoftAzureDevicesList
      summary: 'Microsoft Azure Get The List Of Devices In An Application With Basic Odata Support Maxpagesize, Filter, Orderby , [more Details] Https: Aka Ms Iotcentralodatasupport'
      x-ms-examples:
        List devices:
          $ref: ./examples/devices_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/Filter'
      - $ref: '#/parameters/MaxPageSize'
      - $ref: '#/parameters/OrderBy'
      - $ref: '#/parameters/Expand'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}:
    get:
      operationId: microsoftAzureDevicesGet
      summary: Microsoft Azure Get A Device By Id
      description: Get details about an existing device by device ID.
      x-ms-examples:
        Get device by ID:
          $ref: ./examples/devices_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/Expand'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesCreate
      summary: Microsoft Azure Create Or Update A Device
      description: Create a new device.
      x-ms-examples:
        Create device:
          $ref: ./examples/devices_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device body.
        schema:
          $ref: '#/definitions/Device_2'
        required: true
      - $ref: '#/parameters/Expand'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdate
      summary: Microsoft Azure Update A Device Via Patch
      description: Update an existing device by ID.
      x-ms-examples:
        Update device:
          $ref: ./examples/devices_create.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/Expand'
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    delete:
      operationId: microsoftAzureDevicesRemove
      summary: Microsoft Azure Delete A Device
      description: Delete an existing device by device ID.
      x-ms-examples:
        Delete device:
          $ref: ./examples/devices_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/Expand'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/applyDeploymentManifest:
    post:
      operationId: microsoftAzureDevicesApplymanifest
      summary: Microsoft Azure Apply A Deployment Manifest To An Edge Device
      description: Apply a deployment manifest to an edge device.
      x-ms-examples:
        Apply device deployment manifest:
          $ref: ./examples/devices_applyDeploymentManifest.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Deployment Manifest data.
        schema:
          $ref: '#/definitions/DeploymentManifest'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeploymentManifest'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/attestation:
    get:
      operationId: microsoftAzureDevicesGetattestation
      summary: Microsoft Azure Get Device Attestation
      x-ms-examples:
        Get device attestation:
          $ref: ./examples/devices_attestations_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesCreateattestation
      summary: Microsoft Azure Create An Individual Device Attestation
      x-ms-examples:
        Create or update device attestation - Symmetric Key:
          $ref: ./examples/devices_attestations_set_symmetricKey.json
        Create or update device attestation - TPM:
          $ref: ./examples/devices_attestations_set_tpm.json
        Create or update device attestation - X509:
          $ref: ./examples/devices_attestations_set_x509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Individual device attestation body.
        schema:
          $ref: '#/definitions/Attestation'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdateattestation
      summary: Microsoft Azure Update An Individual Device Attestation Via Patch
      x-ms-examples:
        Update device attestation - Symmetric Key:
          $ref: ./examples/devices_attestations_set_symmetricKey.json
        Update device attestation - TPM:
          $ref: ./examples/devices_attestations_set_tpm.json
        Update device attestation - X509:
          $ref: ./examples/devices_attestations_set_x509.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Individual device attestation patch body.
        schema:
          type: object
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    delete:
      operationId: microsoftAzureDevicesRemoveattestation
      summary: Microsoft Azure Remove An Individual Device Attestation
      x-ms-examples:
        Delete device attestation:
          $ref: ./examples/devices_attestations_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetcommandhistory
      summary: Microsoft Azure Get Device Command History
      x-ms-examples:
        Get command history:
          $ref: ./examples/devices_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRuncommand
      summary: Microsoft Azure Run A Device Command
      description: Run a command on a device.
      x-ms-examples:
        Send command:
          $ref: ./examples/devices_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/components:
    get:
      operationId: microsoftAzureDevicesListcomponents
      summary: Microsoft Azure List The Components Present In A Device
      x-ms-examples:
        List components:
          $ref: ./examples/devices_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetcomponentcommandhistory
      summary: Microsoft Azure Get Component Command History
      x-ms-examples:
        Get command history:
          $ref: ./examples/devices_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRuncomponentcommand
      summary: Microsoft Azure Run A Component Command
      description: Run a command on a component.
      x-ms-examples:
        Send command:
          $ref: ./examples/devices_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/properties:
    get:
      operationId: microsoftAzureDevicesGetcomponentproperties
      summary: Microsoft Azure Get Device Properties For A Specific Component
      x-ms-examples:
        Get properties on components:
          $ref: ./examples/devices_properties_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/Unmodeled'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesReplacecomponentproperties
      summary: Microsoft Azure Replace Device Properties For A Specific Component
      x-ms-examples:
        Update properties on components:
          $ref: ./examples/devices_properties_components_set.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Device properties.
        schema:
          $ref: '#/definitions/DeviceProperties'
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdatecomponentproperties
      summary: Microsoft Azure Update Device Properties For A Specific Component Via Patch
      x-ms-examples:
        Update properties on components:
          $ref: ./examples/devices_properties_components_set.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Device properties patch.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}:
    get:
      operationId: microsoftAzureDevicesGetcomponenttelemetryvalue
      summary: Microsoft Azure Get Component Telemetry Value
      description: Get the last telemetry value from a component.
      x-ms-examples:
        Get telemetry:
          $ref: ./examples/devices_telemetry_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/TelemetryName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTelemetry'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/credentials:
    get:
      operationId: microsoftAzureDevicesGetcredentials
      summary: Microsoft Azure Get Device Credentials
      x-ms-examples:
        Get device credentials:
          $ref: ./examples/devicecredentials_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCredentials'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules:
    get:
      operationId: microsoftAzureDevicesListmodules
      summary: Microsoft Azure List The Modules Present In A Device
      x-ms-examples:
        List modules:
          $ref: ./examples/devices_modules_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetmodulecommandhistory
      summary: Microsoft Azure Get Module Command History
      x-ms-examples:
        Get command history within module:
          $ref: ./examples/modules_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRunmodulecommand
      summary: Microsoft Azure Run A Module Command
      description: Run a command on a module.
      x-ms-examples:
        Send command to module:
          $ref: ./examples/modules_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components:
    get:
      operationId: microsoftAzureDevicesListmodulecomponents
      summary: Microsoft Azure List The Components Present In A Module
      x-ms-examples:
        List module components:
          $ref: ./examples/devices_modules_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetmodulecomponentcommandhistory
      summary: Microsoft Azure Get Module Component Command History
      x-ms-examples:
        Get command history within module:
          $ref: ./examples/modules_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An

# --- truncated at 32 KB (213 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-devices-api-openapi.yml