@azure/iot-device-update package

クラス

DeviceUpdateClient

インターフェイス

CloudInitiatedRollbackPolicy	デプロイのロールバック ポリシー
CloudInitiatedRollbackPolicyFailure	ロールバック ポリシーを開始するための失敗条件
Compatibility	キー・バリューペアは更新互換性情報を表す。
ContractModel	Device Update エージェント コントラクト モデル。
Deployment	デプロイ メタデータ。
DeploymentDeviceState	展開デバイスの状態。
DeploymentStatus	デプロイの状態メタデータ。
Device	デバイス メタデータ。
DeviceClass	デバイス クラスのメタデータ。
DeviceClassProperties	デバイス クラス ID の計算に使用されるデバイス クラスのプロパティ
DeviceClassSubgroup	デバイス クラスサブグループの詳細。 デバイス クラス サブグループは、同じデバイス クラス ID を共有するグループ内のデバイスのサブセットです。
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	Device Update エージェント ID
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

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e

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