Device Management - Get Device Class Subgroup Deployment Status

Servicio:

Device Update

Versión de la API:

2022-10-01

Obtiene el estado de una implementación, incluido un desglose del número de dispositivos de la implementación en curso, completados o con errores.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
deploymentId	path	True	string	Identificador de implementación.
deviceClassId	path	True	string	Identificador de clase de dispositivo.
endpoint	path	True	string (url)	El punto de conexión de la cuenta de Device Update para IoT Hub (solo nombre de host, sin protocolo).
groupId	path	True	string	Identificador de grupo.
instanceId	path	True	string	Identificador de instancia de cuenta de Device Update para IoT Hub.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	DeviceClassSubgroupDeploymentStatus	Estado de la implementación del subgrupo de clase de dispositivo.
Other Status Codes	ErrorResponse	Respuesta predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://api.adu.microsoft.com/.default	Ámbito de autorización predeterminado.

Ejemplos

DeviceManagement_GetDeviceClassSubgroupDeploymentStatus

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "groupId": "TestGroup",
  "deviceClassId": "deviceClassId",
  "deploymentState": "Active",
  "totalDevices": 1,
  "devicesInProgressCount": 0,
  "devicesCompletedFailedCount": 0,
  "devicesCompletedSucceededCount": 1,
  "devicesCanceledCount": 0
}

Definiciones

Nombre	Description
DeviceClassSubgroupDeploymentState	Estado de implementación de subgrupo de clase de dispositivo.
DeviceClassSubgroupDeploymentStatus	Metadatos de estado de implementación de subgrupo de clase de dispositivo.
Error	Detalles del error.
ErrorResponse	Respuesta de error común.
InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

DeviceClassSubgroupDeploymentState

Enumeración

Estado de implementación de subgrupo de clase de dispositivo.

Valor	Description
Active	La implementación del subgrupo se puede enviar a los dispositivos destinados a la implementación.
Canceled	La implementación del subgrupo se ha cancelado y ningún dispositivo lo recibirá.
Failed	Error en la implementación del subgrupo y no se enviará a ningún dispositivo.
Inactive	Se ha creado una implementación más reciente para este subgrupo y ningún dispositivo del subgrupo recibirá esta implementación.

DeviceClassSubgroupDeploymentStatus

Object

Metadatos de estado de implementación de subgrupo de clase de dispositivo.

Nombre	Tipo	Description
deploymentState	DeviceClassSubgroupDeploymentState	Estado de la implementación del subgrupo.
deviceClassId	string	Identidad del subgrupo de clase de dispositivo
devicesCanceledCount	integer (int32)	Número de dispositivos que han cancelado su implementación.
devicesCompletedFailedCount	integer (int32)	Número de dispositivos que han completado la implementación con un error.
devicesCompletedSucceededCount	integer (int32)	Número de dispositivos que han completado correctamente la implementación.
devicesInProgressCount	integer (int32)	Número de dispositivos que se encuentran actualmente en la implementación.
error	Error	Detalles del error del estado Error. Esto no está presente si el estado de implementación no es Erróneo.
groupId	string	Identidad del grupo
totalDevices	integer (int32)	Número total de dispositivos de la implementación.

Error

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error definido por el servidor.
details	Error[]	Matriz de errores que llevaron al error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
occurredDateTime	string (date-time)	Fecha y hora en UTC cuando se produjo el error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error común.

Nombre	Tipo	Description
error	Error	Detalles del error.

InnerError

Object

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
code	string	Código de error más específico que el proporcionado por el error contenedor.
errorDetail	string	Mensaje interno de error o excepción.
innerError	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.