@azure/iot-device-update package
Clases
| DeviceUpdateClient |
Interfaces
| CloudInitiatedRollbackPolicy |
Directiva de reversión para la implementación |
| CloudInitiatedRollbackPolicyFailure |
Condiciones de error para iniciar la directiva de reversión |
| Compatibility |
Pares clave-valor que representan la información de compatibilidad de actualizaciones. |
| ContractModel |
El modelo de contrato del agente de Device Update. |
| Deployment |
Metadatos de implementación. |
| DeploymentDeviceState |
Estado del dispositivo de implementación. |
| DeploymentStatus |
Metadatos de estado de implementación. |
| Device |
Metadatos del dispositivo. |
| DeviceClass |
Metadatos de clase de dispositivo. |
| DeviceClassProperties |
Propiedades de clase de dispositivo que se usan para calcular el identificador de clase de dispositivo |
| DeviceClassSubgroup |
Detalles del subgrupo de clase de dispositivo. Un subgrupo de clase de dispositivo es un subconjunto de dispositivos de un grupo que comparte el mismo identificador de clase de dispositivo. |
| DeviceClassSubgroupDeploymentStatus |
Metadatos de estado de implementación de subgrupo de clase de dispositivo. |
| DeviceClassSubgroupUpdatableDevices |
Subgrupo de clase de dispositivo, información de actualización y número de dispositivos para los que se aplica la actualización. |
| DeviceHealth |
Estado del dispositivo |
| DeviceManagementCreateOrUpdateDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementDeleteDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementDeleteDeviceClassOptionalParams |
Parámetros opcionales. |
| DeviceManagementDeleteDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementDeleteGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeploymentStatusOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceClassOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceModuleOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetDeviceOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetLogCollectionDetailedStatusOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetLogCollectionOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetOperationStatusOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetUpdateComplianceForGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementGetUpdateComplianceOptionalParams |
Parámetros opcionales. |
| DeviceManagementImportDevicesOptionalParams |
Parámetros opcionales. |
| DeviceManagementListBestUpdatesForGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDeploymentsForGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDeviceClassesOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementListDevicesOptionalParams |
Parámetros opcionales. |
| DeviceManagementListGroupsOptionalParams |
Parámetros opcionales. |
| DeviceManagementListHealthOfDevicesOptionalParams |
Parámetros opcionales. |
| DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams |
Parámetros opcionales. |
| DeviceManagementListLogCollectionsOptionalParams |
Parámetros opcionales. |
| DeviceManagementListOperationStatusesOptionalParams |
Parámetros opcionales. |
| DeviceManagementOperations |
Interfaz que representa una operación de Gestión de Dispositivos. |
| DeviceManagementRetryDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementStartLogCollectionOptionalParams |
Parámetros opcionales. |
| DeviceManagementStopDeploymentOptionalParams |
Parámetros opcionales. |
| DeviceManagementUpdateDeviceClassOptionalParams |
Parámetros opcionales. |
| DeviceOperation |
Metadatos de la operación. |
| DeviceUpdateAgentId |
Identificador del agente de Device Update |
| DeviceUpdateClientOptionalParams |
Parámetros opcionales para el cliente. |
| DeviceUpdateDeleteUpdateOptionalParams |
Parámetros opcionales. |
| DeviceUpdateGetFileOptionalParams |
Parámetros opcionales. |
| DeviceUpdateGetOperationStatusOptionalParams |
Parámetros opcionales. |
| DeviceUpdateGetUpdateOptionalParams |
Parámetros opcionales. |
| DeviceUpdateImportUpdateOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListFilesOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListNamesOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListOperationStatusesOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListProvidersOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListUpdatesOptionalParams |
Parámetros opcionales. |
| DeviceUpdateListVersionsOptionalParams |
Parámetros opcionales. |
| DeviceUpdateOperations |
Interfaz que representa una operación de DeviceUpdate. |
| ErrorModel |
Detalles del error. |
| ErrorResponse |
Respuesta de error común. |
| FileImportMetadata |
Metadatos que describen un archivo de actualización. |
| Group |
Detalles del grupo. |
| HealthCheck |
Comprobación de estado |
| ImportManifestMetadata |
Metadatos que describen el manifiesto de importación, un documento que describe los archivos y otros metadatos sobre una versión de actualización. |
| ImportUpdateInputItem |
Importar metadatos de elemento de entrada de actualización. |
| InnerError |
Objeto que contiene información más específica que el objeto actual sobre el error. |
| InstallResult |
Resultado de la instalación de una actualización y los resultados de los pasos en él. |
| Instructions |
Actualizar instrucciones de instalación contenedor. |
| LogCollection |
Cuerpo de la solicitud de diagnóstico |
| LogCollectionOperationDetailedStatus |
Estado detallado de la operación de diagnóstico de dispositivos |
| LogCollectionOperationDeviceStatus |
Estado del dispositivo de la operación de diagnóstico |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| PatchBody |
Cuerpo de la solicitud de revisión de mezcla JSON de clase de dispositivo |
| RestorePollerOptions | |
| Step |
Actualice el paso de instrucción de instalación. |
| StepResult |
Resultado del paso en una actualización. |
| Update |
Actualizar metadatos. |
| UpdateCompliance |
Actualizar la información de cumplimiento. |
| UpdateFile |
Actualice los metadatos del archivo. |
| UpdateFileBase |
Actualice los metadatos básicos del archivo. |
| UpdateFileDownloadHandler |
Controlador de descarga para usar archivos relacionados para descargar el archivo de carga. |
| UpdateId |
Identificador de actualización. |
| UpdateInfo |
Información de actualización. |
| UpdateOperation |
Metadatos de la operación. |
Alias de tipos
| ContinuablePage |
Interfaz que describe una página de resultados. |
| DeploymentState |
Estado de implementación. |
| DeviceClassSubgroupDeploymentState |
Estado de implementación de subgrupo de clase de dispositivo. |
| DeviceDeploymentState |
Estado de implementación. |
| DeviceHealthState |
Estados de estado del dispositivo |
| DownloadSecurity |
El protocolo que el dispositivo debe usar al descargar la carga útil de actualización. |
| GroupType |
Tipos de grupo admitidos. |
| HealthCheckResult |
Resultado de la comprobación de estado |
| ImportType |
El tipo de importación del dispositivo. |
| OperationStatus |
Estado de la operación. |
| StepType |
Tipo de paso. |
Enumeraciones
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): eParámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parámetros
- client
- DeviceUpdateClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor