Device Update - Get Operation Status

Service:

Device Update

Version d'API:

2022-10-01

Récupérer les status d’opération.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Device Update pour IoT Hub point de terminaison de compte (nom d’hôte uniquement, aucun protocole).
instanceId	path	True	string	Identificateur de instance de compte Device Update pour IoT Hub.
operationId	path	True	string	Identificateur d'opération.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-None-Match		string	Définit la condition If-None-Match. L’opération n’est effectuée que si l’ETag sur le serveur ne correspond pas à cette valeur.

Réponses

Nom	Type	Description
200 OK	UpdateOperation	État de l’opération. En-têtes Retry-After: string
Other Status Codes	ErrorResponse	Réponse par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://api.adu.microsoft.com/.default	Étendue d’autorisation par défaut.

Exemples

DeviceUpdate_GetOperationStatus

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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\""
}

Définitions

Nom	Description
Error	Détails de l’erreur.
ErrorResponse	Réponse d’erreur courante.
InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
OperationStatus	État de l’opération.
UpdateId	Mettre à jour l’identificateur.
UpdateInfo	Mettre à jour les informations.
UpdateOperation	Métadonnées d’opération.

Error

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur défini par le serveur.
details	Error[]	Tableau d’erreurs ayant conduit à l’erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
occurredDateTime	string	Date et heure UTC auxquelles l’erreur s’est produite.
target	string	Cible de l’erreur.

ErrorResponse

Réponse d’erreur courante.

Nom	Type	Description
error	Error	Détails de l’erreur.

InnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que celui fourni par l’erreur contenante.
errorDetail	string	Message d’erreur ou d’exception interne.
innerError	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.

OperationStatus

État de l’opération.

Nom	Type	Description
Failed	string	L’opération en arrière-plan a échoué.
NotStarted	string	Opération en arrière-plan créée mais pas encore démarrée.
Running	string	L’opération en arrière-plan est en cours d’exécution.
Succeeded	string	L’opération en arrière-plan s’est terminée avec succès.

UpdateId

Mettre à jour l’identificateur.

Nom	Type	Description
name	string	Mettre à jour le nom.
provider	string	Mettre à jour le fournisseur.
version	string	Mettre à jour la version.

UpdateInfo

Mettre à jour les informations.

Nom	Type	Description
description	string	Mettre à jour la description.
friendlyName	string	Nom de la mise à jour conviviale.
updateId	UpdateId	Mettre à jour l’identificateur.

UpdateOperation

Métadonnées d’opération.

Nom	Type	Description
createdDateTime	string	Date et heure utc de création de l’opération.
error	Error	Une erreur d’opération s’est produite, le cas échéant.
etag	string	Opération ETag.
lastActionDateTime	string	Date et heure UTC de la dernière mise à jour de l’opération status.
operationId	string	ID d'opération.
resourceLocation	string	Emplacement de la mise à jour importée lorsque l’opération réussit.
status	OperationStatus	État de l’opération.
traceId	string	Identité de corrélation d’opération qui peut être utilisée par Support Microsoft pour la résolution des problèmes.
update	UpdateInfo	Mise à jour importée ou supprimée. Pour l’importation, cette propriété n’est renseignée qu’une fois le manifeste d’importation traité avec succès.