Device Update - Get Operation Status

Dienst:

Device Update

API-Version:

2022-10-01

Vorgang status 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	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.
operationId	path	True	string	Vorgangsbezeichner.
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	UpdateOperation	Vorgangsstatus Header Retry-After: string
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_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-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00: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	Aktualisieren Sie den Bezeichner.
UpdateInfo	Informationen aktualisieren.
UpdateOperation	Vorgangsmetadaten.

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 für Menschen 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 enthaltende Fehler.
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 für Menschen lesbare Darstellung des Fehlers.

OperationStatus

Vorgangsstatus

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

UpdateId

Aktualisieren Sie den Bezeichner.

Name	Typ	Beschreibung
name	string	Name aktualisieren.
provider	string	Updateanbieter.
version	string	Aktualisieren Sie die Version.

UpdateInfo

Informationen aktualisieren.

Name	Typ	Beschreibung
description	string	Aktualisieren Sie die Beschreibung.
friendlyName	string	Name des Anzeigeupdates.
updateId	UpdateId	Aktualisieren Sie den Bezeichner.

UpdateOperation

Vorgangsmetadaten.

Name	Typ	Beschreibung
createdDateTime	string	Datum und Uhrzeit in UTC, wann der Vorgang erstellt wurde.
error	Error	Vorgangsfehler, falls vorhanden.
etag	string	Vorgang ETag.
lastActionDateTime	string	Datum und Uhrzeit in UTC, zu dem der Vorgang status 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 von Microsoft-Support für die Problembehandlung verwendet werden kann.
update	UpdateInfo	Das Update, das importiert oder gelöscht wird. Beim Import wird diese Eigenschaft erst aufgefüllt, nachdem das Importmanifest erfolgreich verarbeitet wurde.