@azure/iot-device-update package

Classes

DeviceUpdateClient

Interfaces

CloudInitiatedRollbackPolicy	Stratégie de restauration pour le déploiement
CloudInitiatedRollbackPolicyFailure	Conditions d’échec pour lancer la stratégie de restauration
Compatibility	Les paires clé-valeur représentant les informations de compatibilité des mises à jour.
ContractModel	Modèle de contrat de l’agent Device Update.
Deployment	Métadonnées de déploiement.
DeploymentDeviceState	État de l’appareil de déploiement.
DeploymentStatus	Métadonnées d’état du déploiement.
Device	Métadonnées de l’appareil.
DeviceClass	Métadonnées de classe d’appareil.
DeviceClassProperties	Propriétés de classe d’appareil utilisées pour calculer l’ID de classe d’appareil
DeviceClassSubgroup	Détails du sous-groupe de classes d’appareil. Un sous-groupe de classes d’appareils est un sous-ensemble d’appareils d’un groupe qui partagent le même ID de classe d’appareil.
DeviceClassSubgroupDeploymentStatus	Métadonnées d’état du déploiement du sous-groupe de classes d’appareil.
DeviceClassSubgroupUpdatableDevices	Sous-groupe de classes d’appareils, informations de mise à jour et nombre d’appareils pour lesquels la mise à jour s’applique.
DeviceHealth	État du périphérique
DeviceManagementCreateOrUpdateDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementDeleteDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementDeleteDeviceClassOptionalParams	Paramètres facultatifs.
DeviceManagementDeleteDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementDeleteGroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeploymentStatusOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceClassOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceModuleOptionalParams	Paramètres facultatifs.
DeviceManagementGetDeviceOptionalParams	Paramètres facultatifs.
DeviceManagementGetGroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetLogCollectionDetailedStatusOptionalParams	Paramètres facultatifs.
DeviceManagementGetLogCollectionOptionalParams	Paramètres facultatifs.
DeviceManagementGetOperationStatusOptionalParams	Paramètres facultatifs.
DeviceManagementGetUpdateComplianceForGroupOptionalParams	Paramètres facultatifs.
DeviceManagementGetUpdateComplianceOptionalParams	Paramètres facultatifs.
DeviceManagementImportDevicesOptionalParams	Paramètres facultatifs.
DeviceManagementListBestUpdatesForGroupOptionalParams	Paramètres facultatifs.
DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams	Paramètres facultatifs.
DeviceManagementListDeploymentsForGroupOptionalParams	Paramètres facultatifs.
DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams	Paramètres facultatifs.
DeviceManagementListDeviceClassesOptionalParams	Paramètres facultatifs.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementListDevicesOptionalParams	Paramètres facultatifs.
DeviceManagementListGroupsOptionalParams	Paramètres facultatifs.
DeviceManagementListHealthOfDevicesOptionalParams	Paramètres facultatifs.
DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams	Paramètres facultatifs.
DeviceManagementListLogCollectionsOptionalParams	Paramètres facultatifs.
DeviceManagementListOperationStatusesOptionalParams	Paramètres facultatifs.
DeviceManagementOperations	Interface représentant une opération de gestion de dispositifs.
DeviceManagementRetryDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementStartLogCollectionOptionalParams	Paramètres facultatifs.
DeviceManagementStopDeploymentOptionalParams	Paramètres facultatifs.
DeviceManagementUpdateDeviceClassOptionalParams	Paramètres facultatifs.
DeviceOperation	Métadonnées d’opération.
DeviceUpdateAgentId	ID de l’agent Device Update
DeviceUpdateClientOptionalParams	Paramètres facultatifs pour le client.
DeviceUpdateDeleteUpdateOptionalParams	Paramètres facultatifs.
DeviceUpdateGetFileOptionalParams	Paramètres facultatifs.
DeviceUpdateGetOperationStatusOptionalParams	Paramètres facultatifs.
DeviceUpdateGetUpdateOptionalParams	Paramètres facultatifs.
DeviceUpdateImportUpdateOptionalParams	Paramètres facultatifs.
DeviceUpdateListFilesOptionalParams	Paramètres facultatifs.
DeviceUpdateListNamesOptionalParams	Paramètres facultatifs.
DeviceUpdateListOperationStatusesOptionalParams	Paramètres facultatifs.
DeviceUpdateListProvidersOptionalParams	Paramètres facultatifs.
DeviceUpdateListUpdatesOptionalParams	Paramètres facultatifs.
DeviceUpdateListVersionsOptionalParams	Paramètres facultatifs.
DeviceUpdateOperations	Interface représentant une opération DeviceUpdate.
ErrorModel	Détails de l’erreur.
ErrorResponse	Réponse d’erreur courante.
FileImportMetadata	Métadonnées décrivant un fichier de mise à jour.
Group	Détails du groupe.
HealthCheck	Bilan de santé
ImportManifestMetadata	Métadonnées décrivant le manifeste d’importation, document qui décrit les fichiers et d’autres métadonnées sur une version de mise à jour.
ImportUpdateInputItem	Importez les métadonnées de l’élément d’entrée de mise à jour.
InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
InstallResult	Résultat de l’installation d’une mise à jour et de tous les résultats de l’étape sous celui-ci.
Instructions	Mise à jour le conteneur des instructions d’installation.
LogCollection	Corps de la demande de diagnostics
LogCollectionOperationDetailedStatus	État détaillé de l’opération de diagnostic d’appareil
LogCollectionOperationDeviceStatus	État de l’appareil d’opération de diagnostic
PageSettings	Options de la méthode byPage
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
PatchBody	Corps de la demande de correctif de fusion JSON de classe d’appareil
RestorePollerOptions
Step	Mettre à jour l’étape d’instruction d’installation.
StepResult	Résultat de l’étape sous une mise à jour.
Update	Mettez à jour les métadonnées.
UpdateCompliance	Mettez à jour les informations de conformité.
UpdateFile	Mettez à jour les métadonnées du fichier.
UpdateFileBase	Mettez à jour les métadonnées de base du fichier.
UpdateFileDownloadHandler	Gestionnaire de téléchargement pour l’utilisation de fichiers associés pour télécharger le fichier de charge utile.
UpdateId	Mettre à jour l’identificateur.
UpdateInfo	Mettez à jour les informations.
UpdateOperation	Métadonnées d’opération.

Alias de type

ContinuablePage	Interface qui décrit une page de résultats.
DeploymentState	État du déploiement.
DeviceClassSubgroupDeploymentState	État du déploiement du sous-groupe de classes d’appareil.
DeviceDeploymentState	État du déploiement.
DeviceHealthState	États d’intégrité des appareils
DownloadSecurity	Le protocole que l’appareil doit utiliser lors du téléchargement de la charge utile de mise à jour.
GroupType	Types de groupes pris en charge.
HealthCheckResult	Résultat du contrôle d’intégrité
ImportType	Le type d’importation d’appareil.
OperationStatus	État de l’opération.
StepType	Type d’étape.

Énumérations

KnownVersions

Versions d’API disponibles.

Functions

isRestError(unknown)	Typeguard pour RestError
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

Informations relatives à la fonction

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

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

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

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

Paramètres

client

DeviceUpdateClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>

Détails de variable

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type

RestErrorConstructor