@azure/iot-device-update package

クラス

DeviceUpdateClient
DeviceUpdateClientContext

インターフェイス

AccessCondition

パラメーター グループ

Compatibility

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

Deployment

デプロイ メタデータ。

DeploymentDeviceState

展開デバイスの状態。

DeploymentDeviceStatesFilter

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

DeploymentFilter

デプロイ フィルター。

DeploymentStatus

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

DeploymentsGetAllDeploymentsNextOptionalParams

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

DeploymentsGetAllDeploymentsOptionalParams

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

DeploymentsGetDeploymentDevicesNextOptionalParams

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

DeploymentsGetDeploymentDevicesOptionalParams

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

Device

デバイス メタデータ。

DeviceClass

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

DeviceFilter

操作状態フィルター。

DeviceTag

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

DeviceUpdateClientOptionalParams

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

DevicesGetAllDevicesNextOptionalParams

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

DevicesGetAllDevicesOptionalParams

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

DevicesGetGroupBestUpdatesNextOptionalParams

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

DevicesGetGroupBestUpdatesOptionalParams

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

ErrorModel

エラーの詳細。

File

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

FileImportMetadata

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

Group

グループの詳細。

GroupBestUpdatesFilter

グループの最適な更新フィルター。

ImportManifestMetadata

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

ImportUpdateInput

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

InnerError

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

Operation

操作メタデータ。

OperationFilter

操作状態フィルター。

PageableListOfDeploymentDeviceStates

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

PageableListOfDeployments

デプロイの一覧。

PageableListOfDeviceClasses

デバイス クラスの一覧。

PageableListOfDeviceTags

デバイス タグの一覧。

PageableListOfDevices

デバイスの一覧。

PageableListOfGroups

グループの一覧。

PageableListOfOperations

サーバーページングをサポートする操作の一覧。

PageableListOfStrings

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

PageableListOfUpdatableDevices

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

PageableListOfUpdateIds

更新 ID の一覧。

UpdatableDevices

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

Update

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

UpdateCompliance

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

UpdateId

識別子を更新します。

UpdatesDeleteUpdateHeaders

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

UpdatesGetFileOptionalParams

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

UpdatesGetOperationHeaders

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

UpdatesGetOperationOptionalParams

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

UpdatesGetOperationsNextOptionalParams

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

UpdatesGetOperationsOptionalParams

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

UpdatesGetUpdateOptionalParams

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

UpdatesImportUpdateHeaders

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

型エイリアス

DeploymentState

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

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

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

DeploymentType

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

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

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

DeploymentsCancelDeploymentResponse

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

DeploymentsCreateOrUpdateDeploymentResponse

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

DeploymentsGetAllDeploymentsNextResponse

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

DeploymentsGetAllDeploymentsResponse

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

DeploymentsGetDeploymentDevicesNextResponse

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

DeploymentsGetDeploymentDevicesResponse

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

DeploymentsGetDeploymentResponse

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

DeploymentsGetDeploymentStatusResponse

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

DeploymentsRetryDeploymentResponse

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

DeviceDeploymentState

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

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

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

DeviceGroupType

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

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

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

DeviceState

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

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

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

DevicesCreateOrUpdateGroupResponse

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

DevicesGetAllDeviceClassesNextResponse

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

DevicesGetAllDeviceClassesResponse

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

DevicesGetAllDeviceTagsNextResponse

getAllDeviceTagsNext 操作の応答データを格納します。

DevicesGetAllDeviceTagsResponse

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

DevicesGetAllDevicesNextResponse

getAllDevicesNext 操作の応答データを格納します。

DevicesGetAllDevicesResponse

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

DevicesGetAllGroupsNextResponse

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

DevicesGetAllGroupsResponse

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

DevicesGetDeviceClassDeviceIdsNextResponse

getDeviceClassDeviceIdsNext 操作の応答データを格納します。

DevicesGetDeviceClassDeviceIdsResponse

getDeviceClassDeviceIds 操作の応答データを格納します。

DevicesGetDeviceClassInstallableUpdatesNextResponse

getDeviceClassInstallableUpdatesNext 操作の応答データを格納します。

DevicesGetDeviceClassInstallableUpdatesResponse

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

DevicesGetDeviceClassResponse

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

DevicesGetDeviceResponse

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

DevicesGetDeviceTagResponse

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

DevicesGetGroupBestUpdatesNextResponse

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

DevicesGetGroupBestUpdatesResponse

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

DevicesGetGroupResponse

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

DevicesGetGroupUpdateComplianceResponse

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

DevicesGetUpdateComplianceResponse

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

GroupType

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

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

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

OperationFilterStatus

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

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

実行中
NotStarted

OperationStatus

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

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

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

UpdatesDeleteUpdateResponse

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

UpdatesGetFileResponse

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

UpdatesGetFilesNextResponse

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

UpdatesGetFilesResponse

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

UpdatesGetNamesNextResponse

getNamesNext 操作の応答データを格納します。

UpdatesGetNamesResponse

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

UpdatesGetOperationResponse

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

UpdatesGetOperationsNextResponse

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

UpdatesGetOperationsResponse

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

UpdatesGetProvidersNextResponse

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

UpdatesGetProvidersResponse

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

UpdatesGetUpdateResponse

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

UpdatesGetVersionsNextResponse

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

UpdatesGetVersionsResponse

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

UpdatesImportUpdateResponse

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

列挙型

KnownDeploymentState

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

KnownDeploymentType

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

KnownDeviceDeploymentState

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

KnownDeviceGroupType

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

KnownDeviceState

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

KnownGroupType

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

KnownOperationFilterStatus

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

KnownOperationStatus

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