Device Management - Get Deployment Status

Service:

Device Update

Version d'API:

2022-10-01

Obtient l’état d’un déploiement, y compris la répartition du nombre d’appareils dans le déploiement en cours, terminés ou ayant échoué.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status?api-version=2022-10-01

Paramètres URI

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

Réponses

Nom	Type	Description
200 OK	DeploymentStatus	État du déploiement.
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

DeviceManagement_GetDeploymentStatus

Exemple de requête

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/groups/TestGroup/deployments/deploymentId/status?api-version=2022-10-01

Exemple de réponse

Code d’état:

200

{
  "groupId": "TestGroup",
  "deploymentState": "ActiveWithSubgroupFailures",
  "subgroupStatus": [
    {
      "groupId": "TestGroup",
      "deviceClassId": "deviceClassId1",
      "deploymentState": "Active",
      "totalDevices": 1,
      "devicesInProgressCount": 0,
      "devicesCompletedFailedCount": 0,
      "devicesCompletedSucceededCount": 1,
      "devicesCanceledCount": 0
    },
    {
      "groupId": "TestGroup",
      "deviceClassId": "deviceClassId2",
      "deploymentState": "Failed",
      "error": {
        "code": "ADMConfigurationLimitExceeded",
        "message": "The subgroup deployment failed to be created due to hitting the ADM configuration limit"
      },
      "totalDevices": 2,
      "devicesInProgressCount": 0,
      "devicesCompletedFailedCount": 1,
      "devicesCompletedSucceededCount": 1,
      "devicesCanceledCount": 0
    }
  ]
}

Définitions

Nom	Description
DeploymentState	État du déploiement.
DeploymentStatus	Métadonnées d’état du déploiement.
DeviceClassSubgroupDeploymentState	État du déploiement du sous-groupe de classes d’appareil.
DeviceClassSubgroupDeploymentStatus	Métadonnées d’état du déploiement du sous-groupe de classes d’appareil.
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.

DeploymentState

Énumération

État du déploiement.

Valeur	Description
Active	Le déploiement peut être envoyé aux appareils ciblés dans le déploiement.
ActiveWithSubgroupFailures	Le déploiement peut être envoyé à certains appareils ciblés dans le déploiement, mais au moins 1 sous-groupe est dans un état d’échec.
Canceled	Le déploiement a été annulé et aucun appareil ne le recevra.
Failed	Le déploiement ne sera envoyé à aucun appareil. Consultez l’erreur pour plus d’informations sur ce qui a échoué.
Inactive	Un déploiement plus récent pour ce groupe a été créé et aucun appareil du groupe ne recevra ce déploiement.

DeploymentStatus

Object

Métadonnées d’état du déploiement.

Nom	Type	Description
deploymentState	DeploymentState	État du déploiement.
error	Error	Détails de l’erreur de l’état d’échec. Cela n’est pas présent si l’état du déploiement n’est pas échec.
groupId	string	Identité de groupe
subgroupStatus	DeviceClassSubgroupDeploymentStatus[]	Collection d’objets d’état de sous-groupe de classes d’appareil

DeviceClassSubgroupDeploymentState

Énumération

État du déploiement du sous-groupe de classes d’appareil.

Valeur	Description
Active	Le déploiement du sous-groupe peut être envoyé aux appareils ciblés dans le déploiement.
Canceled	Le déploiement du sous-groupe a été annulé et aucun appareil ne le recevra.
Failed	Le déploiement du sous-groupe a échoué et ne sera envoyé à aucun appareil.
Inactive	Un déploiement plus récent pour ce sous-groupe a été créé et aucun appareil du sous-groupe ne recevra ce déploiement.

DeviceClassSubgroupDeploymentStatus

Object

Métadonnées d’état du déploiement du sous-groupe de classes d’appareil.

Nom	Type	Description
deploymentState	DeviceClassSubgroupDeploymentState	État du déploiement du sous-groupe.
deviceClassId	string	Identité du sous-groupe de classes d’appareils
devicesCanceledCount	integer (int32)	Nombre d’appareils dont le déploiement a été annulé.
devicesCompletedFailedCount	integer (int32)	Nombre d’appareils qui ont terminé le déploiement avec un échec.
devicesCompletedSucceededCount	integer (int32)	Nombre d’appareils qui ont réussi à effectuer le déploiement.
devicesInProgressCount	integer (int32)	Nombre d’appareils actuellement en cours de déploiement.
error	Error	Détails de l’erreur de l’état d’échec. Cela n’est pas présent si l’état du déploiement n’est pas échec.
groupId	string	Identité de groupe
totalDevices	integer (int32)	Nombre total d’appareils dans le déploiement.

Error

Object

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur défini par le serveur.
details	Error[]	Tableau d’erreurs qui ont 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-time)	Date et heure UTC lorsque l’erreur s’est produite.
target	string	Cible de l’erreur.

ErrorResponse

Object

Réponse d’erreur courante.

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

InnerError

Object

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 ce qui a été fourni par l’erreur contenante.
errorDetail	string	Message d’erreur interne ou d’exception.
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.