Updates - Import Update

Služba:

Device Update

Verze rozhraní API:

2020-09-01

Importujte novou verzi aktualizace.

POST https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates?action=import

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountEndpoint	path	True	string	Koncový bod účtu.
instanceId	path	True	string	Identifikátor instance účtu.
action	query	True	ImportAction	Akce importu aktualizace.

Text požadavku

Name	Vyžadováno	Typ	Description
files	True	FileImportMetadata[]	Jedna nebo více vlastností souboru aktualizace, jako je název souboru a zdrojová adresa URL.
importManifest	True	ImportManifestMetadata	Naimportujte metadata manifestu, jako je zdrojová adresa URL, velikost nebo hodnoty hash souboru atd.

Odpovědi

Name	Typ	Description
202 Accepted		Přijatá žádost o import aktualizací; Umístění operace na pozadí pro sledování stavu je zadané v hlavičce odpovědi Operation-Location. Hlavičky Location: string Operation-Location: string
429 Too Many Requests		Příliš mnoho žádostí; existuje omezení rychlosti, kolik operací je možné provést během časového období, a existuje také omezení počtu souběžných operací importu a odstranění na pozadí.

Zabezpečení

azure_auth_implicit

Implicitní tok Azure Active Directory OAuth2

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

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

azure_auth_code

Tok přístupového kódu OAuth2 v Azure Active Directory

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

azure_auth_application

Tok aplikace Azure Active Directory OAuth2

Typ: oauth2
Tok: application
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

Name	Description
.default	Obor přihlašovacích údajů klienta

azure_auth_password

Tok hesel Azure Active Directory OAuth2

Typ: oauth2
Tok: password
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Updates_ImportUpdate

Ukázkový požadavek

HTTP

POST https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates?action=import

{
  "importManifest": {
    "url": "http://test.blob.core.windows.net/test/uploadimportMan.json",
    "sizeInBytes": 816,
    "hashes": {
      "sha256": "O19LyyncPe1AGstOdkcmozLV8pSbBdqrE18HdYVohRc="
    }
  },
  "files": [
    {
      "filename": "file1.bin",
      "url": "http://test.blob.core.windows.net/test/upload1v5uww1q"
    },
    {
      "filename": "file2.bin",
      "url": "http://test.blob.core.windows.net/test/uploadkrmn5yw0"
    },
    {
      "filename": "file3.bin",
      "url": "http://test.blob.core.windows.net/test/uploaddq52ky5m"
    }
  ]
}

Ukázková odpověď

Stavový kód:

202

Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
Operation-Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f

Stavový kód:

429

Definice

Name	Description
FileImportMetadata	Metadata popisující aktualizační soubor
ImportAction	Akce importu aktualizace.
ImportManifestMetadata	Metadata popisující manifest importu, dokument, který popisuje soubory a další metadata verze aktualizace.
ImportUpdateInput	Importuje vstupní metadata aktualizace.

FileImportMetadata

Metadata popisující aktualizační soubor

Name	Typ	Description
filename	string	Aktualizujte název souboru zadaný v manifestu importu.
url	string	Umístění objektu blob Azure, ze kterého je možné stáhnout soubor aktualizace pomocí služby Device Update pro IoT Hub. Obvykle se jedná o adresu URL objektu blob chráněnou jen pro čtení SAS s vypršením platnosti nastavenou na alespoň 4 hodiny.

ImportAction

Akce importu aktualizace.

Name	Typ	Description
import	string	Akce importu.

ImportManifestMetadata

Metadata popisující manifest importu, dokument, který popisuje soubory a další metadata verze aktualizace.

Name	Typ	Description
hashes	object	Objekt JSON obsahující hodnoty hash souboru. Vyžaduje se aspoň hodnota hash SHA256. Tento objekt si lze představit jako sadu párů klíč-hodnota, kde klíčem je hashovací algoritmus a hodnota je hodnota hash souboru vypočítaná pomocí tohoto algoritmu.
sizeInBytes	integer	Velikost souboru v počtu bajtů
url	string	Umístění objektu blob Azure, ze kterého je možné stáhnout manifest importu službou Device Update pro IoT Hub. Obvykle se jedná o adresu URL objektu blob chráněnou jen pro čtení SAS s vypršením platnosti nastavenou na alespoň 4 hodiny.

ImportUpdateInput

Importuje vstupní metadata aktualizace.

Name	Typ	Description
files	FileImportMetadata[]	Jedna nebo více vlastností souboru aktualizace, jako je název souboru a zdrojová adresa URL.
importManifest	ImportManifestMetadata	Naimportujte metadata manifestu, jako je zdrojová adresa URL, velikost nebo hodnoty hash souboru atd.