Device Update - Get Operation Status

Service:

Device Update

API-versie:

2022-10-01

Bewerkingsstatus ophalen.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?api-version=2022-10-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	De Apparaatupdate voor IoT Hub accounteindpunt (alleen hostnaam, geen protocol).
instanceId	path	True	string	De apparaatupdate voor IoT Hub accountinstantie-id.
operationId	path	True	string	Bewerkings-id.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-None-Match		string	Definieert de voorwaarde If-None-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server niet overeenkomt met deze waarde.

Antwoorden

Name	Type	Description
200 OK	UpdateOperation	Bewerkingsstatus. Kopteksten Retry-After: string
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

DeviceUpdate_GetOperationStatus

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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\""
}

Definities

Name	Description
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
OperationStatus	Bewerkingsstatus.
UpdateId	Id bijwerken.
UpdateInfo	Informatie bijwerken.
UpdateOperation	Bewerkingsmetagegevens.

Error

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix met fouten die tot de gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
occurredDateTime	string	De datum en tijd in UTC waarop de fout is opgetreden.
target	string	Het doel van de fout.

ErrorResponse

Veelvoorkomende foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

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

OperationStatus

Bewerkingsstatus.

Name	Type	Description
Failed	string	De bewerking op de achtergrond is voltooid met een fout.
NotStarted	string	Achtergrondbewerking gemaakt maar nog niet gestart.
Running	string	De bewerking op de achtergrond wordt momenteel uitgevoerd.
Succeeded	string	De bewerking op de achtergrond is voltooid met succes.

UpdateId

Id bijwerken.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Provider bijwerken.
version	string	Versie bijwerken.

UpdateInfo

Informatie bijwerken.

Name	Type	Description
description	string	Beschrijving bijwerken.
friendlyName	string	Beschrijvende naam van update.
updateId	UpdateId	Id bijwerken.

UpdateOperation

Bewerkingsmetagegevens.

Name	Type	Description
createdDateTime	string	De datum en tijd in UTC waarop de bewerking is gemaakt.
error	Error	Er is een bewerkingsfout opgetreden, indien aanwezig.
etag	string	Bewerking ETag.
lastActionDateTime	string	De datum en tijd in UTC waarop de bewerkingsstatus voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id.
resourceLocation	string	Locatie van de geïmporteerde update wanneer de bewerking is geslaagd.
status	OperationStatus	Bewerkingsstatus.
traceId	string	De correlatie-identiteit van de bewerking die door Microsoft Ondersteuning kan worden gebruikt voor het oplossen van problemen.
update	UpdateInfo	De update die wordt geïmporteerd of verwijderd. Voor importeren wordt deze eigenschap alleen ingevuld nadat het importmanifest is verwerkt.