Device Update - Get Update

Riferimento

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 hub IoT endpoint dell'account (solo nome host, nessun protocollo).
instanceId	path	True	string	Aggiornamento del dispositivo per hub IoT identificatore dell'istanza dell'account.
name	path	True	string	Nome aggiornamento.
provider	path	True	string	Provider di aggiornamento.
version	path	True	string	Versione di aggiornamento.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

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	Versione di aggiornamento richiesta.
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_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-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 degli errori.
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	Identificatore di aggiornamento.

Error

Dettagli degli errori.

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	Data e ora utc quando si è verificato l'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore comune.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

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 contenente.
errorDetail	string	Errore interno o messaggio di eccezione.
innerError	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.

Instructions

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

Step

Aggiornare il passaggio dell'istruzione di installazione.

Nome	Tipo	Valore predefinito	Descrizione
description	string		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		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

Tipo di passaggio.

Nome	Tipo	Descrizione
inline	string
reference	string

Update

Aggiornare i metadati.

Nome	Tipo	Valore predefinito	Descrizione
compatibility	object[]		Elenco delle informazioni sulla compatibilità degli aggiornamenti.
createdDateTime	string		Data e ora in formato UTC quando è stato creato l'aggiornamento.
description	string		Aggiornare la descrizione specificata dall'autore.
etag	string		Aggiornare ETag.
friendlyName	string		Nome dell'aggiornamento descrittivo specificato dall'utilità di importazione.
importedDateTime	string		Data e ora utc quando l'aggiornamento è stato importato.
installedCriteria	string		Stringa interpretata dal client Device Update 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 i risultati dell'analisi aggregata (calcolati dai risultati dell'analisi dei file payload).
updateId	UpdateId		Aggiornare l'identità.
updateType	string		Tipo di aggiornamento. Deprecato nello schema del manifesto di importazione più recente.

UpdateId

Identificatore di aggiornamento.

Nome	Tipo	Descrizione
name	string	Nome aggiornamento.
provider	string	Provider di aggiornamento.
version	string	Versione di aggiornamento.

Condividi tramite