@azure/iot-device-update package

Klassen

DeviceUpdateClient

Interfaces

CloudInitiatedRollbackPolicy	Beleid voor terugdraaien voor implementatie
CloudInitiatedRollbackPolicyFailure	Foutvoorwaarden voor het initiëren van beleid voor terugdraaien
Compatibility	Sleutelwaardeparen die update-compatibiliteitsinformatie weergeven.
ContractModel	Het contractmodel van de Device Update-agent.
Deployment	Metagegevens van de implementatie.
DeploymentDeviceState	Implementatieapparaatstatus.
DeploymentStatus	Metagegevens van de implementatiestatus.
Device	Metagegevens van het apparaat.
DeviceClass	Metagegevens van apparaatklasse.
DeviceClassProperties	De eigenschappen van de apparaatklasse die worden gebruikt om de apparaatklasse-id te berekenen
DeviceClassSubgroup	Details van subgroep van apparaatklasse. Een subgroep van apparaatklasse is een subset van apparaten in een groep die dezelfde apparaatklasse-id delen.
DeviceClassSubgroupDeploymentStatus	Metagegevens van subgroepimplementatiestatus van apparaatklasse.
DeviceClassSubgroupUpdatableDevices	Subgroep van apparaatklasse, updategegevens en het aantal apparaten waarvoor de update van toepassing is.
DeviceHealth	Apparaatconditie
DeviceManagementCreateOrUpdateDeploymentOptionalParams	Optionele parameters.
DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementDeleteDeploymentOptionalParams	Optionele parameters.
DeviceManagementDeleteDeviceClassOptionalParams	Optionele parameters.
DeviceManagementDeleteDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementDeleteGroupOptionalParams	Optionele parameters.
DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementGetDeploymentOptionalParams	Optionele parameters.
DeviceManagementGetDeploymentStatusOptionalParams	Optionele parameters.
DeviceManagementGetDeviceClassOptionalParams	Optionele parameters.
DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams	Optionele parameters.
DeviceManagementGetDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams	Optionele parameters.
DeviceManagementGetDeviceModuleOptionalParams	Optionele parameters.
DeviceManagementGetDeviceOptionalParams	Optionele parameters.
DeviceManagementGetGroupOptionalParams	Optionele parameters.
DeviceManagementGetLogCollectionDetailedStatusOptionalParams	Optionele parameters.
DeviceManagementGetLogCollectionOptionalParams	Optionele parameters.
DeviceManagementGetOperationStatusOptionalParams	Optionele parameters.
DeviceManagementGetUpdateComplianceForGroupOptionalParams	Optionele parameters.
DeviceManagementGetUpdateComplianceOptionalParams	Optionele parameters.
DeviceManagementImportDevicesOptionalParams	Optionele parameters.
DeviceManagementListBestUpdatesForGroupOptionalParams	Optionele parameters.
DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams	Optionele parameters.
DeviceManagementListDeploymentsForGroupOptionalParams	Optionele parameters.
DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams	Optionele parameters.
DeviceManagementListDeviceClassesOptionalParams	Optionele parameters.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams	Optionele parameters.
DeviceManagementListDevicesOptionalParams	Optionele parameters.
DeviceManagementListGroupsOptionalParams	Optionele parameters.
DeviceManagementListHealthOfDevicesOptionalParams	Optionele parameters.
DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams	Optionele parameters.
DeviceManagementListLogCollectionsOptionalParams	Optionele parameters.
DeviceManagementListOperationStatusesOptionalParams	Optionele parameters.
DeviceManagementOperations	Interface die een DeviceManagement-operatie vertegenwoordigt.
DeviceManagementRetryDeploymentOptionalParams	Optionele parameters.
DeviceManagementStartLogCollectionOptionalParams	Optionele parameters.
DeviceManagementStopDeploymentOptionalParams	Optionele parameters.
DeviceManagementUpdateDeviceClassOptionalParams	Optionele parameters.
DeviceOperation	Metagegevens van bewerkingen.
DeviceUpdateAgentId	Agent-id van Device Update
DeviceUpdateClientOptionalParams	Optionele parameters voor de client.
DeviceUpdateDeleteUpdateOptionalParams	Optionele parameters.
DeviceUpdateGetFileOptionalParams	Optionele parameters.
DeviceUpdateGetOperationStatusOptionalParams	Optionele parameters.
DeviceUpdateGetUpdateOptionalParams	Optionele parameters.
DeviceUpdateImportUpdateOptionalParams	Optionele parameters.
DeviceUpdateListFilesOptionalParams	Optionele parameters.
DeviceUpdateListNamesOptionalParams	Optionele parameters.
DeviceUpdateListOperationStatusesOptionalParams	Optionele parameters.
DeviceUpdateListProvidersOptionalParams	Optionele parameters.
DeviceUpdateListUpdatesOptionalParams	Optionele parameters.
DeviceUpdateListVersionsOptionalParams	Optionele parameters.
DeviceUpdateOperations	Interface die een DeviceUpdate-operatie vertegenwoordigt.
ErrorModel	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
FileImportMetadata	Metagegevens die een updatebestand beschrijven.
Group	Groepsdetails.
HealthCheck	Gezondheidscontrole
ImportManifestMetadata	Metagegevens die het importmanifest beschrijven, een document waarin de bestanden en andere metagegevens over een updateversie worden beschreven.
ImportUpdateInputItem	Importeer de metagegevens van het invoeritem.
InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
InstallResult	Het installatieresultaat van een update en eventuele stapresultaten eronder.
Instructions	Update installatie-instructies container.
LogCollection	Hoofdtekst van diagnostische aanvraag
LogCollectionOperationDetailedStatus	Gedetailleerde status van apparaatdiagnosebewerking
LogCollectionOperationDeviceStatus	Apparaatstatus van diagnostische bewerking
PageSettings	Opties voor de methode byPage
PagedAsyncIterableIterator	Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PatchBody	Hoofdtekst van patchaanvraag voor JSON-samenvoeging van apparaatklasse
RestorePollerOptions
Step	De installatie-instructiestap bijwerken.
StepResult	Het stapresultaat onder een update.
Update	Metagegevens bijwerken.
UpdateCompliance	Nalevingsinformatie bijwerken.
UpdateFile	Metagegevens van bestand bijwerken.
UpdateFileBase	Basismetagegevens van bestand bijwerken.
UpdateFileDownloadHandler	Downloadhandler voor het gebruik van gerelateerde bestanden om payload-bestand te downloaden.
UpdateId	Id bijwerken.
UpdateInfo	Informatie bijwerken.
UpdateOperation	Metagegevens van bewerkingen.

Type-aliassen

ContinuablePage	Een interface die een pagina met resultaten beschrijft.
DeploymentState	Implementatiestatus.
DeviceClassSubgroupDeploymentState	Implementatiestatus van subgroep van apparaatklasse.
DeviceDeploymentState	Implementatiestatus.
DeviceHealthState	Statussen van apparaatstatus
DownloadSecurity	Het protocol dat het apparaat moet gebruiken bij het downloaden van de update-payload.
GroupType	Ondersteunde groepstypen.
HealthCheckResult	Statuscontroleresultaat
ImportType	Het type apparaatimport.
OperationStatus	Bewerkingsstatus.
StepType	Staptype.

Enums

KnownVersions

De beschikbare API-versies.

Functies

isRestError(unknown)	Typeguard voor RestError
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

client

DeviceUpdateClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retouren

PollerLike<OperationState<TResult>, TResult>

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type

RestErrorConstructor