@azure/iot-device-update package

Klasser

DeviceUpdateClient

Gränssnitt

CloudInitiatedRollbackPolicy	Återställningsprincip för distribution
CloudInitiatedRollbackPolicyFailure	Feltillstånd för att initiera återställningsprincip
Compatibility	Nyckelvärdepar som representerar uppdateringskompatibilitetsinformation.
ContractModel	Kontraktsmodellen för enhetsuppdateringsagenten.
Deployment	Distributionsmetadata.
DeploymentDeviceState	Distributionsenhetsstatus.
DeploymentStatus	Metadata för distributionsstatus.
Device	Enhetsmetadata.
DeviceClass	Metadata för enhetsklass.
DeviceClassProperties	Egenskaper för enhetsklass som används för att beräkna enhetsklass-ID:t
DeviceClassSubgroup	Information om enhetsklassundergrupper. En undergrupp för enhetsklass är en delmängd av enheter i en grupp som delar samma enhetsklass-ID.
DeviceClassSubgroupDeploymentStatus	Statusmetadata för distributionsstatus för enhetsklass.
DeviceClassSubgroupUpdatableDevices	Undergrupp för enhetsklass, uppdateringsinformation och antalet enheter som uppdateringen gäller för.
DeviceHealth	Enhetshälsotillstånd
DeviceManagementCreateOrUpdateDeploymentOptionalParams	Valfria parametrar.
DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementDeleteDeploymentOptionalParams	Valfria parametrar.
DeviceManagementDeleteDeviceClassOptionalParams	Valfria parametrar.
DeviceManagementDeleteDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementDeleteGroupOptionalParams	Valfria parametrar.
DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementGetDeploymentOptionalParams	Valfria parametrar.
DeviceManagementGetDeploymentStatusOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceClassOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceModuleOptionalParams	Valfria parametrar.
DeviceManagementGetDeviceOptionalParams	Valfria parametrar.
DeviceManagementGetGroupOptionalParams	Valfria parametrar.
DeviceManagementGetLogCollectionDetailedStatusOptionalParams	Valfria parametrar.
DeviceManagementGetLogCollectionOptionalParams	Valfria parametrar.
DeviceManagementGetOperationStatusOptionalParams	Valfria parametrar.
DeviceManagementGetUpdateComplianceForGroupOptionalParams	Valfria parametrar.
DeviceManagementGetUpdateComplianceOptionalParams	Valfria parametrar.
DeviceManagementImportDevicesOptionalParams	Valfria parametrar.
DeviceManagementListBestUpdatesForGroupOptionalParams	Valfria parametrar.
DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams	Valfria parametrar.
DeviceManagementListDeploymentsForGroupOptionalParams	Valfria parametrar.
DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams	Valfria parametrar.
DeviceManagementListDeviceClassesOptionalParams	Valfria parametrar.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams	Valfria parametrar.
DeviceManagementListDevicesOptionalParams	Valfria parametrar.
DeviceManagementListGroupsOptionalParams	Valfria parametrar.
DeviceManagementListHealthOfDevicesOptionalParams	Valfria parametrar.
DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams	Valfria parametrar.
DeviceManagementListLogCollectionsOptionalParams	Valfria parametrar.
DeviceManagementListOperationStatusesOptionalParams	Valfria parametrar.
DeviceManagementOperations	Gränssnitt som representerar en DeviceManagement-operation.
DeviceManagementRetryDeploymentOptionalParams	Valfria parametrar.
DeviceManagementStartLogCollectionOptionalParams	Valfria parametrar.
DeviceManagementStopDeploymentOptionalParams	Valfria parametrar.
DeviceManagementUpdateDeviceClassOptionalParams	Valfria parametrar.
DeviceOperation	Åtgärdsmetadata.
DeviceUpdateAgentId	Enhetsuppdateringsagent-ID
DeviceUpdateClientOptionalParams	Valfria parametrar för klienten.
DeviceUpdateDeleteUpdateOptionalParams	Valfria parametrar.
DeviceUpdateGetFileOptionalParams	Valfria parametrar.
DeviceUpdateGetOperationStatusOptionalParams	Valfria parametrar.
DeviceUpdateGetUpdateOptionalParams	Valfria parametrar.
DeviceUpdateImportUpdateOptionalParams	Valfria parametrar.
DeviceUpdateListFilesOptionalParams	Valfria parametrar.
DeviceUpdateListNamesOptionalParams	Valfria parametrar.
DeviceUpdateListOperationStatusesOptionalParams	Valfria parametrar.
DeviceUpdateListProvidersOptionalParams	Valfria parametrar.
DeviceUpdateListUpdatesOptionalParams	Valfria parametrar.
DeviceUpdateListVersionsOptionalParams	Valfria parametrar.
DeviceUpdateOperations	Gränssnitt som representerar en DeviceUpdate-operation.
ErrorModel	Felinformation.
ErrorResponse	Vanligt felsvar.
FileImportMetadata	Metadata som beskriver en uppdateringsfil.
Group	Gruppinformation.
HealthCheck	Hälsokontroll
ImportManifestMetadata	Metadata som beskriver importmanifestet, ett dokument som beskriver filerna och andra metadata om en uppdateringsversion.
ImportUpdateInputItem	Importera metadata för indataobjekt för uppdatering.
InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
InstallResult	Installationsresultatet för en uppdatering och eventuella stegresultat under den.
Instructions	Uppdatera installationsinstruktioner-containern.
LogCollection	Brödtext för diagnostikbegäran
LogCollectionOperationDetailedStatus	Detaljerad status för enhetsdiagnostikåtgärd
LogCollectionOperationDeviceStatus	Enhetsstatus för diagnostikåtgärd
PageSettings	Alternativ för byPage-metoden
PagedAsyncIterableIterator	Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
PatchBody	Begärandetext för JSON-sammanslagning av enhetsklass
RestorePollerOptions
Step	Uppdatera installationsinstruktionssteget.
StepResult	Stegresultatet under en uppdatering.
Update	Uppdatera metadata.
UpdateCompliance	Uppdatera efterlevnadsinformation.
UpdateFile	Uppdatera filmetadata.
UpdateFileBase	Uppdatera grundläggande metadata för filen.
UpdateFileDownloadHandler	Ladda ned hanteraren för att använda relaterade filer för att ladda ned nyttolastfilen.
UpdateId	Uppdatera identifierare.
UpdateInfo	Uppdatera information.
UpdateOperation	Åtgärdsmetadata.

Typalias

ContinuablePage	Ett gränssnitt som beskriver en resultatsida.
DeploymentState	Distributionstillstånd.
DeviceClassSubgroupDeploymentState	Distributionstillstånd för enhetsklass undergrupp.
DeviceDeploymentState	Distributionstillstånd.
DeviceHealthState	Tillstånd för enhetens hälsotillstånd
DownloadSecurity	Protokollet som enheten bör använda när uppdateringspayloaden laddas ner.
GroupType	Grupptyper som stöds.
HealthCheckResult	Hälsokontrollresultat
ImportType	Enhetsimporttypen.
OperationStatus	Åtgärdsstatus.
StepType	Stegtyp.

Uppräkningar

KnownVersions

Tillgängliga API-versioner.

Funktioner

isRestError(unknown)	Typeguard för RestError
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

client

DeviceUpdateClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returer

PollerLike<OperationState<TResult>, TResult>

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ

RestErrorConstructor