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

Ao importar uma atualização para a Atualização de Dispositivo do Azure para 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 como importar conceitos de manifesto e estrutura de arquivos, consulte o manifesto de importação do Azure Device Update para 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 propriedades a seguir. Nenhuma outra propriedade é permitida.

Atualizar objeto

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

Nenhuma outra propriedade é permitida.

Por exemplo:

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

Objeto de compatibilidade

O compatibility objeto descreve 1 a 5 propriedades de um dispositivo com o qual essa atualização é compatível. Cada propriedade é um par nome-valor de tipo string. O nome deve ter de 1 a 32 caracteres e o valor deve ter de 1 a 64 caracteres. Você não pode 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 Instructions

O instructions objeto fornece as instruções de instalação de atualização. O objeto de instruções contém uma lista de steps a serem executadas. Nenhuma outra propriedade é permitida.

As etapas podem ser código a ser executado ou ponteiros para outras atualizações. Um objeto de etapa usa inline como padrão se nenhum valor type for fornecido.

Por exemplo:

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

Objeto de etapa em linha

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

Nenhuma outra propriedade é permitida.

Por exemplo:

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

Objeto de etapa de referência

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

Nenhuma outra propriedade é permitida.

Por exemplo:

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

Objeto de arquivos

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

Nenhuma outra propriedade é permitida.

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 de Hashes

O hashes objeto contém hashes de arquivo codificados em base64 com os nomes de algoritmos como chaves. Pelo menos o algoritmo SHA-256 deve ser especificado e outros algoritmos poderão ser especificados se houver suporte do 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 conteúdo primário. 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 arquivos relacionados.

Nenhuma outra propriedade é permitida.

Por exemplo:

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

Conteúdo relacionado

• Manifesto e conceitos de importação
• Preparar uma atualização para importar
• Importar uma atualização