Device Update - List Updates

Servizio:: Device Update

Versione API:: 2022-10-01

Ottenere un elenco di tutti gli aggiornamenti importati in Aggiornamento dispositivi per l'hub IoT.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (url)	Aggiornamento del dispositivo per l'endpoint dell'account dell'hub IoT (solo nome host, nessun protocollo).
instanceId	path	True	string	Identificatore dell'istanza dell'account dell'hub IoT aggiornamento del dispositivo.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.
filter	query		string	Facoltativo per filtrare gli aggiornamenti in base alla proprietà isDeployable.
search	query		string	Richiedere aggiornamenti corrispondenti a un'espressione di ricerca free-text.

Risposte

Nome	Tipo	Descrizione
200 OK	UpdateList	Tutti gli aggiornamenti importati o un elenco vuoto se non è presente alcuno.
Other Status Codes	ErrorResponse	Risposta predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://api.adu.microsoft.com/.default	Ambito di autorizzazione predefinito.

Esempio

DeviceUpdate_ListUpdates

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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\""
    }
  ]
}

Definizioni

Nome	Descrizione
Error	Dettagli errore.
ErrorResponse	Risposta di errore comune.
InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
Instructions
Step	Aggiornare il passaggio dell'istruzione di installazione.
StepType	Tipo di passaggio.
Update	Aggiornare i metadati.
UpdateId	Aggiornare l'identificatore.
UpdateList	Elenco degli aggiornamenti.

Error

Object

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Codice di errore definito dal server.
details	Error[]	Matrice di errori che hanno causato l'errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
occurredDateTime	string (date-time)	Data e ora in formato UTC in cui si è verificato l'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore comune.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

Object

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenitore.
errorDetail	string	Messaggio di errore interno o eccezione.
innerError	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.

Instructions

Object

Nome	Tipo	Descrizione
steps	Step[]	Raccolta dei passaggi di installazione.

Step

Object

Aggiornare il passaggio dell'istruzione di installazione.

Nome	Tipo	Valore predefinito	Descrizione
description	string minLength: 1 maxLength: 64		Descrizione passaggio.
files	string[]		Raccolta di nomi di file da passare al gestore durante l'esecuzione. Obbligatorio se il tipo di passaggio è inline.
handler	string minLength: 1 maxLength: 32		Identità del gestore che eseguirà questo passaggio. Obbligatorio se il tipo di passaggio è inline.
handlerProperties	object		Parametri da passare al gestore durante l'esecuzione.
type	StepType	inline	Tipo di passaggio.
updateId	UpdateId		Identità di aggiornamento figlio a cui si fa riferimento. Obbligatorio se il tipo di passaggio è riferimento.

StepType

Enumerazione

Tipo di passaggio.

Valore	Descrizione
inline
reference

Update

Object

Aggiornare i metadati.

Nome	Tipo	Valore predefinito	Descrizione
compatibility	object[]		Elenco delle informazioni sulla compatibilità degli aggiornamenti.
createdDateTime	string (date-time)		Data e ora in formato UTC in cui è stato creato l'aggiornamento.
description	string minLength: 1 maxLength: 512		Aggiornare la descrizione specificata dall'autore.
etag	string		Aggiornare ETag.
friendlyName	string minLength: 1 maxLength: 512		Nome descrittivo dell'aggiornamento specificato dall'utilità di importazione.
importedDateTime	string (date-time)		Data e ora in formato UTC in cui è stato importato l'aggiornamento.
installedCriteria	string		Stringa interpretata dal client di Aggiornamento dispositivi per determinare se l'aggiornamento è installato nel dispositivo. Deprecato nello schema del manifesto di importazione più recente.
instructions	Instructions		Aggiornare le istruzioni di installazione.
isDeployable	boolean	True	Indica se l'aggiornamento può essere distribuito in un dispositivo autonomamente.
manifestVersion	string		Versione dello schema del manifesto usata per importare l'aggiornamento.
referencedBy	UpdateId[]		Elenco delle identità di aggiornamento che fanno riferimento a questo aggiornamento.
scanResult	string		Aggiornare il risultato dell'analisi aggregata (calcolato dai risultati dell'analisi dei file di payload).
updateId	UpdateId		Aggiornare l'identità.
updateType	string		Tipo di aggiornamento. Deprecato nello schema del manifesto di importazione più recente.

UpdateId

Object

Aggiornare l'identificatore.

Nome	Tipo	Descrizione
name	string	Aggiornare il nome.
provider	string	Provider di aggiornamento.
version	string	Aggiornare la versione.

UpdateList

Object

Elenco degli aggiornamenti.

Nome	Tipo	Descrizione
nextLink	string	Collegamento alla pagina successiva di elementi.
value	Update[]	Raccolta di elementi di paging.

Condividi tramite

Device Update - List Updates

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

DeviceUpdate_ListUpdates

Esempio di richiesta

Risposta di esempio

Definizioni

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList