Esquema de manifesto de importação da Atualização de Dispositivo do Azure para o Hub IoT

Ao importar uma atualização para a Atualização de Dispositivo do Azure para o Hub IoT, você também envia um arquivo de manifesto de importação JSON associado que define informações importantes sobre a atualização. Este artigo descreve o esquema usado para criar o arquivo de manifesto de importação JSON.

Para saber mais sobre conceitos de manifesto de importação e estrutura de arquivos, consulte Atualização de dispositivo do Azure para manifesto de importação do Hub IoT. Para saber como criar o arquivo, consulte Preparar uma atualização para importar para a Atualização de Dispositivo para o Hub IoT.

Esquema

O esquema JSON do manifesto de importação é hospedado em SchemaStore.org e consiste nas seguintes propriedades. Não são permitidas outras propriedades.

Atualizar objeto

O updateID objeto é um identificador exclusivo para cada atualização.

Não são permitidas outras propriedades.

Por exemplo:

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

Objeto de compatibilidade

O compatibility objeto descreve 1-5 propriedades de um dispositivo com o qual esta atualização é compatível. Cada propriedade é um string par nome-valor do tipo. O nome deve ter de 1 a 32 caracteres e o valor deve ter de 1 a 64 caracteres. Não é possível usar o mesmo conjunto exato de propriedades de compatibilidade com mais de um provedor de atualização e combinação de nomes.

Por exemplo:

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

Objeto de instruções

O instructions objeto fornece as instruções de instalação da atualização. O objeto de instruções contém uma lista de steps a serem executadas. Não são permitidas outras propriedades.

As etapas podem ser código para executar ou ponteiros para outras atualizações. Um objeto step assume como inline padrão se nenhum type valor for fornecido.

Por exemplo:

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

Objeto de etapa embutida

Um inline objeto step é uma etapa de instrução de instalação que executa a execução de código.

Não são permitidas outras propriedades.

Por exemplo:

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

Objeto da etapa de referência

Um reference objeto step é uma etapa de instruções de instalação para instalar outra atualização.

Não são permitidas outras propriedades.

Por exemplo:

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

Objeto Files

Cada files objeto é um arquivo de carga útil de atualização, como um arquivo binário, de firmware ou de script, que deve ser exclusivo dentro de uma atualização.

Não são permitidas outras propriedades.

Por exemplo:

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

Objeto Hashes

O hashes objeto contém hashes de arquivo codificados em base64 com os nomes do algoritmo como chaves. Pelo menos o algoritmo SHA-256 deve ser especificado, e outros algoritmos podem ser especificados se suportados pelo agente. Para obter um exemplo de como calcular o hash corretamente, consulte a Get-AduFileHashes função no script AduUpdate.psm1.

Outras propriedades são permitidas.

Por exemplo:

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

objeto relatedFiles

O relatedFiles objeto contém uma coleção de arquivos relacionados a um ou mais arquivos de carga primária. Para obter mais informações, consulte Usar o recurso de arquivos relacionados para fazer referência a vários arquivos de atualização.

Outras propriedades são permitidas.

Por exemplo:

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

objeto downloadHandler

O downloadHandler objeto especifica como processar quaisquer arquivos relacionados.

Não são permitidas outras propriedades.

Por exemplo:

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

Conteúdo relacionado

• Importar conceitos e manifesto
• Preparar uma atualização para importar
• Importar uma atualização