Schemat manifestu importowania usługi Azure Device Update dla usługi IoT Hub

Podczas importowania aktualizacji do usługi Azure Device Update dla usługi IoT Hub należy również przesłać skojarzony plik manifestu importu JSON, który definiuje ważne informacje o aktualizacji. W tym artykule opisano schemat używany do tworzenia pliku manifestu importu JSON.

Aby dowiedzieć się więcej na temat pojęć manifestu importu i struktury plików, zobacz Azure Device Update for IoT Hub import manifest (Manifest importowania usługi Azure Device Update for IoT Hub). Aby dowiedzieć się, jak utworzyć plik, zobacz Przygotowanie aktualizacji do zaimportowania do usługi Device Update for IoT Hub.

Schemat

Schemat JSON manifestu importu jest hostowany w SchemaStore.org i składa się z następujących właściwości. Żadne inne właściwości nie są dozwolone.

Aktualizuj obiekt

Obiekt updateID jest unikatowym identyfikatorem każdej aktualizacji.

Żadne inne właściwości nie są dozwolone.

Przykład:

{
  "updateId": {
    "provider": "Contoso",
    "name": "Toaster",
    "version": "1.0"
  }
}

Obiekt zgodności

Obiekt compatibility opisuje 1–5 właściwości urządzenia, z którymi ta aktualizacja jest zgodna. Każda właściwość jest parą typu string nazwa-wartość. Nazwa musi mieć długość od 1 do 32 znaków, a wartość musi mieć długość od 1 do 64 znaków. Nie można użyć tego samego dokładnie zestawu właściwości zgodności z więcej niż jedną kombinacją dostawcy aktualizacji i nazwy.

Przykład:

{
  "compatibility": [
    {
      "manufacturer": "Contoso",
      "model": "Toaster"
    }
  ]
}

Obiekt instrukcji

Obiekt instructions zawiera instrukcje instalacji aktualizacji. Obiekt instrukcji zawiera listę steps do wykonania. Żadne inne właściwości nie są dozwolone.

Kroki mogą być kodem do wykonania lub wskaźnikiem do innych aktualizacji. Obiekt kroku jest inline domyślnie domyślny, jeśli nie type podano żadnej wartości.

Przykład:

{
  "instructions": {
    "steps": [
      {
        "type": "inline",
        ...
      },
      {
        "type": "reference",
        ...
      }
    ]
  }
}

Obiekt kroku wbudowanego

inline Obiekt kroku to etap instrukcji instalacji, który wykonuje kod.

Żadne inne właściwości nie są dozwolone.

Przykład:

{
  "steps": [
    {
      "description": "pre-install script",
      "handler": "microsoft/script:1",
      "handlerProperties": {
        "arguments": "--pre-install"
      },
      "files": [
        "configure.sh"
      ]
    }
  ]
}

Obiekt referencyjnego kroku

reference Obiekt kroku to krok instrukcji instalacji umożliwiający zainstalowanie innej aktualizacji.

Żadne inne właściwości nie są dozwolone.

Przykład:

{
  "steps": [
    {
      "type": "reference",
      "updateId": {
        "provider": "Contoso",
        "name": "Toaster.HeatingElement",
        "version": "1.0"
      }
    }
  ]
}

Obiekt Pliki

Każdy files obiekt jest plikiem ładunku aktualizacji, takim jak plik binarny, oprogramowanie układowe lub plik skryptu, który musi być unikatowy w ramach aktualizacji.

Żadne inne właściwości nie są dozwolone.

Przykład:

{
  "files": [
    {  
      "fileName": "full-image-file-name",
      "sizeInBytes": 12345,
      "hashes": {...},
      "relatedFiles": [
        {
          "fileName": "delta-from-v1-file-name",
          "sizeInBytes": 1234,
          "hashes": {
            "SHA256": "delta-from-v1-file-hash"
          },
          "properties": {...}
        }  
      ],
      "downloadHandler": {
        "id": "microsoft/delta:1"
        }
    }
  ]
}

Obiekt skrótów

Obiekt hashes zawiera skróty plików zakodowane w formacie base64 z nazwami algorytmów jako kluczami. Należy określić co najmniej algorytm SHA-256, a inne algorytmy można określić, jeśli są obsługiwane przez agenta. Aby zobaczyć przykład prawidłowego obliczania skrótu, zobacz funkcję Get-AduFileHashes w skrypcie AduUpdate.psm1.

Inne właściwości są dozwolone.

Przykład:

{
  "hashes": {
    "sha256": "/CD7Sn6fiknWa3NgcFjGlJ+ccA81s1QAXX4oo5GHiFA="
  }
}

relatedFiles, obiekt

Obiekt relatedFiles zawiera kolekcję plików, które są powiązane z co najmniej jednym podstawowym plikiem ładunku. Aby uzyskać więcej informacji, zobacz Używanie funkcji powiązanych plików do odwołwania się do wielu plików aktualizacji.

Inne właściwości są dozwolone.

Przykład:

"relatedFiles": [
  {
    "filename": "in1_in2_deltaupdate.dat",
    "sizeInBytes": 102910752,
    "hashes": {
      "sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
    },
    "properties": {
      "microsoft.sourceFileHashAlgorithm": "sha256",
      "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
    }
  }
],

downloadHandler, obiekt

Obiekt downloadHandler określa sposób przetwarzania dowolnych powiązanych plików.

Żadne inne właściwości nie są dozwolone.

Przykład:

"downloadHandler": {
  "id": "microsoft/delta:1"
}

Powiązana treść

• Importowanie pojęć i manifestów
• Przygotowywanie aktualizacji do zaimportowania
• Importowanie aktualizacji