Device Update - Get Operation Status

Servizio:: Device Update

Versione API:: 2022-10-01

Recuperare lo stato dell'operazione.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?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.
operationId	path	True	string minLength: 1 maxLength: 256	Identificatore dell'operazione.
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	UpdateOperation	La richiesta ha avuto esito positivo. Intestazioni Retry-After: string
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

UpdateOperation

La richiesta ha avuto esito positivo.

Intestazioni

Retry-After: string

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_GetOperationStatus

Esempio di richiesta

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

Risposta di esempio

Codice di stato:: 200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T14:00:53.2548897-07:00",
  "lastActionDateTime": "2020-04-22T14:01:43.940142-07:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

Definizioni

Nome	Descrizione
Error	Dettagli errore.
ErrorResponse	Risposta di errore comune.
InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
OperationStatus	Stato dell'operazione.
UpdateId	Aggiornare l'identificatore.
UpdateInfo	Aggiornare le informazioni.
UpdateOperation	Metadati dell'operazione.

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.

OperationStatus

Enumerazione

Stato dell'operazione.

Valore	Descrizione
NotStarted	Operazione in background creata ma non ancora avviata.
Running	L'operazione in background è attualmente in esecuzione.
Succeeded	Operazione in background completata con esito positivo.
Failed	Operazione in background completata con errore.

UpdateId

Oggetto

Aggiornare l'identificatore.

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

UpdateInfo

Oggetto

Aggiornare le informazioni.

Nome	Tipo	Descrizione
description	string	Aggiornare la descrizione.
friendlyName	string	Nome descrittivo dell'aggiornamento.
updateId	UpdateId	Aggiornare l'identificatore.

UpdateOperation

Oggetto

Metadati dell'operazione.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Data e ora in formato UTC in cui è stata creata l'operazione.
error	Error	Si è verificato un errore di operazione, se disponibile.
etag	string	ETag dell'operazione.
lastActionDateTime	string (date-time)	Data e ora in formato UTC dell'ultimo aggiornamento dello stato dell'operazione.
operationId	string	ID operazione.
resourceLocation	string	Posizione dell'aggiornamento importato quando l'operazione ha esito positivo.
status	OperationStatus	Stato dell'operazione.
traceId	string	Identità di correlazione dell'operazione che può essere usata dal supporto tecnico Microsoft per la risoluzione dei problemi.
update	UpdateInfo	Aggiornamento importato o eliminato. Per l'importazione, questa proprietà verrà popolata solo dopo l'elaborazione corretta del manifesto di importazione.