@azure/iot-device-update package

類別

DeviceUpdateClient

介面

CloudInitiatedRollbackPolicy	部署的復原原則
CloudInitiatedRollbackPolicyFailure	起始回復原則的失敗狀況
Compatibility	代表更新相容性資訊的鍵值對。
ContractModel	裝置更新代理程式合約模型。
Deployment	部署元數據。
DeploymentDeviceState	部署裝置狀態。
DeploymentStatus	部署狀態元數據。
Device	裝置元數據。
DeviceClass	裝置類別元數據。
DeviceClassProperties	用來計算裝置類別識別碼的裝置類別屬性
DeviceClassSubgroup	裝置類別子群組詳細數據。 裝置類別子群組是群組中共用相同裝置類別標識碼的裝置子集。
DeviceClassSubgroupDeploymentStatus	裝置類別子群組部署狀態元數據。
DeviceClassSubgroupUpdatableDevices	裝置類別子群組、更新資訊，以及適用更新的裝置數目。
DeviceHealth	裝置健康情況
DeviceManagementCreateOrUpdateDeploymentOptionalParams	選擇性參數。
DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementDeleteDeploymentOptionalParams	選擇性參數。
DeviceManagementDeleteDeviceClassOptionalParams	選擇性參數。
DeviceManagementDeleteDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementDeleteGroupOptionalParams	選擇性參數。
DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementGetDeploymentOptionalParams	選擇性參數。
DeviceManagementGetDeploymentStatusOptionalParams	選擇性參數。
DeviceManagementGetDeviceClassOptionalParams	選擇性參數。
DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams	選擇性參數。
DeviceManagementGetDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams	選擇性參數。
DeviceManagementGetDeviceModuleOptionalParams	選擇性參數。
DeviceManagementGetDeviceOptionalParams	選擇性參數。
DeviceManagementGetGroupOptionalParams	選擇性參數。
DeviceManagementGetLogCollectionDetailedStatusOptionalParams	選擇性參數。
DeviceManagementGetLogCollectionOptionalParams	選擇性參數。
DeviceManagementGetOperationStatusOptionalParams	選擇性參數。
DeviceManagementGetUpdateComplianceForGroupOptionalParams	選擇性參數。
DeviceManagementGetUpdateComplianceOptionalParams	選擇性參數。
DeviceManagementImportDevicesOptionalParams	選擇性參數。
DeviceManagementListBestUpdatesForGroupOptionalParams	選擇性參數。
DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams	選擇性參數。
DeviceManagementListDeploymentsForGroupOptionalParams	選擇性參數。
DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams	選擇性參數。
DeviceManagementListDeviceClassesOptionalParams	選擇性參數。
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams	選擇性參數。
DeviceManagementListDevicesOptionalParams	選擇性參數。
DeviceManagementListGroupsOptionalParams	選擇性參數。
DeviceManagementListHealthOfDevicesOptionalParams	選擇性參數。
DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams	選擇性參數。
DeviceManagementListLogCollectionsOptionalParams	選擇性參數。
DeviceManagementListOperationStatusesOptionalParams	選擇性參數。
DeviceManagementOperations	介面代表裝置管理操作。
DeviceManagementRetryDeploymentOptionalParams	選擇性參數。
DeviceManagementStartLogCollectionOptionalParams	選擇性參數。
DeviceManagementStopDeploymentOptionalParams	選擇性參數。
DeviceManagementUpdateDeviceClassOptionalParams	選擇性參數。
DeviceOperation	作業元數據。
DeviceUpdateAgentId	裝置更新代理程式識別碼
DeviceUpdateClientOptionalParams	用戶端的選擇性參數。
DeviceUpdateDeleteUpdateOptionalParams	選擇性參數。
DeviceUpdateGetFileOptionalParams	選擇性參數。
DeviceUpdateGetOperationStatusOptionalParams	選擇性參數。
DeviceUpdateGetUpdateOptionalParams	選擇性參數。
DeviceUpdateImportUpdateOptionalParams	選擇性參數。
DeviceUpdateListFilesOptionalParams	選擇性參數。
DeviceUpdateListNamesOptionalParams	選擇性參數。
DeviceUpdateListOperationStatusesOptionalParams	選擇性參數。
DeviceUpdateListProvidersOptionalParams	選擇性參數。
DeviceUpdateListUpdatesOptionalParams	選擇性參數。
DeviceUpdateListVersionsOptionalParams	選擇性參數。
DeviceUpdateOperations	介面代表 DeviceUpdate 操作。
ErrorModel	錯誤詳細數據。
ErrorResponse	常見的錯誤回應。
FileImportMetadata	描述更新檔案的元數據。
Group	群組詳細數據。
HealthCheck	健康檢查
ImportManifestMetadata	描述匯入指令清單的元數據，此檔描述有關更新版本的檔案和其他元數據。
ImportUpdateInputItem	匯入更新輸入項目元數據。
InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
InstallResult	更新的安裝結果及其下的任何步驟結果。
Instructions	更新安裝說明容器。
LogCollection	診斷要求本文
LogCollectionOperationDetailedStatus	裝置診斷作業詳細狀態
LogCollectionOperationDeviceStatus	診斷作業裝置狀態
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PatchBody	裝置類別 JSON 合併修補要求本文
RestorePollerOptions
Step	更新安裝指示步驟。
StepResult	更新下的步驟結果。
Update	更新元數據。
UpdateCompliance	更新合規性資訊。
UpdateFile	更新檔案元數據。
UpdateFileBase	更新檔案基本元數據。
UpdateFileDownloadHandler	使用相關檔案來下載承載檔案的下載處理程式。
UpdateId	更新標識碼。
UpdateInfo	更新資訊。
UpdateOperation	作業元數據。

類型別名

ContinuablePage	描述結果頁面的介面。
DeploymentState	部署狀態。
DeviceClassSubgroupDeploymentState	裝置類別子群組部署狀態。
DeviceDeploymentState	部署狀態。
DeviceHealthState	裝置健康情況狀態
DownloadSecurity	裝置下載更新有效載荷時應該使用的協定。
GroupType	支援的群組類型。
HealthCheckResult	健康情況檢查結果
ImportType	裝置匯入類型。
OperationStatus	作業狀態。
StepType	步驟類型。

列舉

KnownVersions

可用的 API 版本。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e is RestError

參數

e

unknown

catch 子句攔截到的東西。

傳回

e is RestError

restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client

DeviceUpdateClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor