Device Update - Get Update

Referenz

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	Das Geräteupdate für IoT Hub Kontoendpunkt (nur Hostname, kein Protokoll).
instanceId	path	True	string	Das Geräteupdate für IoT Hub Konto instance Bezeichner.
name	path	True	string	Aktualisieren Sie den Namen.
provider	path	True	string	Aktualisieren des Anbieters.
version	path	True	string	Aktualisieren Sie die Version.
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 Bedingung If-None-Match. 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-Flow

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 zur Aktualisierung der Installationsanweisungen.
StepType	Schritttyp.
Update	Metadaten aktualisieren.
UpdateId	Aktualisieren Sie den Bezeichner.

Error

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Serverdefinierter Fehlercode.
details	Error[]	Ein Array von Fehlern, die zum 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	Datum und Uhrzeit in UTC, wann der Fehler aufgetreten ist.
target	string	Das Ziel des Fehlers.

ErrorResponse

Häufige Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

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

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als der, der vom enthaltenden Fehler bereitgestellt wurde.
errorDetail	string	Die interne Fehler- 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

Name	Typ	Beschreibung
steps	Step[]	Sammlung von Installationsschritten.

Step

Schritt zur Aktualisierung der Installationsanweisungen.

Name	Typ	Standardwert	Beschreibung
description	string		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		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		Auf die untergeordnete Updateidentität verwiesen. Erforderlich, wenn der Schritttyp verweis ist.

StepType

Schritttyp.

Name	Typ	Beschreibung
inline	string
reference	string

Update

Metadaten aktualisieren.

Name	Typ	Standardwert	Beschreibung
compatibility	object[]		Liste der Updatekompatibilitätsinformationen.
createdDateTime	string		Datum und Uhrzeit in UTC, wann das Update erstellt wurde.
description	string		Aktualisieren Sie die vom Ersteller angegebene Beschreibung.
etag	string		ETag aktualisieren.
friendlyName	string		Anzeigename des Updates, der vom Importprogramm angegeben wurde.
importedDateTime	string		Datum und Uhrzeit in UTC, wann das Update importiert wurde.
installedCriteria	string		Zeichenfolge, die vom Device Update-Client interpretiert wird, um zu bestimmen, ob das Update auf dem Gerät installiert ist. Veraltet im aktuellen 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 Aggregatscanergebnisses (berechnet anhand der Ergebnisse der Überprüfung der Nutzlastdatei).
updateId	UpdateId		Update-Identität.
updateType	string		Updatetyp. Veraltet im aktuellen Importmanifestschema.

UpdateId

Aktualisieren Sie den Bezeichner.

Name	Typ	Beschreibung
name	string	Aktualisieren Sie den Namen.
provider	string	Aktualisieren des Anbieters.
version	string	Aktualisieren Sie die Version.

Freigeben über