Udostępnij przez

Updates - Import Update

Usługa:
Device Update
Wersja interfejsu API:
2020-09-01

Zaimportuj nową wersję aktualizacji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
accountEndpoint
 path True

string

Punkt końcowy konta.
instanceId
 path True

string

Identyfikator wystąpienia konta.
action
 query True

ImportAction

Zaimportuj akcję aktualizacji.

Treść żądania

Nazwa Wymagane Typ Opis
files True

FileImportMetadata[]

Co najmniej jedna właściwości pliku aktualizacji, takie jak nazwa pliku i adres URL źródła.
importManifest True

ImportManifestMetadata

Zaimportuj metadane manifestu, takie jak adres URL źródła, rozmiar pliku/skróty itp.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Zaakceptowane żądanie importu aktualizacji; Lokalizacja operacji w tle do śledzenia stanu jest określona w nagłówku odpowiedzi Operation-Location.

Nagłówki

  • Location: string
  • Operation-Location: string
429 Too Many Requests

Zbyt wiele żądań; Istnieje limit szybkości wykonywania operacji w danym okresie. Istnieje również limit liczby współbieżnych operacji importowania i usuwania operacji w tle.

Zabezpieczenia

azure_auth_implicit

Przepływ niejawny OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

azure_auth_code

Przepływ kodu dostępu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

azure_auth_application

Przepływ aplikacji OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa Opis
.default zakres poświadczeń klienta

azure_auth_password

Przepływ haseł protokołu OAuth2 w usłudze Azure Active Directory

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

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Updates_ImportUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
FileImportMetadata

Metadane opisujące plik aktualizacji.
ImportAction

Zaimportuj akcję aktualizacji.
ImportManifestMetadata

Metadane opisujące manifest importu, dokument opisujący pliki i inne metadane dotyczące wersji aktualizacji.
ImportUpdateInput

Importowanie metadanych wejściowych aktualizacji.

FileImportMetadata

Objekt

Metadane opisujące plik aktualizacji.

Nazwa Typ Opis
filename

string

Zaktualizuj nazwę pliku zgodnie z określonymi w manifeście importu.
url

string

Lokalizacja obiektu blob platformy Azure, z której można pobrać plik aktualizacji przez usługę Device Update dla usługi IoT Hub. Zazwyczaj jest to adres URL obiektu blob chronionego tylko do odczytu z wygaśnięciem ustawionym na co najmniej 4 godziny.

ImportAction

Wyliczanie

Zaimportuj akcję aktualizacji.

Wartość Opis
import

Akcja importu.

ImportManifestMetadata

Objekt

Metadane opisujące manifest importu, dokument opisujący pliki i inne metadane dotyczące wersji aktualizacji.

Nazwa Typ Opis
hashes

object

Obiekt JSON zawierający skrót (es) pliku. Wymagany jest co najmniej skrót SHA256. Ten obiekt można traktować jako zestaw par klucz-wartość, w których klucz jest algorytmem wyznaczania wartości skrótu, a wartość jest skrótem pliku obliczanego przy użyciu tego algorytmu.
sizeInBytes

integer (int64)

Rozmiar pliku w liczbie bajtów.
url

string

Lokalizacja obiektu blob platformy Azure, z której manifest importu można pobrać za pomocą usługi Device Update dla usługi IoT Hub. Zazwyczaj jest to adres URL obiektu blob chronionego tylko do odczytu z wygaśnięciem ustawionym na co najmniej 4 godziny.

ImportUpdateInput

Objekt

Importowanie metadanych wejściowych aktualizacji.

Nazwa Typ Opis
files

FileImportMetadata[]

Co najmniej jedna właściwości pliku aktualizacji, takie jak nazwa pliku i adres URL źródła.
importManifest

ImportManifestMetadata

Zaimportuj metadane manifestu, takie jak adres URL źródła, rozmiar pliku/skróty itp.