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 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.
operationId	path	True	string	Identificatore operazione.
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	UpdateOperation	Stato dell'operazione. Intestazioni Retry-After: string
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_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-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

Definizioni

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

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.

OperationStatus

Stato dell'operazione.

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

UpdateId

Identificatore di aggiornamento.

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

UpdateInfo

Aggiornare le informazioni.

Nome	Tipo	Descrizione
description	string	Descrizione dell'aggiornamento.
friendlyName	string	Nome aggiornamento descrittivo.
updateId	UpdateId	Identificatore di aggiornamento.

UpdateOperation

Metadati dell'operazione.

Nome	Tipo	Descrizione
createdDateTime	string	Data e ora utc quando l'operazione è stata creata.
error	Error	Errore di operazione rilevato, se disponibile.
etag	string	Operazione ETag.
lastActionDateTime	string	Data e ora utc quando lo stato dell'operazione è stato aggiornato.
operationId	string	ID dell'operazione.
resourceLocation	string	Posizione dell'aggiornamento importato al termine dell'operazione.
status	OperationStatus	Stato dell'operazione.
traceId	string	Identità di correlazione dell'operazione che può essere usata da 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 del manifesto di importazione.