Device Management - Get Device Module

Tjänst:

Device Update

API-version:

2026-06-01

Hämtar egenskaperna för enhetsmodulen och den senaste distributionsstatusen för en enhetsmodul som är ansluten till Enhetsuppdatering för IoT Hub.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}?api-version=2026-06-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deviceId	path	True	string	Enhetsidentifierare i Azure IoT Hub.
endpoint	path	True	string (url)	Enhetsuppdatering för IoT Hub-kontoslutpunkten (endast värdnamn, inget protokoll).
instanceId	path	True	string	Enhetsuppdatering för IoT Hub-kontoinstansidentifierare.
moduleId	path	True	string	Enhetsmodulidentifierare i Azure IoT Hub.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	Device	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://api.adu.microsoft.com/.default

Exempel

DeviceManagement_GetDeviceModule

Exempelbegäran

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/devices/deviceId/modules/moduleId?api-version=2026-06-01

Exempelsvar

Statuskod:

200

{
  "deviceId": "device1",
  "moduleId": "module1",
  "deviceClassId": "deviceClassId1",
  "lastAttemptedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "2.0.0.0"
    }
  },
  "deploymentStatus": "Failed",
  "installedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "1.0.0.0"
    }
  },
  "onLatestUpdate": false,
  "lastInstallResult": {
    "resultCode": 200,
    "extendedResultCode": 0,
    "resultDetails": "",
    "stepResults": [
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralcamera",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      },
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralspeaker",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      }
    ]
  }
}

Definitioner

Name	Description
Device	Enhetsmetadata.
DeviceDeploymentState	Distributionstillstånd.
Error	Felinformation.
ErrorResponse	Vanligt felsvar.
InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
InstallResult	Installationsresultatet för en uppdatering och eventuella stegresultat under den.
StepResult	Stegresultatet under en uppdatering.
UpdateId	Uppdatera identifierare.
UpdateInfo	Uppdatera information.

Device

Objekt

Enhetsmetadata.

Name	Typ	Description
deploymentStatus	DeviceDeploymentState	Enhetens tillstånd i den senaste distributionen.
deviceClassId	string	Enhetsklassidentitet.
deviceId	string	Enhetsidentitet.
groupId	string	Enhetsgruppsidentitet.
installedUpdate	UpdateInfo	För närvarande installerad uppdatering på enheten.
lastAttemptedUpdate	UpdateInfo	Uppdateringen som enheten senast försökte installera.
lastDeploymentId	string	Distributionsidentifieraren för den senaste distributionen till enheten
lastInstallResult	InstallResult	Resultat av senaste installation.
moduleId	string	Enhetsmodulidentitet.
onLatestUpdate	boolean	Boolesk flagga som anger om den senaste uppdateringen (den bästa kompatibla uppdateringen för enhetens enhetsklass och grupp) är installerad på enheten

DeviceDeploymentState

Uppräkning

Distributionstillstånd.

Värde	Description
Succeeded	Distributionen har slutförts med framgång.
InProgress	Distribution pågår.
Canceled	Distributionen avbröts.
Failed	Distributionen har slutförts med fel.

Error

Objekt

Felinformation.

Name	Typ	Description
code	string	Serverdefinierad felkod.
details	Error[]	En matris med fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
occurredDateTime	string (date-time)	Datum och tid i UTC när felet inträffade.
target	string	Målet för felet.

ErrorResponse

Objekt

Vanligt felsvar.

Name	Typ	Description
error	Error	Felinformationen.

InnerError

Objekt

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
errorDetail	string	Det interna felet eller undantagsmeddelandet.
innerError	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.

InstallResult

Objekt

Installationsresultatet för en uppdatering och eventuella stegresultat under den.

Name	Typ	Description
extendedResultCode	integer (int32)	Installera utökad resultatkod
resultCode	integer (int32)	Installera resultatkod.
resultDetails	string	En sträng som innehåller ytterligare information om installationsresultatet
stepResults	StepResult[]	Matris med stegresultat

StepResult

Objekt

Stegresultatet under en uppdatering.

Name	Typ	Description
description	string	Stegbeskrivning.
extendedResultCode	integer (int32)	Installera utökad resultatkod
resultCode	integer (int32)	Installera resultatkod.
resultDetails	string	En sträng som innehåller ytterligare information om installationsresultatet
update	UpdateInfo	Uppdateringen som det här steget installerar om den är av referenstyp.

UpdateId

Objekt

Uppdatera identifierare.

Name	Typ	Description
name	string	Uppdateringsnamn.
provider	string	Uppdateringsprovider.
version	string	Uppdatera version.

UpdateInfo

Objekt

Uppdatera information.

Name	Typ	Description
description	string	Uppdateringsbeskrivning.
friendlyName	string	Eget uppdateringsnamn.
updateId	UpdateId	Uppdatera identifierare.