Device Update - Get Update

Referência

Serviço:: Device Update

Versão da API:: 2022-10-01

Obtenha uma versão de atualização específica.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	A Atualização de Dispositivos para Hub IoT ponto final da conta (apenas nome do anfitrião, sem protocolo).
instanceId	path	True	string	O identificador da instância da conta de Hub IoT Atualização de Dispositivos.
name	path	True	string	Nome da atualização.
provider	path	True	string	Atualizar fornecedor.
version	path	True	string	Atualizar versão.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-None-Match		string	Define a condição If-None-Match. A operação só será efetuada se o ETag no servidor não corresponder a este valor.

Respostas

Name	Tipo	Description
200 OK	Update	A versão de atualização pedida.
Other Status Codes	ErrorResponse	Resposta predefinida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://api.adu.microsoft.com/.default	Âmbito de autorização predefinido.

Exemplos

DeviceUpdate_GetUpdate

Pedido de amostra

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01

Resposta da amostra

Código de estado:: 200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "instructions": {
    "steps": [
      {
        "description": "pre-install script",
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "--pre-install"
        },
        "files": [
          "configure.sh"
        ]
      },
      {
        "type": "reference",
        "updateId": {
          "provider": "microsoft",
          "name": "sensor",
          "version": "1.0"
        }
      }
    ]
  },
  "manifestVersion": "5.0",
  "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
  "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Definições

Name	Description
Error	Detalhes do erro.
ErrorResponse	Resposta de erro comum.
InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
Instructions
Step	Atualize o passo de instrução de instalação.
StepType	Tipo de passo.
Update	Atualizar metadados.
UpdateId	Identificador de atualização.

Error

Detalhes do erro.

Name	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levou ao erro comunicado.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
occurredDateTime	string	Data e hora em UTC em que ocorreu o erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro comum.

Name	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Name	Tipo	Description
code	string	Um código de erro mais específico do que o fornecido pelo erro que contém.
errorDetail	string	O erro interno ou a mensagem de exceção.
innerError	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.

Instructions

Name	Tipo	Description
steps	Step[]	Coleção de passos de instalação.

Step

Atualize o passo de instrução de instalação.

Name	Tipo	Default value	Description
description	string		Descrição do passo.
files	string[]		Coleção de nomes de ficheiros a transmitir ao processador durante a execução. Necessário se o tipo de passo estiver inline.
handler	string		Identidade do processador que irá executar este passo. Necessário se o tipo de passo estiver inline.
handlerProperties	object		Parâmetros a transmitir ao processador durante a execução.
type	StepType	inline	Tipo de passo.
updateId	UpdateId		Identidade de atualização subordinada referenciada. Necessário se o tipo de passo for referência.

StepType

Tipo de passo.

Name	Tipo	Description
inline	string
reference	string

Update

Atualizar metadados.

Name	Tipo	Default value	Description
compatibility	object[]		Lista de informações de compatibilidade de atualizações.
createdDateTime	string		Data e hora em UTC quando a atualização foi criada.
description	string		Descrição da atualização especificada pelo criador.
etag	string		Atualizar O ETag.
friendlyName	string		Nome de atualização amigável especificado pelo importador.
importedDateTime	string		Data e hora em UTC em que a atualização foi importada.
installedCriteria	string		Cadeia interpretada pelo cliente de Atualização de Dispositivos para determinar se a atualização está instalada no dispositivo. Preterido no esquema de manifesto de importação mais recente.
instructions	Instructions		Atualize as instruções de instalação.
isDeployable	boolean	True	Se a atualização pode ser implementada num dispositivo por si só.
manifestVersion	string		Versão de esquema do manifesto utilizado para importar a atualização.
referencedBy	UpdateId[]		Lista de identidades de atualização que referenciam esta atualização.
scanResult	string		Atualizar o resultado da análise agregada (calculado a partir dos resultados da análise de ficheiros de payload).
updateId	UpdateId		Atualizar identidade.
updateType	string		Tipo de atualização. Preterido no esquema de manifesto de importação mais recente.

UpdateId

Identificador de atualização.

Name	Tipo	Description
name	string	Nome da atualização.
provider	string	Atualizar fornecedor.
version	string	Atualizar versão.

Partilhar via