@azure/iot-device-update package
Klassen
| DeviceUpdateClient |
Schnittstellen
| CloudInitiatedRollbackPolicy |
Rollbackrichtlinie für die Bereitstellung |
| CloudInitiatedRollbackPolicyFailure |
Fehlerbedingungen zum Initiieren der Rollbackrichtlinie |
| Compatibility |
Schlüssel-Wert-Paare repräsentieren Aktualisierungskompatibilitätsinformationen. |
| ContractModel |
Das Vertragsmodell des Geräteupdate-Agents. |
| Deployment |
Bereitstellungsmetadaten. |
| DeploymentDeviceState |
Status des Bereitstellungsgeräts. |
| DeploymentStatus |
Metadaten für den Bereitstellungsstatus. |
| Device |
Gerätemetadaten. |
| DeviceClass |
Geräteklassenmetadaten. |
| DeviceClassProperties |
Die Geräteklasseneigenschaften, die zum Berechnen der Geräteklassen-ID verwendet werden |
| DeviceClassSubgroup |
Details zur Untergruppe der Geräteklasse. Eine Geräteklassenuntergruppe ist eine Teilmenge von Geräten in einer Gruppe, die dieselbe Geräteklassen-ID gemeinsam verwenden. |
| DeviceClassSubgroupDeploymentStatus |
Geräteklassen-Untergruppen-Bereitstellungsstatusmetadaten. |
| DeviceClassSubgroupUpdatableDevices |
Geräteklassenuntergruppe, Updateinformationen und die Anzahl der Geräte, für die das Update anwendbar ist. |
| DeviceHealth |
Gerätezustand |
| DeviceManagementCreateOrUpdateDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementDeleteDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementDeleteDeviceClassOptionalParams |
Optionale Parameter. |
| DeviceManagementDeleteDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementDeleteGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeploymentStatusOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceClassOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceModuleOptionalParams |
Optionale Parameter. |
| DeviceManagementGetDeviceOptionalParams |
Optionale Parameter. |
| DeviceManagementGetGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetLogCollectionDetailedStatusOptionalParams |
Optionale Parameter. |
| DeviceManagementGetLogCollectionOptionalParams |
Optionale Parameter. |
| DeviceManagementGetOperationStatusOptionalParams |
Optionale Parameter. |
| DeviceManagementGetUpdateComplianceForGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementGetUpdateComplianceOptionalParams |
Optionale Parameter. |
| DeviceManagementImportDevicesOptionalParams |
Optionale Parameter. |
| DeviceManagementListBestUpdatesForGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams |
Optionale Parameter. |
| DeviceManagementListDeploymentsForGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams |
Optionale Parameter. |
| DeviceManagementListDeviceClassesOptionalParams |
Optionale Parameter. |
| DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementListDevicesOptionalParams |
Optionale Parameter. |
| DeviceManagementListGroupsOptionalParams |
Optionale Parameter. |
| DeviceManagementListHealthOfDevicesOptionalParams |
Optionale Parameter. |
| DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams |
Optionale Parameter. |
| DeviceManagementListLogCollectionsOptionalParams |
Optionale Parameter. |
| DeviceManagementListOperationStatusesOptionalParams |
Optionale Parameter. |
| DeviceManagementOperations |
Schnittstelle, die eine DeviceManagement-Operation darstellt. |
| DeviceManagementRetryDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementStartLogCollectionOptionalParams |
Optionale Parameter. |
| DeviceManagementStopDeploymentOptionalParams |
Optionale Parameter. |
| DeviceManagementUpdateDeviceClassOptionalParams |
Optionale Parameter. |
| DeviceOperation |
Vorgangsmetadaten. |
| DeviceUpdateAgentId |
Geräteupdate-Agent-ID |
| DeviceUpdateClientOptionalParams |
Optionale Parameter für den Client. |
| DeviceUpdateDeleteUpdateOptionalParams |
Optionale Parameter. |
| DeviceUpdateGetFileOptionalParams |
Optionale Parameter. |
| DeviceUpdateGetOperationStatusOptionalParams |
Optionale Parameter. |
| DeviceUpdateGetUpdateOptionalParams |
Optionale Parameter. |
| DeviceUpdateImportUpdateOptionalParams |
Optionale Parameter. |
| DeviceUpdateListFilesOptionalParams |
Optionale Parameter. |
| DeviceUpdateListNamesOptionalParams |
Optionale Parameter. |
| DeviceUpdateListOperationStatusesOptionalParams |
Optionale Parameter. |
| DeviceUpdateListProvidersOptionalParams |
Optionale Parameter. |
| DeviceUpdateListUpdatesOptionalParams |
Optionale Parameter. |
| DeviceUpdateListVersionsOptionalParams |
Optionale Parameter. |
| DeviceUpdateOperations |
Schnittstelle, die eine DeviceUpdate-Operation darstellt. |
| ErrorModel |
Fehlerdetails. |
| ErrorResponse |
Häufige Fehlerantwort. |
| FileImportMetadata |
Metadaten, die eine Aktualisierungsdatei beschreiben. |
| Group |
Gruppendetails. |
| HealthCheck |
Gesundheitscheck |
| ImportManifestMetadata |
Metadaten, die das Importmanifest beschreiben, ein Dokument, das die Dateien und andere Metadaten zu einer Updateversion beschreibt. |
| ImportUpdateInputItem |
Importieren von Aktualisierungseingabeelementmetadaten. |
| InnerError |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
| InstallResult |
Das Installationsergebnis eines Updates und alle darin enthaltenen Schrittergebnisse. |
| Instructions |
Update der Installationsanweisungen-Container. |
| LogCollection |
Diagnoseanforderungstext |
| LogCollectionOperationDetailedStatus |
Detaillierter Status des Gerätediagnosevorgangs |
| LogCollectionOperationDeviceStatus |
Diagnosevorgangsgerätestatus |
| PageSettings |
Optionen für die byPage-Methode |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| PatchBody |
Anforderungstext der Geräteklasse JSON Zusammenführen von Patchanforderungen |
| RestorePollerOptions | |
| Step |
Schritt der Installationsanweisung aktualisieren. |
| StepResult |
Das Schrittergebnis unter einer Aktualisierung. |
| Update |
Aktualisieren von Metadaten. |
| UpdateCompliance |
Aktualisieren von Complianceinformationen. |
| UpdateFile |
Aktualisieren von Dateimetadaten. |
| UpdateFileBase |
Aktualisieren sie grundlegende Metadaten für Dateien. |
| UpdateFileDownloadHandler |
Downloadhandler für die Verwendung verwandter Dateien zum Herunterladen der Nutzlastdatei. |
| UpdateId |
Updatebezeichner. |
| UpdateInfo |
Informationen zum Update. |
| UpdateOperation |
Vorgangsmetadaten. |
Typaliase
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
| DeploymentState |
Bereitstellungsstatus. |
| DeviceClassSubgroupDeploymentState |
Geräteklassen-Untergruppenbereitstellungsstatus. |
| DeviceDeploymentState |
Bereitstellungsstatus. |
| DeviceHealthState |
Geräteintegritätszustände |
| DownloadSecurity |
Das Protokoll, das das Gerät beim Herunterladen der Update-Payload verwenden sollte. |
| GroupType |
Unterstützte Gruppentypen. |
| HealthCheckResult |
Ergebnis der Integritätsprüfung |
| ImportType |
Der Importtyp des Geräts. |
| OperationStatus |
Vorgangsstatus. |
| StepType |
Schritttyp. |
Enumerationen
| KnownVersions |
Die verfügbaren API-Versionen. |
Functions
| is |
Typeguard für RestError |
| restore |
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt. |
Variablen
| Rest |
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen. |
Details zur Funktion
isRestError(unknown)
Typeguard für RestError
function isRestError(e: unknown): eParameter
- e
-
unknown
Etwas, das von einer Catch-Klausel abgefangen wird.
Gibt zurück
e
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.
function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parameter
- client
- DeviceUpdateClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Gibt zurück
PollerLike<OperationState<TResult>, TResult>
Details zu Variablen
RestError
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
RestError: RestErrorConstructor