Device Update - Get Operation Status

Dienst:: Device Update

API-Version:: 2022-10-01

Vorgangsstatus abrufen.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?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.
operationId	path	True	string minLength: 1 maxLength: 256	Vorgangsbezeichner.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang 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	UpdateOperation	Die Anforderung ist erfolgreich. Header Retry-After: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

UpdateOperation

Die Anforderung ist erfolgreich.

Header

Retry-After: string

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

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

Bereiche

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

Beispiele

DeviceUpdate_GetOperationStatus

Beispielanforderung

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T14:00:53.2548897-07:00",
  "lastActionDateTime": "2020-04-22T14:01:43.940142-07:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

Definitionen

Name	Beschreibung
Error	Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort.
InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
OperationStatus	Vorgangsstatus.
UpdateId	Updatebezeichner.
UpdateInfo	Aktualisieren von Informationen.
UpdateOperation	Vorgangsmetadaten.

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.

OperationStatus

Enumeration

Vorgangsstatus.

Wert	Beschreibung
NotStarted	Der Hintergrundvorgang wurde erstellt, aber noch nicht gestartet.
Running	Der Hintergrundvorgang wird zurzeit ausgeführt.
Succeeded	Der Hintergrundvorgang wurde erfolgreich abgeschlossen.
Failed	Der Hintergrundvorgang wurde mit einem Fehler abgeschlossen.

UpdateId

Objekt

Updatebezeichner.

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

UpdateInfo

Objekt

Aktualisieren von Informationen.

Name	Typ	Beschreibung
description	string	Beschreibung aktualisieren.
friendlyName	string	Anzeigeaktualisierungsname.
updateId	UpdateId	Updatebezeichner.

UpdateOperation

Objekt

Vorgangsmetadaten.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Datum und Uhrzeit in UTC, wann der Vorgang erstellt wurde.
error	Error	Fehler beim Vorgang, falls vorhanden.
etag	string	Vorgang ETag.
lastActionDateTime	string (date-time)	Datum und Uhrzeit in UTC, wann der Vorgangsstatus zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID.
resourceLocation	string	Speicherort des importierten Updates, wenn der Vorgang erfolgreich ist.
status	OperationStatus	Vorgangsstatus.
traceId	string	Vorgangskorrelationsidentität, die vom Microsoft-Support für die Problembehandlung verwendet werden kann.
update	UpdateInfo	Das Update, das importiert oder gelöscht wird. Für den Import wird diese Eigenschaft erst aufgefüllt, nachdem das Importmanifest erfolgreich verarbeitet wurde.