Device Management - Get Device Class Subgroup Deployment Status

Szolgáltatás:

Device Update

API-verzió:

2022-10-01

Lekérdezi az üzembe helyezés állapotát, beleértve annak lebontását, hogy hány eszköz van folyamatban, fejeződött be vagy sikertelen.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
deploymentId	path	True	string	Üzembehelyezési azonosító.
deviceClassId	path	True	string	Eszközosztály azonosítója.
endpoint	path	True	string (url)	Az IoT Hub-fiók végpontjának eszközfrissítése (csak gazdagépnév, protokoll nélkül).
groupId	path	True	string	Csoportazonosító.
instanceId	path	True	string	Az IoT Hub-fiókpéldány-azonosító eszközfrissítése.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Válaszok

Name	Típus	Description
200 OK	DeviceClassSubgroupDeploymentStatus	Az eszközosztály-alcsoport üzembe helyezésének állapota.
Other Status Codes	ErrorResponse	Alapértelmezett válasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://api.adu.microsoft.com/.default	Alapértelmezett engedélyezési hatókör.

Példák

DeviceManagement_GetDeviceClassSubgroupDeploymentStatus

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
DeviceClassSubgroupDeploymentState	Eszközosztály alcsoport üzembehelyezési állapota.
DeviceClassSubgroupDeploymentStatus	Eszközosztály-alcsoport üzembehelyezési állapotának metaadatai.
Error	Hiba részletei.
ErrorResponse	Gyakori hibaválasz.
InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

DeviceClassSubgroupDeploymentState

Enumerálás

Eszközosztály alcsoport üzembehelyezési állapota.

Érték	Description
Active	Az alcsoport központi telepítése elküldhető az üzemelő példányban megcélzott eszközökre.
Canceled	Az alcsoport üzembe helyezését megszakították, és egyetlen eszköz sem kapja meg.
Failed	Az alcsoport üzembe helyezése sikertelen volt, és nem lesz elküldve egyetlen eszközre sem.
Inactive	Létre lett hozva egy újabb üzembe helyezés ehhez az alcsoporthoz, és az alcsoportban lévő eszközök nem kapják meg ezt az üzembe helyezést.

DeviceClassSubgroupDeploymentStatus

Objektum

Eszközosztály-alcsoport üzembehelyezési állapotának metaadatai.

Name	Típus	Description
deploymentState	DeviceClassSubgroupDeploymentState	Az alcsoport üzembe helyezésének állapota.
deviceClassId	string	Az eszközosztály alcsoport-identitása
devicesCanceledCount	integer (int32)	Azon eszközök száma, amelyek üzembe helyezését megszakították.
devicesCompletedFailedCount	integer (int32)	Azon eszközök száma, amelyek sikertelen üzembe helyezést hajtottak végre.
devicesCompletedSucceededCount	integer (int32)	Azon eszközök száma, amelyek sikeresen befejezték az üzembe helyezést.
devicesInProgressCount	integer (int32)	Az üzembe helyezés alatt álló eszközök száma.
error	Error	A sikertelen állapot hibaadatai. Ez nem jelenik meg, ha az üzembehelyezési állapot nem sikertelen.
groupId	string	A csoport identitása
totalDevices	integer (int32)	Az üzembe helyezésben lévő eszközök teljes száma.

Error

Objektum

Hiba részletei.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakód.
details	Error[]	Hibatömb, amely a jelentett hibához vezetett.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
occurredDateTime	string (date-time)	A hiba bekövetkezésének dátuma és időpontja (UTC).
target	string	A hiba célja.

ErrorResponse

Objektum

Gyakori hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Objektum

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
errorDetail	string	A belső hiba vagy kivétel üzenete.
innerError	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.