Device Update - Get File

Reference

Služba:: Device Update

Verze rozhraní API:: 2022-10-01

Získejte z verze konkrétní aktualizační soubor.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}?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).
fileId	path	True	string	Identifikátor souboru.
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	UpdateFile	Požadovaná entita souboru.
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_GetFile

Ukázkový požadavek

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0/files/abc123?api-version=2022-10-01

Ukázková odpověď

Stavový kód:: 200

{
  "fileId": "abc123",
  "fileName": "1v5uww1q.my2",
  "sizeInBytes": 1862311,
  "hashes": {
    "sha256": "OVokcktf61lQXs17MzJCsM98lk48H1Wu1hy7Sp6lLfI="
  },
  "mimeType": "application/BuildAsync-s4jwikgq.44h",
  "etag": "\"26bd8eba-4bb2-4960-a357-ca4d60b5fb4b\""
}

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.
UpdateFile	Aktualizujte metadata souboru.
UpdateFileBase	Aktualizujte základní metadata souboru.
UpdateFileDownloadHandler	Obslužná rutina stahování pro využití souvisejících souborů ke stažení souboru datové části.

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.

UpdateFile

Aktualizujte metadata souboru.

Name	Typ	Description
downloadHandler	UpdateFileDownloadHandler	Volitelná obslužná rutina stahování pro využití souvisejících souborů ke stažení datové části souboru.
etag	string	Značka ETag souboru.
fileId	string	Identita souboru vygenerovaná serverem při importu.
fileName	string	Název souboru.
hashes	object	Mapování hashovacího algoritmu na hodnoty hash v kódování Base64
mimeType	string	Typ MIME souboru.
properties	object	Volitelné vlastnosti souboru (nespotřebované službou, ale předávané do zařízení)
relatedFiles	UpdateFileBase[]	Volitelná metadata souvisejících souborů používaná společně s metadaty DownloadHandler ke stažení datové části souboru.
scanDetails	string	Podrobnosti kontroly antimalwarového softwaru.
scanResult	string	Výsledek kontroly antimalwarového softwaru.
sizeInBytes	integer	Velikost souboru v počtu bajtů

UpdateFileBase

Aktualizujte základní metadata souboru.

Name	Typ	Description
fileName	string	Název souboru.
hashes	object	Mapování hashovacího algoritmu na hodnoty hash v kódování Base64
mimeType	string	Typ MIME souboru.
properties	object	Volitelné vlastnosti souboru (nespotřebované službou, ale předávané do zařízení)
scanDetails	string	Podrobnosti kontroly antimalwarového softwaru.
scanResult	string	Výsledek kontroly antimalwarového softwaru.
sizeInBytes	integer	Velikost souboru v počtu bajtů

UpdateFileDownloadHandler

Obslužná rutina stahování pro využití souvisejících souborů ke stažení souboru datové části.

Name	Typ	Description
id	string	Identifikátor obslužné rutiny stahování.

Sdílet prostřednictvím