Device Update - Get Operation Status

Usługa:

Device Update

Wersja interfejsu API:

2022-10-01

Pobieranie stanu operacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Aktualizacja urządzenia dla punktu końcowego konta IoT Hub (tylko nazwa hosta, bez protokołu).
instanceId	path	True	string	Aktualizacja urządzenia dla identyfikatora wystąpienia konta IoT Hub.
operationId	path	True	string	Identyfikator operacji.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-None-Match		string	Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UpdateOperation	Stan operacji. Nagłówki Retry-After: string
Other Status Codes	ErrorResponse	Domyślna odpowiedź.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://api.adu.microsoft.com/.default	Domyślny zakres autoryzacji.

Przykłady

DeviceUpdate_GetOperationStatus

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
Error	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błąd.
InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
OperationStatus	Stan operacji.
UpdateId	Zaktualizuj identyfikator.
UpdateInfo	Aktualizowanie informacji.
UpdateOperation	Metadane operacji.

Error

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez serwer.
details	Error[]	Tablica błędów, które doprowadziły do zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
occurredDateTime	string	Data i godzina w formacie UTC, kiedy wystąpił błąd.
target	string	Element docelowy błędu.

ErrorResponse

Typowa odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Szczegóły błędu.

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż podany przez błąd zawierający.
errorDetail	string	Wewnętrzny błąd lub komunikat o wyjątku.
innerError	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.

OperationStatus

Stan operacji.

Nazwa	Typ	Opis
Failed	string	Operacja w tle zakończyła się niepowodzeniem.
NotStarted	string	Operacja w tle została utworzona, ale nie została jeszcze uruchomiona.
Running	string	Operacja w tle jest obecnie uruchomiona.
Succeeded	string	Operacja w tle zakończyła się powodzeniem.

UpdateId

Zaktualizuj identyfikator.

Nazwa	Typ	Opis
name	string	Zaktualizuj nazwę.
provider	string	Aktualizuj dostawcę.
version	string	Zaktualizuj wersję.

UpdateInfo

Aktualizowanie informacji.

Nazwa	Typ	Opis
description	string	Opis aktualizacji.
friendlyName	string	Przyjazna nazwa aktualizacji.
updateId	UpdateId	Zaktualizuj identyfikator.

UpdateOperation

Metadane operacji.

Nazwa	Typ	Opis
createdDateTime	string	Data i godzina w formacie UTC podczas tworzenia operacji.
error	Error	Napotkano błąd operacji, jeśli istnieje.
etag	string	Operacja ETag.
lastActionDateTime	string	Data i godzina w formacie UTC po ostatniej aktualizacji stanu operacji.
operationId	string	Identyfikator operacji.
resourceLocation	string	Lokalizacja zaimportowanej aktualizacji, gdy operacja zakończy się pomyślnie.
status	OperationStatus	Stan operacji.
traceId	string	Tożsamość korelacji operacji, która może być używana przez pomoc techniczna firmy Microsoft do rozwiązywania problemów.
update	UpdateInfo	Aktualizacja jest importowana lub usuwana. W przypadku importowania ta właściwość zostanie wypełniona tylko po pomyślnym przetworzeniu manifestu importu.