DeviceManagementOperations interface

套件:

@azure/iot-device-update

介面代表裝置管理操作。

屬性

createOrUpdateDeployment	建立或更新部署。
deleteDeployment	刪除部署。
deleteDeploymentForDeviceClassSubgroup	刪除裝置類別子群組部署。
deleteDeviceClass	刪除裝置類別。 當啟用裝置更新的裝置連線到中樞，但不會自動清除裝置類別，因為 DeviceClassSubgroups 會參考它們。 如果使用者已刪除裝置類別的所有 DeviceClassSubgroup，他們也可以刪除裝置類別，以從系統移除記錄，並停止檢查此裝置類別與新更新的相容性。 如果裝置曾經針對此裝置類別重新連線，將會重新建立。
deleteDeviceClassSubgroup	刪除裝置類別子群組。 當啟用裝置更新的裝置連線到中樞並報告其屬性時，系統會自動建立此子群組。 群組、子群組和部署不會自動清除，但會保留供歷程記錄之用。 如果使用者不需要保留子群組的任何歷程記錄，且不再需要它，使用者可以呼叫此方法來刪除子群組。 如果在刪除子群組之後，此子群組再次連線裝置，系統就會自動重新建立，但不會有任何歷程記錄。
deleteGroup	刪除裝置群組。 當啟用裝置更新的裝置連線到中樞並報告其屬性時，會自動建立此群組。 群組、子群組和部署不會自動清除，但會保留供歷程記錄之用。 如果使用者不需要保留群組的任何歷程記錄，且不再需要群組，則可以呼叫此方法來刪除群組。 如果裝置在刪除群組之後再次連線到此群組，系統就會自動重新建立，但不會有任何歷程記錄。
getBestUpdatesForDeviceClassSubgroup	取得裝置類別子群組的最佳可用更新，以及需要此更新之裝置數目的計數。
getDeployment	取得部署屬性。
getDeploymentForDeviceClassSubgroup	取得部署屬性。
getDeploymentStatus	取得部署的狀態，包括部署中有多少裝置正在進行、完成或失敗的細目。
getDevice	取得連線至IoT中樞裝置更新之裝置的裝置屬性和最新部署狀態。
getDeviceClass	取得裝置類別的屬性。
getDeviceClassSubgroup	取得裝置類別子群組詳細數據。 裝置類別子群組是共用相同裝置類別之群組內的一組裝置。 相同裝置類別中的所有裝置都與相同的更新相容。
getDeviceClassSubgroupDeploymentStatus	取得部署的狀態，包括部署中有多少裝置正在進行、完成或失敗的細目。
getDeviceClassSubgroupUpdateCompliance	取得裝置類別子群組更新合規性資訊，例如有多少裝置在其最新更新、需要多少新更新，以及接收新更新時有多少個正在進行中。
getDeviceModule	取得連線至IoT中樞裝置更新之裝置模組的裝置模組屬性和最新部署狀態。
getGroup	取得裝置群組屬性。
getLogCollection	取得裝置診斷記錄收集
getLogCollectionDetailedStatus	取得具有詳細狀態的記錄收集
getOperationStatus	擷取作業狀態。
getUpdateCompliance	取得最新更新中有多少裝置、有可用的新更新，或正在進行接收新更新的明細。
getUpdateComplianceForGroup	取得裝置群組更新合規性資訊，例如有多少裝置在其最新更新、需要多少新更新，以及接收新更新時有多少個正在進行中。
importDevices	從 IoT 中樞匯入現有的裝置。 這是長時間執行的作業;使用 Operation-Location 回應標頭值來檢查作業狀態。
listBestUpdatesForGroup	取得裝置群組的最佳可用更新，以及每個更新需要多少個裝置計數。
listDeploymentsForDeviceClassSubgroup	取得裝置類別子群組的部署清單。
listDeploymentsForGroup	取得裝置群組的部署清單。
listDeviceClasses	針對連線到IoT中樞裝置更新的所有裝置，取得所有裝置類別的清單（根據IoT中樞的裝置更新 PnP 介面中所報告的型號標識碼和相容性屬性，相容於相同更新的裝置集合）。
listDeviceClassSubgroupsForGroup	取得群組的裝置類別子群組。 裝置類別子群組是共用相同裝置類別之群組內的一組裝置。 相同裝置類別中的所有裝置都與相同的更新相容。
listDevices	取得連線到IoT中樞裝置更新的裝置清單。
listDeviceStatesForDeviceClassSubgroupDeployment	取得部署中的裝置清單及其狀態。 適用於取得失敗的裝置清單。
listGroups	取得所有裝置群組的清單。 $default群組一律會先傳回。
listHealthOfDevices	取得裝置健康情況清單
listInstallableUpdatesForDeviceClass	取得裝置類別的可安裝更新清單。
listLogCollections	取得所有裝置診斷記錄集合
listOperationStatuses	取得所有裝置匯入作業的清單。 自動刪除之前，已完成的作業會保留7天。
retryDeployment	重試具有失敗裝置的部署。
startLogCollection	在指定的裝置上啟動裝置診斷記錄收集。
stopDeployment	停止部署。
updateDeviceClass	更新裝置類別詳細數據。

屬性詳細資料

createOrUpdateDeployment

建立或更新部署。

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

屬性值

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

deleteDeployment

刪除部署。

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

屬性值

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

deleteDeploymentForDeviceClassSubgroup

刪除裝置類別子群組部署。

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

屬性值

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

deleteDeviceClass

刪除裝置類別。 當啟用裝置更新的裝置連線到中樞，但不會自動清除裝置類別，因為 DeviceClassSubgroups 會參考它們。 如果使用者已刪除裝置類別的所有 DeviceClassSubgroup，他們也可以刪除裝置類別，以從系統移除記錄，並停止檢查此裝置類別與新更新的相容性。 如果裝置曾經針對此裝置類別重新連線，將會重新建立。

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

屬性值

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

deleteDeviceClassSubgroup

刪除裝置類別子群組。 當啟用裝置更新的裝置連線到中樞並報告其屬性時，系統會自動建立此子群組。 群組、子群組和部署不會自動清除，但會保留供歷程記錄之用。 如果使用者不需要保留子群組的任何歷程記錄，且不再需要它，使用者可以呼叫此方法來刪除子群組。 如果在刪除子群組之後，此子群組再次連線裝置，系統就會自動重新建立，但不會有任何歷程記錄。

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

屬性值

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

deleteGroup

刪除裝置群組。 當啟用裝置更新的裝置連線到中樞並報告其屬性時，會自動建立此群組。 群組、子群組和部署不會自動清除，但會保留供歷程記錄之用。 如果使用者不需要保留群組的任何歷程記錄，且不再需要群組，則可以呼叫此方法來刪除群組。 如果裝置在刪除群組之後再次連線到此群組，系統就會自動重新建立，但不會有任何歷程記錄。

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

屬性值

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

getBestUpdatesForDeviceClassSubgroup

取得裝置類別子群組的最佳可用更新，以及需要此更新之裝置數目的計數。

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

屬性值

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

getDeployment

取得部署屬性。

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

屬性值

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

getDeploymentForDeviceClassSubgroup

取得部署屬性。

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

屬性值

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

getDeploymentStatus

取得部署的狀態，包括部署中有多少裝置正在進行、完成或失敗的細目。

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

屬性值

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

getDevice

取得連線至IoT中樞裝置更新之裝置的裝置屬性和最新部署狀態。

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

屬性值

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

getDeviceClass

取得裝置類別的屬性。

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

屬性值

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

getDeviceClassSubgroup

取得裝置類別子群組詳細數據。 裝置類別子群組是共用相同裝置類別之群組內的一組裝置。 相同裝置類別中的所有裝置都與相同的更新相容。

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

屬性值

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

getDeviceClassSubgroupDeploymentStatus

取得部署的狀態，包括部署中有多少裝置正在進行、完成或失敗的細目。

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

屬性值

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

getDeviceClassSubgroupUpdateCompliance

取得裝置類別子群組更新合規性資訊，例如有多少裝置在其最新更新、需要多少新更新，以及接收新更新時有多少個正在進行中。

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

屬性值

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

getDeviceModule

取得連線至IoT中樞裝置更新之裝置模組的裝置模組屬性和最新部署狀態。

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

屬性值

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

getGroup

取得裝置群組屬性。

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

屬性值

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

getLogCollection

取得裝置診斷記錄收集

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

屬性值

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

getLogCollectionDetailedStatus

取得具有詳細狀態的記錄收集

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

屬性值

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

getOperationStatus

擷取作業狀態。

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

屬性值

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

getUpdateCompliance

取得最新更新中有多少裝置、有可用的新更新，或正在進行接收新更新的明細。

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

屬性值

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

getUpdateComplianceForGroup

取得裝置群組更新合規性資訊，例如有多少裝置在其最新更新、需要多少新更新，以及接收新更新時有多少個正在進行中。

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

屬性值

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

importDevices

從 IoT 中樞匯入現有的裝置。 這是長時間執行的作業;使用 Operation-Location 回應標頭值來檢查作業狀態。

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

屬性值

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

listBestUpdatesForGroup

取得裝置群組的最佳可用更新，以及每個更新需要多少個裝置計數。

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

屬性值

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

listDeploymentsForDeviceClassSubgroup

取得裝置類別子群組的部署清單。

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

屬性值

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

listDeploymentsForGroup

取得裝置群組的部署清單。

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

屬性值

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

listDeviceClasses

針對連線到IoT中樞裝置更新的所有裝置，取得所有裝置類別的清單（根據IoT中樞的裝置更新 PnP 介面中所報告的型號標識碼和相容性屬性，相容於相同更新的裝置集合）。

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

屬性值

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

listDeviceClassSubgroupsForGroup

取得群組的裝置類別子群組。 裝置類別子群組是共用相同裝置類別之群組內的一組裝置。 相同裝置類別中的所有裝置都與相同的更新相容。

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

屬性值

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

listDevices

取得連線到IoT中樞裝置更新的裝置清單。

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

屬性值

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

listDeviceStatesForDeviceClassSubgroupDeployment

取得部署中的裝置清單及其狀態。 適用於取得失敗的裝置清單。

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

屬性值

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

listGroups

取得所有裝置群組的清單。 $default群組一律會先傳回。

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

屬性值

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

listHealthOfDevices

取得裝置健康情況清單

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

屬性值

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

listInstallableUpdatesForDeviceClass

取得裝置類別的可安裝更新清單。

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

屬性值

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

listLogCollections

取得所有裝置診斷記錄集合

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

屬性值

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

listOperationStatuses

取得所有裝置匯入作業的清單。 自動刪除之前，已完成的作業會保留7天。

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

屬性值

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

retryDeployment

重試具有失敗裝置的部署。

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

屬性值

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

startLogCollection

在指定的裝置上啟動裝置診斷記錄收集。

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

屬性值

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

stopDeployment

停止部署。

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

屬性值

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

updateDeviceClass

更新裝置類別詳細數據。

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

屬性值

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