Importazione di aggiornamenti in Aggiornamento dispositivi per hub IoT: schema e altre informazioni

Se si vuole importare un aggiornamento in Aggiornamento dispositivi per hub IoT, assicurarsi di aver esaminato prima i concetti e la guida pratica. Se si è interessati ai dettagli dello schema del manifesto di importazione stesso, vedere di seguito.

Lo schema JSON del manifesto di importazione è ospitato in SchemaStore.org.

Schema

Non sono consentite proprietà aggiuntive.

Oggetto updateId

L'oggetto updateID è un identificatore univoco per ogni aggiornamento.

Non sono consentite proprietà aggiuntive.

Ad esempio:

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

Oggetto compatibility

L'oggetto compatibility descrive le proprietà di un dispositivo con cui questo aggiornamento è compatibile.

• Tipo: object
• Numero minimo di proprietà: 1
• Numero massimo di proprietà: 5

Ogni proprietà è una coppia nome-valore di tipo stringa.

• Lunghezza minima del nome della proprietà: 1
• Lunghezza massima del nome della proprietà: 32
• Lunghezza minima del valore della proprietà: 1
• Lunghezza massima del valore della proprietà: 64

Non è possibile usare lo stesso set di proprietà di compatibilità con più di una combinazione di nome e provider di aggiornamenti.

Ad esempio:

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

Oggetto instructions

L'oggetto instructions fornisce le istruzioni di installazione degli aggiornamenti. L'oggetto instructions contiene un elenco di passaggi da eseguire. I passaggi possono essere codice da eseguire o un puntatore a un altro aggiornamento.

Non sono consentite proprietà aggiuntive.

Ad esempio:

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

Oggetto inlineStep

Un oggetto inlineStep è un passaggio delle istruzioni di installazione che esegue il codice.

Non sono consentite proprietà aggiuntive.

Ad esempio:

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

Oggetto referenceStep

Un oggetto referenceStep è un passaggio delle istruzioni di installazione che installa un altro aggiornamento.

Non sono consentite proprietà aggiuntive.

Ad esempio:

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

Oggetto file

Un oggetto file è un file di payload dell'aggiornamento, ad esempio binario, firmware, script e così via. Ogni oggetto file deve essere univoco all'interno di un aggiornamento.

Non sono consentite proprietà aggiuntive.

Ad esempio:

{
  "files": [
    {
      "filename": "configure.sh",
      "sizeInBytes": 7558,
      "hashes": {...}
    }
  ]
}

Oggetto fileHashes

Hash di file con codifica Base64 con il nome dell'algoritmo come chiave. È necessario specificare almeno l'algoritmo SHA-256 e gli altri algoritmi possono essere specificati se supportati dall'agente. Per un esempio di come calcolare correttamente l'hash, vedere la funzione Get-AduFileHashes nello script AduUpdate.psm1.

Sono consentite proprietà aggiuntive.

Ad esempio:

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

Oggetto relatedFiles

Raccolta di file correlati a uno o più file di payload primari.

Sono consentite proprietà aggiuntive.

Ad esempio:

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

Per altre informazioni, vedere Usare la funzionalità file correlati per fare riferimento a più file di aggiornamento.

Oggetto downloadHandler

Specifica come elaborare i file correlati.

Non sono consentite proprietà aggiuntive.

Ad esempio:

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

Passaggi successivi

Altre informazioni sui concetti di importazione.

Se si è pronti, provare la guida pratica di importazione, che illustra in dettaglio il processo di importazione.