Device Update - Get Update

Reference

Služba:: Device Update

Verze rozhraní API:: 2022-10-01

Získejte konkrétní verzi aktualizace.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Aktualizace zařízení pro IoT Hub koncový bod účtu (jenom název hostitele, bez protokolu).
instanceId	path	True	string	Device Update pro IoT Hub identifikátor instance účtu.
name	path	True	string	Aktualizovat název.
provider	path	True	string	Poskytovatel aktualizace.
version	path	True	string	Aktualizovat verzi.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-None-Match		string	Definuje podmínku If-None-Match. Operace se provede pouze v případě, že značka ETag na serveru neodpovídá této hodnotě.

Odpovědi

Name	Typ	Description
200 OK	Update	Požadovaná verze aktualizace.
Other Status Codes	ErrorResponse	Výchozí odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://api.adu.microsoft.com/.default	Výchozí obor autorizace.

Příklady

DeviceUpdate_GetUpdate

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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\""
}

Definice

Name	Description
Error	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď.
InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
Instructions
Step	Krok s pokyny k instalaci aktualizace
StepType	Typ kroku.
Update	Aktualizujte metadata.
UpdateId	Identifikátor aktualizace.

Error

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby definovaný serverem
details	Error[]	Pole chyb, které vedly k nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
occurredDateTime	string	Datum a čas ve standardu UTC, kdy došlo k chybě.
target	string	Cíl chyby.

ErrorResponse

Běžná chybová odpověď.

Name	Typ	Description
error	Error	Podrobnosti o chybě.

InnerError

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

Name	Typ	Description
code	string	Konkrétnější kód chyby, než jaký byl poskytnut v obsahující chybě.
errorDetail	string	Vnitřní chyba nebo zpráva o výjimce.
innerError	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.

Instructions

Name	Typ	Description
steps	Step[]	Kolekce kroků instalace.

Step

Krok s pokyny k instalaci aktualizace

Name	Typ	Default value	Description
description	string		Popis kroku.
files	string[]		Kolekce názvů souborů, které mají být předány obslužné rutině během provádění. Vyžaduje se, pokud je typ kroku vložený.
handler	string		Identita obslužné rutiny, která provede tento krok. Vyžaduje se, pokud je typ kroku vložený.
handlerProperties	object		Parametry, které mají být předány obslužné rutině během provádění.
type	StepType	inline	Typ kroku.
updateId	UpdateId		Odkazovaná podřízená identita aktualizace. Vyžaduje se, pokud je typ kroku odkazem.

StepType

Typ kroku.

Name	Typ	Description
inline	string
reference	string

Update

Aktualizujte metadata.

Name	Typ	Default value	Description
compatibility	object[]		Seznam informací o kompatibilitě aktualizací
createdDateTime	string		Datum a čas ve standardu UTC, kdy byla aktualizace vytvořena.
description	string		Popis aktualizace určený tvůrcem
etag	string		Aktualizovat ETag.
friendlyName	string		Popisný název aktualizace určený dovozcem
importedDateTime	string		Datum a čas ve standardu UTC, kdy byla aktualizace importována.
installedCriteria	string		Řetězec interpretovaný klientem služby Device Update k určení, jestli je aktualizace na zařízení nainstalovaná. Zastaralé v nejnovějším schématu manifestu importu.
instructions	Instructions		Aktualizujte pokyny k instalaci.
isDeployable	boolean	True	Určuje, jestli je možné aktualizaci nasadit do zařízení samostatně.
manifestVersion	string		Verze schématu manifestu použitého k importu aktualizace.
referencedBy	UpdateId[]		Seznam identit aktualizací, které odkazují na tuto aktualizaci
scanResult	string		Aktualizujte agregovaný výsledek kontroly (počítaný z výsledků kontroly datové části souboru).
updateId	UpdateId		Aktualizovat identitu.
updateType	string		Typ aktualizace. Zastaralé v nejnovějším schématu manifestu importu.

UpdateId

Identifikátor aktualizace.

Name	Typ	Description
name	string	Aktualizovat název.
provider	string	Poskytovatel aktualizace.
version	string	Aktualizovat verzi.

Sdílet prostřednictvím