Device Update - List Updates

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 do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (url)	O ponto de extremidade da conta da Atualização de Dispositivo para o Hub IoT (somente nome do host, sem protocolo).
instanceId	path	True	string	O identificador de instância da conta da Atualização de Dispositivo para o 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 correspondentes a uma expressão de pesquisa de texto livre.

Respostas

Name	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

Azure Ative Directory OAuth2 Flow

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

Âmbitos

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

Exemplos

DeviceUpdate_ListUpdates

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

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	Etapa de instruções de instalação da atualização.
StepType	Tipo de passo.
Update	Atualizar metadados.
UpdateId	Atualizar identificador.
UpdateList	A lista de atualizações.

Error

Object

Detalhes do erro.

Name	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levaram 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 por humanos do erro.
occurredDateTime	string (date-time)	Data e hora em UTC quando o erro ocorreu.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro comum.

Name	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Object

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 contido.
errorDetail	string	A mensagem interna de erro ou 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

Object

Name	Tipo	Description
steps	Step[]	Conjunto de etapas de instalação.

Step

Object

Etapa de instruções de instalação da atualização.

Name	Tipo	Default value	Description
description	string minLength: 1 maxLength: 64		Descrição do passo.
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 passo.
updateId	UpdateId		Identidade de atualização de filho referenciada. Obrigatório se o tipo de etapa for referência.

StepType

Enumeração

Tipo de passo.

Valor	Description
inline
reference

Update

Object

Atualizar metadados.

Name	Tipo	Default value	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		String 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 do esquema do manifesto usado para importar a atualização.
referencedBy	UpdateId[]		Lista de identidades de atualização que fazem referência a esta atualização.
scanResult	string		Atualize o resultado da verificação agregada (calculado a partir dos resultados da verificação do arquivo de carga útil).
updateId	UpdateId		Atualizar identidade.
updateType	string		Tipo de atualização. Preterido no esquema de manifesto de importação mais recente.

UpdateId

Object

Atualizar identificador.

Name	Tipo	Description
name	string	Nome da atualização.
provider	string	Provedor de atualização.
version	string	Versão de atualização.

UpdateList

Object

A lista de atualizações.

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

Partilhar via

Device Update - List Updates

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

DeviceUpdate_ListUpdates

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList