Device Update - Get Update

Servizio:: Device Update

Versione API:: 2022-10-01

Ottenere una versione di aggiornamento specifica.

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

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.
name	path	True	string	Aggiornare il nome.
provider	path	True	string	Provider di aggiornamento.
version	path	True	string	Aggiornare la versione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-None-Match		string	Definisce la condizione If-None-Match. L'operazione verrà eseguita solo se l'ETag nel server non corrisponde a questo valore.

Risposte

Nome	Tipo	Descrizione
200 OK	Update	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

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

Ambiti

Nome	Descrizione
https://api.adu.microsoft.com/.default

Esempio

DeviceUpdate_GetUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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-22T14:01:43.8408797-07:00",
  "createdDateTime": "2019-09-11T17:00:00-07: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	Aggiorna il contenitore delle istruzioni di installazione.
Step	Aggiornare il passaggio dell'istruzione di installazione.
StepType	Tipo di passaggio.
Update	Aggiornare i metadati.
UpdateId	Aggiornare l'identificatore.

Error

Oggetto

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

Oggetto

Risposta di errore comune.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

Oggetto

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

Oggetto

Aggiorna il contenitore delle istruzioni di installazione.

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

Step

Oggetto

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			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	Tipo di step che esegue l'esecuzione del codice.
reference	Tipo di passaggio che installa un altro aggiornamento.

Update

Oggetto

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

Oggetto

Aggiornare l'identificatore.

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