Device Update - List Updates

Referência

Serviço:: Device Update

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

Obtenha uma lista de todas as atualizações que foram importadas para a Atualização de Dispositivo para o Hub IoT.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01

Com parâmetros opcionais:

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (url)	O ponto de extremidade da conta da Atualização de Dispositivo para Hub IoT (somente nome do host, sem protocolo).
instanceId	path	True	string	O identificador da instância da conta do Device Update para Hub IoT.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.
filter	query		string	Opcional para filtrar atualizações por propriedade isDeployable.
search	query		string	Solicite atualizações que correspondam a uma expressão de pesquisa de texto livre.

Respostas

Nome	Tipo	Description
200 OK	UpdateList	Todas as atualizações importadas ou lista vazia se não houver nenhuma.
Other Status Codes	ErrorResponse	Resposta padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
https://api.adu.microsoft.com/.default	Escopo de autorização padrão.

Exemplos

DeviceUpdate_ListUpdates

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "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

Nome	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	Atualizar a etapa de instrução de instalação.
StepType	Tipo de etapa.
Update	Atualizar metadados.
UpdateId	Identificador de atualização.
UpdateList	A lista de atualizações.

Error

Objeto

Detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levou ao erro relatado.
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 pelo ser humano do erro.
occurredDateTime	string (date-time)	Data e hora em UTC quando o erro ocorreu.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro comum.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Objeto

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

Nome	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 pelo ser humano do erro.

Instructions

Objeto

Nome	Tipo	Description
steps	Step[]	Coleção de etapas de instalação.

Step

Objeto

Atualizar a etapa de instrução de instalação.

Nome	Tipo	Valor padrão	Description
description	string minLength: 1 maxLength: 64		Descrição da etapa.
files	string[]		Coleção de nomes de arquivo a serem passados para o manipulador durante a execução. Obrigatório se o tipo de etapa estiver embutido.
handler	string minLength: 1 maxLength: 32		Identidade do manipulador que executará esta etapa. Obrigatório se o tipo de etapa estiver embutido.
handlerProperties	object		Parâmetros a serem passados para o manipulador durante a execução.
type	StepType	inline	Tipo de etapa.
updateId	UpdateId		Identidade de atualização filho referenciada. Obrigatório se o tipo de etapa for referência.

StepType

Enumeração

Tipo de etapa.

Valor	Description
inline
reference

Update

Objeto

Atualizar metadados.

Nome	Tipo	Valor padrão	Description
compatibility	object[]		Lista de informações de compatibilidade de atualização.
createdDateTime	string (date-time)		Data e hora em UTC quando a atualização foi criada.
description	string minLength: 1 maxLength: 512		Descrição da atualização especificada pelo criador.
etag	string		Atualizar eTag.
friendlyName	string minLength: 1 maxLength: 512		Nome de atualização amigável especificado pelo importador.
importedDateTime	string (date-time)		Data e hora em UTC quando a atualização foi importada.
installedCriteria	string		Cadeia de caracteres interpretada pelo cliente de Atualização de Dispositivo 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 implantada em um dispositivo por conta própria.
manifestVersion	string		Versão de esquema do manifesto usada para importar a atualização.
referencedBy	UpdateId[]		Lista de identidades de atualização que fazem referência a essa atualização.
scanResult	string		Atualizar o resultado da verificação agregada (calculado com base nos resultados da verificação de arquivo de conteúdo).
updateId	UpdateId		Atualizar identidade.
updateType	string		Tipo de atualização. Preterido no esquema de manifesto de importação mais recente.

UpdateId

Objeto

Identificador de atualização.

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

UpdateList

Objeto

A lista de atualizações.

Nome	Tipo	Description
nextLink	string	O link para a próxima página de itens.
value	Update[]	A coleção de itens pagináveis.

Compartilhar via

Device Update - List Updates

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

DeviceUpdate_ListUpdates

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList