Device Management - Get Device Module

Service:

Device Update

API-versie:

2022-10-01

Haalt de eigenschappen van de apparaatmodule en de meest recente implementatiestatus op voor een apparaatmodule die is verbonden met Device Update voor IoT Hub.

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

URI-parameters

Name	In	Vereist	Type	Description
deviceId	path	True	string	Apparaat-id in Azure IoT Hub.
endpoint	path	True	string (url)	De apparaatupdate voor het eindpunt van het IoT Hub-account (alleen hostnaam, geen protocol).
instanceId	path	True	string	De apparaatupdate voor de exemplaar-id van het IoT Hub-account.
moduleId	path	True	string	Apparaatmodule-id in Azure IoT Hub.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name	Type	Description
200 OK	Device	De apparaateigenschappen en de meest recente implementatiestatus.
Other Status Codes	ErrorResponse	Standaardantwoord.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

DeviceManagement_GetDevice

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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": ""
      }
    ]
  }
}

Definities

Name	Description
Device	Metagegevens van het apparaat.
DeviceDeploymentState	Implementatiestatus.
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
InstallResult	Het installatieresultaat van een update en eventuele stapresultaten eronder.
StepResult	Het stapresultaat onder een update.
UpdateId	Id bijwerken.
UpdateInfo	Informatie bijwerken.

Device

Object

Metagegevens van het apparaat.

Name	Type	Description
deploymentStatus	DeviceDeploymentState	Status van het apparaat in de laatste implementatie.
deviceClassId	string	Apparaatklasse-id.
deviceId	string	Apparaat-id.
groupId	string	Apparaatgroep-id.
installedUpdate	UpdateInfo	Momenteel geïnstalleerde update op het apparaat.
lastAttemptedUpdate	UpdateInfo	De update die het apparaat voor het laatst heeft geprobeerd te installeren.
lastDeploymentId	string	De implementatie-id voor de laatste implementatie op het apparaat
lastInstallResult	InstallResult	Laatste installatieresultaat.
moduleId	string	Apparaatmodule-id.
onLatestUpdate	boolean	Booleaanse vlag die aangeeft of de meest recente update (de beste compatibele update voor de apparaatklasse en -groep) op het apparaat is geïnstalleerd

DeviceDeploymentState

Inventarisatie

Implementatiestatus.

Waarde	Description
Canceled	De implementatie is geannuleerd.
Failed	De implementatie is voltooid met een fout.
InProgress	De implementatie wordt uitgevoerd.
Succeeded	De implementatie is voltooid met succes.

Error

Object

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix met fouten die hebben geleid tot de gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
occurredDateTime	string (date-time)	Datum en tijd in UTC wanneer de fout is opgetreden.
target	string	Het doel van de fout.

ErrorResponse

Object

Veelvoorkomende foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Object

Een object met meer specifieke informatie dan het huidige object over de fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan de foutcode die is opgegeven door de bijbehorende fout.
errorDetail	string	Het interne foutbericht of het uitzonderingsbericht.
innerError	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.

InstallResult

Object

Het installatieresultaat van een update en eventuele stapresultaten eronder.

Name	Type	Description
extendedResultCode	integer	Uitgebreide resultaatcode installeren
resultCode	integer	Resultaatcode installeren.
resultDetails	string	Een tekenreeks met meer informatie over het installatieresultaat
stepResults	StepResult[]	Matrix van stapresultaten

StepResult

Object

Het stapresultaat onder een update.

Name	Type	Description
description	string	Beschrijving van stap.
extendedResultCode	integer	Uitgebreide resultaatcode installeren
resultCode	integer	Resultaatcode installeren.
resultDetails	string	Een tekenreeks met meer informatie over het installatieresultaat
update	UpdateInfo	De update die door deze stap wordt geïnstalleerd als deze van het referentietype is.

UpdateId

Object

Id bijwerken.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Updateprovider.
version	string	Updateversie.

UpdateInfo

Object

Informatie bijwerken.

Name	Type	Description
description	string	Beschrijving bijwerken.
friendlyName	string	Beschrijvende updatenaam.
updateId	UpdateId	Id bijwerken.