@azure/iot-device-update package
Classi
| DeviceUpdateClient |
Interfacce
| CloudInitiatedRollbackPolicy |
Criteri di rollback per la distribuzione |
| CloudInitiatedRollbackPolicyFailure |
Condizioni di errore per avviare i criteri di rollback |
| Compatibility |
Coppie chiave-valore che rappresentano le informazioni di compatibilità degli aggiornamenti. |
| ContractModel |
Modello di contratto dell'agente di Aggiornamento dispositivi. |
| Deployment |
Metadati della distribuzione. |
| DeploymentDeviceState |
Stato del dispositivo di distribuzione. |
| DeploymentStatus |
Metadati dello stato della distribuzione. |
| Device |
Metadati del dispositivo. |
| DeviceClass |
Metadati della classe del dispositivo. |
| DeviceClassProperties |
Proprietà della classe di dispositivo usate per calcolare l'ID classe dispositivo |
| DeviceClassSubgroup |
Dettagli del sottogruppo della classe dispositivo. Un sottogruppo di classi di dispositivi è un subset di dispositivi in un gruppo che condividono lo stesso ID classe dispositivo. |
| DeviceClassSubgroupDeploymentStatus |
Metadati dello stato di distribuzione della classe del sottogruppo di dispositivi. |
| DeviceClassSubgroupUpdatableDevices |
Sottogruppo di classi di dispositivi, informazioni di aggiornamento e numero di dispositivi per cui è applicabile l'aggiornamento. |
| DeviceHealth |
Integrità del dispositivo |
| DeviceManagementCreateOrUpdateDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementDeleteDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementDeleteDeviceClassOptionalParams |
Parametri facoltativi. |
| DeviceManagementDeleteDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementDeleteGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeploymentStatusOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceClassOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceModuleOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetDeviceOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetLogCollectionDetailedStatusOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetLogCollectionOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetOperationStatusOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetUpdateComplianceForGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementGetUpdateComplianceOptionalParams |
Parametri facoltativi. |
| DeviceManagementImportDevicesOptionalParams |
Parametri facoltativi. |
| DeviceManagementListBestUpdatesForGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDeploymentsForGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDeviceClassesOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementListDevicesOptionalParams |
Parametri facoltativi. |
| DeviceManagementListGroupsOptionalParams |
Parametri facoltativi. |
| DeviceManagementListHealthOfDevicesOptionalParams |
Parametri facoltativi. |
| DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams |
Parametri facoltativi. |
| DeviceManagementListLogCollectionsOptionalParams |
Parametri facoltativi. |
| DeviceManagementListOperationStatusesOptionalParams |
Parametri facoltativi. |
| DeviceManagementOperations |
Interfaccia che rappresenta un'operazione di DeviceManagement. |
| DeviceManagementRetryDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementStartLogCollectionOptionalParams |
Parametri facoltativi. |
| DeviceManagementStopDeploymentOptionalParams |
Parametri facoltativi. |
| DeviceManagementUpdateDeviceClassOptionalParams |
Parametri facoltativi. |
| DeviceOperation |
Metadati dell'operazione. |
| DeviceUpdateAgentId |
ID agente di Aggiornamento dispositivi |
| DeviceUpdateClientOptionalParams |
Parametri facoltativi per il client. |
| DeviceUpdateDeleteUpdateOptionalParams |
Parametri facoltativi. |
| DeviceUpdateGetFileOptionalParams |
Parametri facoltativi. |
| DeviceUpdateGetOperationStatusOptionalParams |
Parametri facoltativi. |
| DeviceUpdateGetUpdateOptionalParams |
Parametri facoltativi. |
| DeviceUpdateImportUpdateOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListFilesOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListNamesOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListOperationStatusesOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListProvidersOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListUpdatesOptionalParams |
Parametri facoltativi. |
| DeviceUpdateListVersionsOptionalParams |
Parametri facoltativi. |
| DeviceUpdateOperations |
Interfaccia che rappresenta un'operazione DeviceUpdate. |
| ErrorModel |
Dettagli errore. |
| ErrorResponse |
Risposta di errore comune. |
| FileImportMetadata |
Metadati che descrivono un file di aggiornamento. |
| Group |
Dettagli del gruppo. |
| HealthCheck |
Controllo sanitario |
| ImportManifestMetadata |
Metadati che descrivono il manifesto di importazione, un documento che descrive i file e altri metadati relativi a una versione di aggiornamento. |
| ImportUpdateInputItem |
Importare i metadati degli elementi di input di aggiornamento. |
| InnerError |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
| InstallResult |
Risultato dell'installazione di un aggiornamento e risultati di qualsiasi passaggio al suo interno. |
| Instructions |
Aggiorna il contenitore delle istruzioni di installazione. |
| LogCollection |
Corpo della richiesta di diagnostica |
| LogCollectionOperationDetailedStatus |
Stato dettagliato dell'operazione di diagnostica del dispositivo |
| LogCollectionOperationDeviceStatus |
Stato del dispositivo dell'operazione di diagnostica |
| PageSettings |
Opzioni per il metodo byPage |
| PagedAsyncIterableIterator |
Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina. |
| PatchBody |
Corpo della richiesta patch di merge JSON della classe di dispositivo |
| RestorePollerOptions | |
| Step |
Aggiornare il passaggio dell'istruzione di installazione. |
| StepResult |
Risultato del passaggio in un aggiornamento. |
| Update |
Aggiornare i metadati. |
| UpdateCompliance |
Aggiornare le informazioni di conformità. |
| UpdateFile |
Aggiornare i metadati del file. |
| UpdateFileBase |
Aggiornare i metadati di base del file. |
| UpdateFileDownloadHandler |
Gestore di download per l'utilizzo di file correlati per scaricare il file di payload. |
| UpdateId |
Aggiornare l'identificatore. |
| UpdateInfo |
Informazioni sull'aggiornamento. |
| UpdateOperation |
Metadati dell'operazione. |
Alias tipo
| ContinuablePage |
Interfaccia che descrive una pagina di risultati. |
| DeploymentState |
Stato della distribuzione. |
| DeviceClassSubgroupDeploymentState |
Stato di distribuzione del sottogruppo di classi del dispositivo. |
| DeviceDeploymentState |
Stato della distribuzione. |
| DeviceHealthState |
Stati di integrità dei dispositivi |
| DownloadSecurity |
Il protocollo che il dispositivo dovrebbe usare quando scarica il payload di aggiornamento. |
| GroupType |
Tipi di gruppo supportati. |
| HealthCheckResult |
Risultato del controllo integrità |
| ImportType |
Il tipo di importazione del dispositivo. |
| OperationStatus |
Stato dell'operazione. |
| StepType |
Tipo di passaggio. |
Enumerazioni
| KnownVersions |
Versioni dell'API disponibili. |
Funzioni
| is |
Typeguard per RestError |
| restore |
Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito. |
Variabili
| Rest |
Tipo di errore personalizzato per le richieste di pipeline non riuscite. |
Dettagli funzione
isRestError(unknown)
Typeguard per RestError
function isRestError(e: unknown): eParametri
- e
-
unknown
Un elemento rilevato da una clausola catch.
Valori restituiti
e
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.
function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parametri
- client
- DeviceUpdateClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Valori restituiti
PollerLike<OperationState<TResult>, TResult>
Dettagli delle variabili
RestError
Tipo di errore personalizzato per le richieste di pipeline non riuscite.
RestError: RestErrorConstructor