Device Update - Get Update

Dienst:

Device Update

API-Version:

2022-10-01

Rufen Sie eine bestimmte Updateversion ab.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Geräteupdate für IoT Hub-Kontoendpunkt (nur Hostname, kein Protokoll).
instanceId	path	True	string	Der Geräteupdate für IoT Hub-Kontoinstanzbezeichner.
name	path	True	string	Updatename.
provider	path	True	string	Updateanbieter.
version	path	True	string	Updateversion.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-None-Match		string	Definiert die If-None-Match-Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.

Antworten

Name	Typ	Beschreibung
200 OK	Update	Die angeforderte Updateversion.
Other Status Codes	ErrorResponse	Standardantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://api.adu.microsoft.com/.default	Standardautorisierungsbereich.

Beispiele

DeviceUpdate_GetUpdate

Beispielanforderung

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01

Beispiel für eine Antwort

Statuscode:

200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "instructions": {
    "steps": [
      {
        "description": "pre-install script",
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "--pre-install"
        },
        "files": [
          "configure.sh"
        ]
      },
      {
        "type": "reference",
        "updateId": {
          "provider": "microsoft",
          "name": "sensor",
          "version": "1.0"
        }
      }
    ]
  },
  "manifestVersion": "5.0",
  "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
  "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Definitionen

Name	Beschreibung
Error	Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort.
InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
Instructions
Step	Schritt der Installationsanweisung aktualisieren.
StepType	Schritttyp.
Update	Aktualisieren von Metadaten.
UpdateId	Updatebezeichner.

Error

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Serverdefinierter Fehlercode.
details	Error[]	Ein Array von Fehlern, die zu dem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
occurredDateTime	string (date-time)	Datum und Uhrzeit in UTC, wenn der Fehler aufgetreten ist.
target	string	Das Ziel des Fehlers.

ErrorResponse

Objekt

Häufige Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Objekt

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als das, was vom enthaltenden Fehler bereitgestellt wurde.
errorDetail	string	Die interne Fehlermeldung oder Ausnahmemeldung.
innerError	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

Instructions

Objekt

Name	Typ	Beschreibung
steps	Step[]	Sammlung der Installationsschritte.

Step

Objekt

Schritt der Installationsanweisung aktualisieren.

Name	Typ	Standardwert	Beschreibung
description	string minLength: 1 maxLength: 64		Schrittbeschreibung.
files	string[]		Sammlung von Dateinamen, die während der Ausführung an den Handler übergeben werden sollen. Erforderlich, wenn der Schritttyp inline ist.
handler	string minLength: 1 maxLength: 32		Die Identität des Handlers, der diesen Schritt ausführt. Erforderlich, wenn der Schritttyp inline ist.
handlerProperties	object		Parameter, die während der Ausführung an den Handler übergeben werden sollen.
type	StepType	inline	Schritttyp.
updateId	UpdateId		Referenzierte untergeordnete Updateidentität. Erforderlich, wenn der Schritttyp referenziert ist.

StepType

Enumeration

Schritttyp.

Wert	Beschreibung
inline
reference

Update

Objekt

Aktualisieren von Metadaten.

Name	Typ	Standardwert	Beschreibung
compatibility	object[]		Liste der Updatekompatibilitätsinformationen.
createdDateTime	string (date-time)		Datum und Uhrzeit in UTC, wann das Update erstellt wurde.
description	string minLength: 1 maxLength: 512		Aktualisieren Sie die vom Ersteller angegebene Beschreibung.
etag	string		ETag aktualisieren.
friendlyName	string minLength: 1 maxLength: 512		Anzeigeaktualisierungsname, der vom Importeur angegeben wird.
importedDateTime	string (date-time)		Datum und Uhrzeit in UTC, zu dem das Update importiert wurde.
installedCriteria	string		Vom Geräteupdateclient interpretierte Zeichenfolge, um festzustellen, ob das Update auf dem Gerät installiert ist. Veraltet im neuesten Importmanifestschema.
instructions	Instructions		Installationsanweisungen aktualisieren.
isDeployable	boolean	True	Gibt an, ob das Update eigenständig auf einem Gerät bereitgestellt werden kann.
manifestVersion	string		Schemaversion des Manifests, das zum Importieren des Updates verwendet wird.
referencedBy	UpdateId[]		Liste der Updateidentitäten, die auf dieses Update verweisen.
scanResult	string		Aktualisieren des aggregierten Scanergebnisses (berechnet aus Ergebnissen der Nutzlastdateiüberprüfung).
updateId	UpdateId		Identität aktualisieren.
updateType	string		Updatetyp. Veraltet im neuesten Importmanifestschema.

UpdateId

Objekt

Updatebezeichner.

Name	Typ	Beschreibung
name	string	Updatename.
provider	string	Updateanbieter.
version	string	Updateversion.