DeviceManagementOperations interface

Paket:

@azure/iot-device-update

Schnittstelle, die eine DeviceManagement-Operation darstellt.

Eigenschaften

createOrUpdateDeployment	Erstellt oder aktualisiert eine Bereitstellung.
deleteDeployment	Löscht eine Bereitstellung.
deleteDeploymentForDeviceClassSubgroup	Löscht eine Geräteklassenuntergruppenbereitstellung.
deleteDeviceClass	Löscht eine Geräteklasse. Geräteklassen werden automatisch erstellt, wenn geräteupdatefähige Geräte mit dem Hub verbunden sind, aber nicht automatisch bereinigt werden, da sie von DeviceClassSubgroups referenziert werden. Wenn der Benutzer alle DeviceClassSubgroups für eine Geräteklasse gelöscht hat, kann er auch die Geräteklasse löschen, um die Datensätze aus dem System zu entfernen und die Kompatibilität dieser Geräteklasse mit neuen Updates zu beenden. Wenn ein Gerät jemals für diese Geräteklasse erneut verbunden wird, wird es erneut erstellt.
deleteDeviceClassSubgroup	Löscht eine Untergruppe der Geräteklasse. Diese Untergruppe wird automatisch erstellt, wenn ein Geräteupdate-fähiges Gerät mit dem Hub verbunden ist und seine Eigenschaften meldet. Gruppen, Untergruppen und Bereitstellungen werden nicht automatisch bereinigt, sondern für Verlaufszwecke aufbewahrt. Benutzer können diese Methode aufrufen, um eine Untergruppe zu löschen, wenn sie keinen verlauf der Untergruppe beibehalten und nicht mehr benötigen. Wenn ein Gerät jemals erneut für diese Untergruppe verbunden ist, nachdem die Untergruppe gelöscht wurde, wird es automatisch neu erstellt, aber es gibt keinen Verlauf.
deleteGroup	Löscht eine Gerätegruppe. Diese Gruppe wird automatisch erstellt, wenn ein Geräteupdate-fähiges Gerät mit dem Hub verbunden ist, und meldet dessen Eigenschaften. Gruppen, Untergruppen und Bereitstellungen werden nicht automatisch bereinigt, sondern für Verlaufszwecke aufbewahrt. Benutzer können diese Methode aufrufen, um eine Gruppe zu löschen, wenn sie keinen der Historien der Gruppe beibehalten müssen und sie nicht mehr benötigen. Wenn ein Gerät jemals erneut für diese Gruppe verbunden ist, nachdem die Gruppe gelöscht wurde, wird es automatisch neu erstellt, aber es gibt keinen Verlauf.
getBestUpdatesForDeviceClassSubgroup	Holen Sie sich das beste verfügbare Update für eine Geräteklassenuntergruppe und eine Anzahl der Geräte, die dieses Update benötigen.
getDeployment	Ruft die Bereitstellungseigenschaften ab.
getDeploymentForDeviceClassSubgroup	Ruft die Bereitstellungseigenschaften ab.
getDeploymentStatus	Ruft den Status einer Bereitstellung ab, einschließlich einer Aufschlüsselung der Anzahl der Geräte, die in der Bereitstellung ausgeführt, abgeschlossen oder fehlgeschlagen sind.
getDevice	Ruft die Geräteeigenschaften und den neuesten Bereitstellungsstatus für ein Gerät ab, das mit Dem Geräteupdate für IoT Hub verbunden ist.
getDeviceClass	Ruft die Eigenschaften einer Geräteklasse ab.
getDeviceClassSubgroup	Ruft Details der Untergruppe der Geräteklasse ab. Eine Untergruppe der Geräteklasse ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit den gleichen Updates kompatibel.
getDeviceClassSubgroupDeploymentStatus	Ruft den Status einer Bereitstellung ab, einschließlich einer Aufschlüsselung der Anzahl der Geräte, die in der Bereitstellung ausgeführt, abgeschlossen oder fehlgeschlagen sind.
getDeviceClassSubgroupUpdateCompliance	Rufen Sie Complianceinformationen zur Geräteklasse-Untergruppenaktualisierung ab, z. B. wie viele Geräte auf ihrem neuesten Update vorhanden sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates ausgeführt werden.
getDeviceModule	Ruft die Gerätemoduleigenschaften und den neuesten Bereitstellungsstatus für ein Mit Device Update für IoT Hub verbundenes Gerätemodul ab.
getGroup	Ruft die Gerätegruppeneigenschaften ab.
getLogCollection	Abrufen der Gerätediagnoseprotokollsammlung
getLogCollectionDetailedStatus	Abrufen der Protokollsammlung mit detailliertem Status
getOperationStatus	Vorgangsstatus abrufen.
getUpdateCompliance	Ruft die Aufschlüsselung der Anzahl der Geräte auf ihrem neuesten Update ab, haben neue Updates zur Verfügung oder werden gerade neue Updates empfangen.
getUpdateComplianceForGroup	Rufen Sie Complianceinformationen für Gerätegruppenupdates ab, z. B. wie viele Geräte auf ihrem neuesten Update sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates ausgeführt werden.
importDevices	Importieren Sie vorhandene Geräte aus IoT Hub. Dies ist ein lang andauernder Vorgang; verwenden Sie Operation-Location Antwortheaderwert, um den Vorgangsstatus zu überprüfen.
listBestUpdatesForGroup	Erhalten Sie die besten verfügbaren Updates für eine Gerätegruppe und eine Anzahl der Geräte, die jedes Update benötigen.
listDeploymentsForDeviceClassSubgroup	Ruft eine Liste der Bereitstellungen für eine Untergruppe der Geräteklasse ab.
listDeploymentsForGroup	Ruft eine Liste der Bereitstellungen für eine Gerätegruppe ab.
listDeviceClasses	Ruft eine Liste aller Geräteklassen (Gerätegruppen, die mit den gleichen Updates kompatibel sind, basierend auf den Modell-ID- und Compat-Eigenschaften, die in der Device Update PnP-Schnittstelle in IoT Hub angegeben sind) für alle Geräte ab, die mit Device Update für IoT Hub verbunden sind.
listDeviceClassSubgroupsForGroup	Rufen Sie die Geräteklassenuntergruppen für die Gruppe ab. Eine Untergruppe der Geräteklasse ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit den gleichen Updates kompatibel.
listDevices	Ruft eine Liste der Geräte ab, die mit Dem Geräteupdate für IoT Hub verbunden sind.
listDeviceStatesForDeviceClassSubgroupDeployment	Ruft eine Liste der Geräte in einer Bereitstellung zusammen mit ihrem Status ab. Nützlich für das Abrufen einer Liste der fehlgeschlagenen Geräte.
listGroups	Ruft eine Liste aller Gerätegruppen ab. Die gruppe $default wird immer zuerst zurückgegeben.
listHealthOfDevices	Liste der Geräteintegrität abrufen
listInstallableUpdatesForDeviceClass	Ruft eine Liste der installierbaren Updates für eine Geräteklasse ab.
listLogCollections	Abrufen aller Gerätediagnoseprotokollsammlungen
listOperationStatuses	Dient zum Abrufen einer Liste aller Geräteimportvorgänge. Abgeschlossene Vorgänge werden 7 Tage vor dem automatischen Löschen aufbewahrt.
retryDeployment	Es wird eine Bereitstellung mit fehlgeschlagenen Geräten erneut ausgeführt.
startLogCollection	Starten Sie die Gerätediagnoseprotokollauflistung auf angegebenen Geräten.
stopDeployment	Beendet eine Bereitstellung.
updateDeviceClass	Aktualisieren von Geräteklassendetails.

Details zur Eigenschaft

createOrUpdateDeployment

Erstellt oder aktualisiert eine Bereitstellung.

createOrUpdateDeployment: (groupId: string, deploymentId: string, deployment: Deployment, options?: DeviceManagementCreateOrUpdateDeploymentOptionalParams) => Promise<Deployment>

Eigenschaftswert

(groupId: string, deploymentId: string, deployment: Deployment, options?: DeviceManagementCreateOrUpdateDeploymentOptionalParams) => Promise<Deployment>

deleteDeployment

Löscht eine Bereitstellung.

deleteDeployment: (groupId: string, deploymentId: string, options?: DeviceManagementDeleteDeploymentOptionalParams) => Promise<void>

Eigenschaftswert

(groupId: string, deploymentId: string, options?: DeviceManagementDeleteDeploymentOptionalParams) => Promise<void>

deleteDeploymentForDeviceClassSubgroup

Löscht eine Geräteklassenuntergruppenbereitstellung.

deleteDeploymentForDeviceClassSubgroup: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams) => Promise<void>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams) => Promise<void>

deleteDeviceClass

Löscht eine Geräteklasse. Geräteklassen werden automatisch erstellt, wenn geräteupdatefähige Geräte mit dem Hub verbunden sind, aber nicht automatisch bereinigt werden, da sie von DeviceClassSubgroups referenziert werden. Wenn der Benutzer alle DeviceClassSubgroups für eine Geräteklasse gelöscht hat, kann er auch die Geräteklasse löschen, um die Datensätze aus dem System zu entfernen und die Kompatibilität dieser Geräteklasse mit neuen Updates zu beenden. Wenn ein Gerät jemals für diese Geräteklasse erneut verbunden wird, wird es erneut erstellt.

deleteDeviceClass: (deviceClassId: string, options?: DeviceManagementDeleteDeviceClassOptionalParams) => Promise<void>

Eigenschaftswert

(deviceClassId: string, options?: DeviceManagementDeleteDeviceClassOptionalParams) => Promise<void>

deleteDeviceClassSubgroup

Löscht eine Untergruppe der Geräteklasse. Diese Untergruppe wird automatisch erstellt, wenn ein Geräteupdate-fähiges Gerät mit dem Hub verbunden ist und seine Eigenschaften meldet. Gruppen, Untergruppen und Bereitstellungen werden nicht automatisch bereinigt, sondern für Verlaufszwecke aufbewahrt. Benutzer können diese Methode aufrufen, um eine Untergruppe zu löschen, wenn sie keinen verlauf der Untergruppe beibehalten und nicht mehr benötigen. Wenn ein Gerät jemals erneut für diese Untergruppe verbunden ist, nachdem die Untergruppe gelöscht wurde, wird es automatisch neu erstellt, aber es gibt keinen Verlauf.

deleteDeviceClassSubgroup: (groupId: string, deviceClassId: string, options?: DeviceManagementDeleteDeviceClassSubgroupOptionalParams) => Promise<void>

Eigenschaftswert

(groupId: string, deviceClassId: string, options?: DeviceManagementDeleteDeviceClassSubgroupOptionalParams) => Promise<void>

deleteGroup

Löscht eine Gerätegruppe. Diese Gruppe wird automatisch erstellt, wenn ein Geräteupdate-fähiges Gerät mit dem Hub verbunden ist, und meldet dessen Eigenschaften. Gruppen, Untergruppen und Bereitstellungen werden nicht automatisch bereinigt, sondern für Verlaufszwecke aufbewahrt. Benutzer können diese Methode aufrufen, um eine Gruppe zu löschen, wenn sie keinen der Historien der Gruppe beibehalten müssen und sie nicht mehr benötigen. Wenn ein Gerät jemals erneut für diese Gruppe verbunden ist, nachdem die Gruppe gelöscht wurde, wird es automatisch neu erstellt, aber es gibt keinen Verlauf.

deleteGroup: (groupId: string, options?: DeviceManagementDeleteGroupOptionalParams) => Promise<void>

Eigenschaftswert

(groupId: string, options?: DeviceManagementDeleteGroupOptionalParams) => Promise<void>

getBestUpdatesForDeviceClassSubgroup

Holen Sie sich das beste verfügbare Update für eine Geräteklassenuntergruppe und eine Anzahl der Geräte, die dieses Update benötigen.

getBestUpdatesForDeviceClassSubgroup: (groupId: string, deviceClassId: string, options?: DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams) => Promise<DeviceClassSubgroupUpdatableDevices>

Eigenschaftswert

(groupId: string, deviceClassId: string, options?: DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams) => Promise<DeviceClassSubgroupUpdatableDevices>

getDeployment

Ruft die Bereitstellungseigenschaften ab.

getDeployment: (groupId: string, deploymentId: string, options?: DeviceManagementGetDeploymentOptionalParams) => Promise<Deployment>

Eigenschaftswert

(groupId: string, deploymentId: string, options?: DeviceManagementGetDeploymentOptionalParams) => Promise<Deployment>

getDeploymentForDeviceClassSubgroup

Ruft die Bereitstellungseigenschaften ab.

getDeploymentForDeviceClassSubgroup: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams) => Promise<Deployment>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams) => Promise<Deployment>

getDeploymentStatus

Ruft den Status einer Bereitstellung ab, einschließlich einer Aufschlüsselung der Anzahl der Geräte, die in der Bereitstellung ausgeführt, abgeschlossen oder fehlgeschlagen sind.

getDeploymentStatus: (groupId: string, deploymentId: string, options?: DeviceManagementGetDeploymentStatusOptionalParams) => Promise<DeploymentStatus>

Eigenschaftswert

(groupId: string, deploymentId: string, options?: DeviceManagementGetDeploymentStatusOptionalParams) => Promise<DeploymentStatus>

getDevice

Ruft die Geräteeigenschaften und den neuesten Bereitstellungsstatus für ein Gerät ab, das mit Dem Geräteupdate für IoT Hub verbunden ist.

getDevice: (deviceId: string, options?: DeviceManagementGetDeviceOptionalParams) => Promise<Device>

Eigenschaftswert

(deviceId: string, options?: DeviceManagementGetDeviceOptionalParams) => Promise<Device>

getDeviceClass

Ruft die Eigenschaften einer Geräteklasse ab.

getDeviceClass: (deviceClassId: string, options?: DeviceManagementGetDeviceClassOptionalParams) => Promise<DeviceClass>

Eigenschaftswert

(deviceClassId: string, options?: DeviceManagementGetDeviceClassOptionalParams) => Promise<DeviceClass>

getDeviceClassSubgroup

Ruft Details der Untergruppe der Geräteklasse ab. Eine Untergruppe der Geräteklasse ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit den gleichen Updates kompatibel.

getDeviceClassSubgroup: (groupId: string, deviceClassId: string, options?: DeviceManagementGetDeviceClassSubgroupOptionalParams) => Promise<DeviceClassSubgroup>

Eigenschaftswert

(groupId: string, deviceClassId: string, options?: DeviceManagementGetDeviceClassSubgroupOptionalParams) => Promise<DeviceClassSubgroup>

getDeviceClassSubgroupDeploymentStatus

Ruft den Status einer Bereitstellung ab, einschließlich einer Aufschlüsselung der Anzahl der Geräte, die in der Bereitstellung ausgeführt, abgeschlossen oder fehlgeschlagen sind.

getDeviceClassSubgroupDeploymentStatus: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams) => Promise<DeviceClassSubgroupDeploymentStatus>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams) => Promise<DeviceClassSubgroupDeploymentStatus>

getDeviceClassSubgroupUpdateCompliance

Rufen Sie Complianceinformationen zur Geräteklasse-Untergruppenaktualisierung ab, z. B. wie viele Geräte auf ihrem neuesten Update vorhanden sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates ausgeführt werden.

getDeviceClassSubgroupUpdateCompliance: (groupId: string, deviceClassId: string, options?: DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams) => Promise<UpdateCompliance>

Eigenschaftswert

(groupId: string, deviceClassId: string, options?: DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams) => Promise<UpdateCompliance>

getDeviceModule

Ruft die Gerätemoduleigenschaften und den neuesten Bereitstellungsstatus für ein Mit Device Update für IoT Hub verbundenes Gerätemodul ab.

getDeviceModule: (deviceId: string, moduleId: string, options?: DeviceManagementGetDeviceModuleOptionalParams) => Promise<Device>

Eigenschaftswert

(deviceId: string, moduleId: string, options?: DeviceManagementGetDeviceModuleOptionalParams) => Promise<Device>

getGroup

Ruft die Gerätegruppeneigenschaften ab.

getGroup: (groupId: string, options?: DeviceManagementGetGroupOptionalParams) => Promise<Group>

Eigenschaftswert

(groupId: string, options?: DeviceManagementGetGroupOptionalParams) => Promise<Group>

getLogCollection

Abrufen der Gerätediagnoseprotokollsammlung

getLogCollection: (logCollectionId: string, options?: DeviceManagementGetLogCollectionOptionalParams) => Promise<LogCollection>

Eigenschaftswert

(logCollectionId: string, options?: DeviceManagementGetLogCollectionOptionalParams) => Promise<LogCollection>

getLogCollectionDetailedStatus

Abrufen der Protokollsammlung mit detailliertem Status

getLogCollectionDetailedStatus: (logCollectionId: string, options?: DeviceManagementGetLogCollectionDetailedStatusOptionalParams) => Promise<LogCollectionOperationDetailedStatus>

Eigenschaftswert

(logCollectionId: string, options?: DeviceManagementGetLogCollectionDetailedStatusOptionalParams) => Promise<LogCollectionOperationDetailedStatus>

getOperationStatus

Vorgangsstatus abrufen.

getOperationStatus: (operationId: string, options?: DeviceManagementGetOperationStatusOptionalParams) => Promise<DeviceOperation>

Eigenschaftswert

(operationId: string, options?: DeviceManagementGetOperationStatusOptionalParams) => Promise<DeviceOperation>

getUpdateCompliance

Ruft die Aufschlüsselung der Anzahl der Geräte auf ihrem neuesten Update ab, haben neue Updates zur Verfügung oder werden gerade neue Updates empfangen.

getUpdateCompliance: (options?: DeviceManagementGetUpdateComplianceOptionalParams) => Promise<UpdateCompliance>

Eigenschaftswert

(options?: DeviceManagementGetUpdateComplianceOptionalParams) => Promise<UpdateCompliance>

getUpdateComplianceForGroup

Rufen Sie Complianceinformationen für Gerätegruppenupdates ab, z. B. wie viele Geräte auf ihrem neuesten Update sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates ausgeführt werden.

getUpdateComplianceForGroup: (groupId: string, options?: DeviceManagementGetUpdateComplianceForGroupOptionalParams) => Promise<UpdateCompliance>

Eigenschaftswert

(groupId: string, options?: DeviceManagementGetUpdateComplianceForGroupOptionalParams) => Promise<UpdateCompliance>

importDevices

Importieren Sie vorhandene Geräte aus IoT Hub. Dies ist ein lang andauernder Vorgang; verwenden Sie Operation-Location Antwortheaderwert, um den Vorgangsstatus zu überprüfen.

importDevices: (importType: ImportType, options?: DeviceManagementImportDevicesOptionalParams) => PollerLike<OperationState<void>, void>

Eigenschaftswert

(importType: ImportType, options?: DeviceManagementImportDevicesOptionalParams) => PollerLike<OperationState<void>, void>

listBestUpdatesForGroup

Erhalten Sie die besten verfügbaren Updates für eine Gerätegruppe und eine Anzahl der Geräte, die jedes Update benötigen.

listBestUpdatesForGroup: (groupId: string, options?: DeviceManagementListBestUpdatesForGroupOptionalParams) => PagedAsyncIterableIterator<DeviceClassSubgroupUpdatableDevices, DeviceClassSubgroupUpdatableDevices[], PageSettings>

Eigenschaftswert

(groupId: string, options?: DeviceManagementListBestUpdatesForGroupOptionalParams) => PagedAsyncIterableIterator<DeviceClassSubgroupUpdatableDevices, DeviceClassSubgroupUpdatableDevices[], PageSettings>

listDeploymentsForDeviceClassSubgroup

Ruft eine Liste der Bereitstellungen für eine Untergruppe der Geräteklasse ab.

listDeploymentsForDeviceClassSubgroup: (groupId: string, deviceClassId: string, options?: DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams) => PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

Eigenschaftswert

(groupId: string, deviceClassId: string, options?: DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams) => PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

listDeploymentsForGroup

Ruft eine Liste der Bereitstellungen für eine Gerätegruppe ab.

listDeploymentsForGroup: (groupId: string, options?: DeviceManagementListDeploymentsForGroupOptionalParams) => PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

Eigenschaftswert

(groupId: string, options?: DeviceManagementListDeploymentsForGroupOptionalParams) => PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

listDeviceClasses

Ruft eine Liste aller Geräteklassen (Gerätegruppen, die mit den gleichen Updates kompatibel sind, basierend auf den Modell-ID- und Compat-Eigenschaften, die in der Device Update PnP-Schnittstelle in IoT Hub angegeben sind) für alle Geräte ab, die mit Device Update für IoT Hub verbunden sind.

listDeviceClasses: (options?: DeviceManagementListDeviceClassesOptionalParams) => PagedAsyncIterableIterator<DeviceClass, DeviceClass[], PageSettings>

Eigenschaftswert

(options?: DeviceManagementListDeviceClassesOptionalParams) => PagedAsyncIterableIterator<DeviceClass, DeviceClass[], PageSettings>

listDeviceClassSubgroupsForGroup

Rufen Sie die Geräteklassenuntergruppen für die Gruppe ab. Eine Untergruppe der Geräteklasse ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit den gleichen Updates kompatibel.

listDeviceClassSubgroupsForGroup: (groupId: string, options?: DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams) => PagedAsyncIterableIterator<DeviceClassSubgroup, DeviceClassSubgroup[], PageSettings>

Eigenschaftswert

(groupId: string, options?: DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams) => PagedAsyncIterableIterator<DeviceClassSubgroup, DeviceClassSubgroup[], PageSettings>

listDevices

Ruft eine Liste der Geräte ab, die mit Dem Geräteupdate für IoT Hub verbunden sind.

listDevices: (options?: DeviceManagementListDevicesOptionalParams) => PagedAsyncIterableIterator<Device, Device[], PageSettings>

Eigenschaftswert

(options?: DeviceManagementListDevicesOptionalParams) => PagedAsyncIterableIterator<Device, Device[], PageSettings>

listDeviceStatesForDeviceClassSubgroupDeployment

Ruft eine Liste der Geräte in einer Bereitstellung zusammen mit ihrem Status ab. Nützlich für das Abrufen einer Liste der fehlgeschlagenen Geräte.

listDeviceStatesForDeviceClassSubgroupDeployment: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams) => PagedAsyncIterableIterator<DeploymentDeviceState, DeploymentDeviceState[], PageSettings>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams) => PagedAsyncIterableIterator<DeploymentDeviceState, DeploymentDeviceState[], PageSettings>

listGroups

Ruft eine Liste aller Gerätegruppen ab. Die gruppe $default wird immer zuerst zurückgegeben.

listGroups: (options?: DeviceManagementListGroupsOptionalParams) => PagedAsyncIterableIterator<Group, Group[], PageSettings>

Eigenschaftswert

(options?: DeviceManagementListGroupsOptionalParams) => PagedAsyncIterableIterator<Group, Group[], PageSettings>

listHealthOfDevices

Liste der Geräteintegrität abrufen

listHealthOfDevices: (filter: string, options?: DeviceManagementListHealthOfDevicesOptionalParams) => PagedAsyncIterableIterator<DeviceHealth, DeviceHealth[], PageSettings>

Eigenschaftswert

(filter: string, options?: DeviceManagementListHealthOfDevicesOptionalParams) => PagedAsyncIterableIterator<DeviceHealth, DeviceHealth[], PageSettings>

listInstallableUpdatesForDeviceClass

Ruft eine Liste der installierbaren Updates für eine Geräteklasse ab.

listInstallableUpdatesForDeviceClass: (deviceClassId: string, options?: DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams) => PagedAsyncIterableIterator<UpdateInfo, UpdateInfo[], PageSettings>

Eigenschaftswert

(deviceClassId: string, options?: DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams) => PagedAsyncIterableIterator<UpdateInfo, UpdateInfo[], PageSettings>

listLogCollections

Abrufen aller Gerätediagnoseprotokollsammlungen

listLogCollections: (options?: DeviceManagementListLogCollectionsOptionalParams) => PagedAsyncIterableIterator<LogCollection, LogCollection[], PageSettings>

Eigenschaftswert

(options?: DeviceManagementListLogCollectionsOptionalParams) => PagedAsyncIterableIterator<LogCollection, LogCollection[], PageSettings>

listOperationStatuses

Dient zum Abrufen einer Liste aller Geräteimportvorgänge. Abgeschlossene Vorgänge werden 7 Tage vor dem automatischen Löschen aufbewahrt.

listOperationStatuses: (options?: DeviceManagementListOperationStatusesOptionalParams) => PagedAsyncIterableIterator<DeviceOperation, DeviceOperation[], PageSettings>

Eigenschaftswert

(options?: DeviceManagementListOperationStatusesOptionalParams) => PagedAsyncIterableIterator<DeviceOperation, DeviceOperation[], PageSettings>

retryDeployment

Es wird eine Bereitstellung mit fehlgeschlagenen Geräten erneut ausgeführt.

retryDeployment: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementRetryDeploymentOptionalParams) => Promise<Deployment>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementRetryDeploymentOptionalParams) => Promise<Deployment>

startLogCollection

Starten Sie die Gerätediagnoseprotokollauflistung auf angegebenen Geräten.

startLogCollection: (logCollectionId: string, logCollection: LogCollection, options?: DeviceManagementStartLogCollectionOptionalParams) => Promise<LogCollection>

Eigenschaftswert

(logCollectionId: string, logCollection: LogCollection, options?: DeviceManagementStartLogCollectionOptionalParams) => Promise<LogCollection>

stopDeployment

Beendet eine Bereitstellung.

stopDeployment: (groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementStopDeploymentOptionalParams) => Promise<Deployment>

Eigenschaftswert

(groupId: string, deviceClassId: string, deploymentId: string, options?: DeviceManagementStopDeploymentOptionalParams) => Promise<Deployment>

updateDeviceClass

Aktualisieren von Geräteklassendetails.

updateDeviceClass: (deviceClassId: string, deviceClassPatch: PatchBody, options?: DeviceManagementUpdateDeviceClassOptionalParams) => Promise<DeviceClass>

Eigenschaftswert

(deviceClassId: string, deviceClassPatch: PatchBody, options?: DeviceManagementUpdateDeviceClassOptionalParams) => Promise<DeviceClass>