@azure/iot-device-update package

パラメーター グループ

互換性情報を更新します。

デプロイ メタデータ。

展開デバイスの状態。

展開デバイス状態フィルター。

デプロイ フィルター。

デプロイの状態メタデータ。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

デバイス メタデータ。

デバイス クラスのメタデータ。

操作ステータス フィルター。

デバイス タグのプロパティ。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

エラーの詳細。

ファイル メタデータを更新します。

更新ファイルを記述するメタデータ。

グループの詳細。

最適な更新フィルターをグループ化します。

インポート マニフェストを記述するメタデータ。更新バージョンに関するファイルとその他のメタデータを記述するドキュメント。

更新プログラムの入力メタデータをインポートします。

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

操作メタデータ。

操作ステータス フィルター。

展開デバイスの状態の一覧。

デプロイの一覧。

デバイス クラスの一覧。

デバイス タグの一覧。

デバイスの一覧。

グループの一覧。

サーバー ページングがサポートされている操作の一覧。

サーバー ページングがサポートされている文字列の一覧。

更新可能なデバイスの一覧。

更新 ID の一覧。

更新プログラムの識別子と、更新プログラムが適用されるデバイスの数。

メタデータを更新します。

コンプライアンス情報を更新します。

識別子を更新します。

Updates_deleteUpdate操作のヘッダーを定義します。

省略可能なパラメーター。

Updates_getOperation操作のヘッダーを定義します。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

Updates_importUpdate操作のヘッダーを定義します。

DeploymentState の値を定義します。
KnownDeploymentState DeploymentState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

アクティブ: 展開は、展開の対象となるデバイスに送信できます。
置き換え済み: 同じターゲット設定を持つ新しい展開が存在し、この展開を受信するデバイスはありません。
キャンセル済み: デプロイメントはキャンセルされ、どのデバイスも受信しません。

DeploymentType の値を定義します。
KnownDeploymentType は DeploymentType と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

完了: ダウンロード、インストール、および適用アクションを含む完全なデプロイメント。
ダウンロード: インストールまたは適用アクションを含まないダウンロードのみのデプロイメント。 現在サポートされていません。
インストール: ダウンロード アクションを含まず、インストールと完了のみを含むインストールのみのロールアウト。 現在サポートされていません。

cancelDeployment 操作の応答データが含まれます。

createOrUpdateDeployment 操作の応答データが含まれます。

getAllDeploymentsNext 操作の応答データが含まれます。

getAllDeployments 操作の応答データが含まれます。

getDeploymentDevicesNext 操作の応答データが含まれます。

getDeploymentDevices 操作の応答データが含まれます。

getDeployment 操作の応答データが含まれています。

getDeploymentStatus 操作の応答データが含まれます。

retryDeployment 操作の応答データが含まれます。

DeviceDeploymentState の値を定義します。
KnownDeviceDeploymentState は DeviceDeploymentState と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

成功: デプロイが正常に完了しました。
InProgress: デプロイが進行中です。
失敗: デプロイは失敗で完了しました。
キャンセル済み: デプロイメントがキャンセルされました。
互換性なし: 展開はデバイスと互換性がありません。

DeviceGroupType の値を定義します。
KnownDeviceGroupType は DeviceGroupType と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

すべて: 展開は、デバイス クラス内のすべてのデバイスに送信する必要があります。
デバイス: 展開は、デバイス グループ定義内のデバイスの一覧に送信する必要があります。
DeviceGroupDefinitions: デプロイは、すべてのデバイス グループ定義クエリの共用体によって返されるデバイスの一覧に送信する必要があります。

DeviceState の値を定義します。
KnownDeviceState は DeviceState と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

NotStarted: 未開始 (または初期化されていない)
互換性なし: 展開は、このデバイスと互換性がありません。
AlreadyInDeployment: このデバイスに対して別の展開が進行中です。
キャンセル済み: このデバイスの展開はキャンセルされました。
進行中: 展開が進行中です。
失敗: デプロイに失敗しました。
成功: デプロイは正常に完了しました。

createOrUpdateGroup 操作の応答データが含まれます。

getAllDeviceClassesNext 操作の応答データが含まれます。

getAllDeviceClasses 操作の応答データが含まれます。

getAllDeviceTagsNext 操作の応答データが含まれます。

getAllDeviceTags 操作の応答データが含まれます。

getAllDevicesNext 操作の応答データが含まれます。

getAllDevices 操作の応答データが含まれます。

getAllGroupsNext 操作の応答データが含まれます。

getAllGroups 操作の応答データが含まれます。

getDeviceClassDeviceIdsNext 操作の応答データが含まれます。

getDeviceClassDeviceIds 操作の応答データが含まれます。

getDeviceClassInstallableUpdatesNext 操作のレスポンス・データが含まれます。

getDeviceClassInstallableUpdates 操作の応答データが含まれます。

getDeviceClass 操作の応答データが含まれます。

getDevice 操作の応答データが含まれます。

getDeviceTag 操作の応答データが含まれます。

getGroupBestUpdatesNext操作のレスポンス・データが含まれます。

getGroupBestUpdates操作のレスポンス・データが含まれます。

getGroup 操作の応答データが含まれます。

getGroupUpdateCompliance 操作の応答データが含まれます。

getUpdateCompliance 操作の応答データが含まれます。

GroupType の値を定義します。
KnownGroupType は GroupType と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれます。

サービスでサポートされている値を把握する

IoTHubTag: IoT Hub タグベースのグループ。

OperationFilterStatus の値を定義します。
KnownOperationFilterStatus は OperationFilterStatus と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

実行中の
NotStarted

OperationStatus の値を定義します。
KnownOperationStatus OperationStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている値を把握する

未定義: 未定義の操作ステータス。
NotStarted: バックグラウンド操作が作成されましたが、まだ開始されていません。
実行中: バックグラウンド操作が現在実行中です。
成功: バックグラウンド操作は成功して終了しました。
失敗: バックグラウンド操作が失敗で終了しました。

deleteUpdate 操作の応答データが含まれます。

getFile 操作の応答データが含まれます。

getFilesNext 操作の応答データが含まれます。

getFiles 操作の応答データが含まれます。

getNamesNext 操作の応答データが含まれます。

getNames 操作の応答データが含まれます。

getOperation 操作の応答データが含まれます。

getOperationsNext 操作の応答データが含まれます。

getOperations 操作の応答データが含まれます。

getProvidersNext操作のレスポンス・データが含まれます。

getProviders 操作の応答データが含まれます。

getUpdate 操作の応答データが含まれます。

getVersionsNext 操作の応答データが含まれます。

getVersions 操作の応答データが含まれます。

importUpdate 操作の応答データが含まれます。

サービス 受け入れる DeploymentState の既知の値。

サービスが受け入れる DeploymentType の既知の値。

サービスが受け入れる DeviceDeploymentState の既知の値。

サービスが受け入れる DeviceGroupType の既知の値。

サービスが受け入れる DeviceState の既知の値。

サービスが受け入れる GroupType の既知の値。

サービスが受け入れる OperationFilterStatus の既知の値。

OperationStatus の既知の値は、サービスが受け入れる。