Device Update - Get Update

Odwołanie

Usługa:: Device Update

Wersja interfejsu API:: 2022-10-01

Pobierz określoną wersję aktualizacji.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?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.
name	path	True	string	Zaktualizuj nazwę.
provider	path	True	string	Aktualizuj dostawcę.
version	path	True	string	Aktualizacja wersji.
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	Update	Żądana wersja aktualizacji.
Other Status Codes	ErrorResponse	Odpowiedź domyślna.

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_GetUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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\""
}

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.
Instructions
Step	Aktualizowanie kroku instrukcji instalacji.
StepType	Typ kroku.
Update	Aktualizowanie metadanych.
UpdateId	Aktualizowanie identyfikatora.

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	Błąd wewnętrzny 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.

Instructions

Nazwa	Typ	Opis
steps	Step[]	Kolekcja kroków instalacji.

Step

Aktualizowanie kroku instrukcji instalacji.

Nazwa	Typ	Domyślna wartość	Opis
description	string		Opis kroku.
files	string[]		Kolekcja nazw plików, które mają zostać przekazane do programu obsługi podczas wykonywania. Wymagane, jeśli typ kroku jest wbudowany.
handler	string		Tożsamość programu obsługi, która wykona ten krok. Wymagane, jeśli typ kroku jest wbudowany.
handlerProperties	object		Parametry, które mają być przekazywane do procedury obsługi podczas wykonywania.
type	StepType	inline	Typ kroku.
updateId	UpdateId		Przywołyliśmy tożsamość aktualizacji podrzędnej. Wymagane, jeśli typ kroku jest odwołaniem.

StepType

Typ kroku.

Nazwa	Typ	Opis
inline	string
reference	string

Update

Aktualizowanie metadanych.

Nazwa	Typ	Domyślna wartość	Opis
compatibility	object[]		Lista informacji o zgodności aktualizacji.
createdDateTime	string		Data i godzina w formacie UTC utworzenia aktualizacji.
description	string		Opis aktualizacji określony przez twórcę.
etag	string		Zaktualizuj element ETag.
friendlyName	string		Przyjazna nazwa aktualizacji określona przez importera.
importedDateTime	string		Data i godzina w formacie UTC podczas importowania aktualizacji.
installedCriteria	string		Ciąg interpretowany przez klienta usługi Device Update w celu określenia, czy aktualizacja jest zainstalowana na urządzeniu. Przestarzałe w najnowszym schemacie manifestu importu.
instructions	Instructions		Aktualizowanie instrukcji instalacji.
isDeployable	boolean	True	Określa, czy aktualizację można wdrożyć na urządzeniu samodzielnie.
manifestVersion	string		Wersja schematu manifestu używana do importowania aktualizacji.
referencedBy	UpdateId[]		Lista tożsamości aktualizacji odwołujących się do tej aktualizacji.
scanResult	string		Zaktualizuj wyniki skanowania zagregowanego (obliczone na podstawie wyników skanowania pliku ładunku).
updateId	UpdateId		Aktualizowanie tożsamości.
updateType	string		Typ aktualizacji. Przestarzałe w najnowszym schemacie manifestu importu.

UpdateId

Aktualizowanie identyfikatora.

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

Udostępnij za pośrednictwem