@azure/iot-device-update package
Klasy
| DeviceUpdateClient |
Interfejsy
| CloudInitiatedRollbackPolicy |
Zasady wycofywania dla wdrożenia |
| CloudInitiatedRollbackPolicyFailure |
Warunki niepowodzenia inicjowania zasad wycofywania |
| Compatibility |
Pary klucz-wartość reprezentujące informacje o kompatybilności z aktualizacją. |
| ContractModel |
Model kontraktu agenta usługi Device Update. |
| Deployment |
Metadane wdrożenia. |
| DeploymentDeviceState |
Stan urządzenia wdrożenia. |
| DeploymentStatus |
Metadane stanu wdrożenia. |
| Device |
Metadane urządzenia. |
| DeviceClass |
Metadane klasy urządzenia. |
| DeviceClassProperties |
Właściwości klasy urządzenia używane do obliczania identyfikatora klasy urządzenia |
| DeviceClassSubgroup |
Szczegóły podgrupy klasy urządzenia. Podgrupa klasy urządzeń jest podzbiorem urządzeń w grupie, która współużytkuje ten sam identyfikator klasy urządzenia. |
| DeviceClassSubgroupDeploymentStatus |
Metadane stanu wdrożenia podgrupy urządzeń. |
| DeviceClassSubgroupUpdatableDevices |
Podgrupa klasy urządzeń, informacje o aktualizacji i liczba urządzeń, dla których ma zastosowanie aktualizacja. |
| DeviceHealth |
Kondycja urządzenia |
| DeviceManagementCreateOrUpdateDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementDeleteDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementDeleteDeviceClassOptionalParams |
Parametry opcjonalne. |
| DeviceManagementDeleteDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementDeleteGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeploymentStatusOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceClassOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceModuleOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetDeviceOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetLogCollectionDetailedStatusOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetLogCollectionOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetOperationStatusOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetUpdateComplianceForGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementGetUpdateComplianceOptionalParams |
Parametry opcjonalne. |
| DeviceManagementImportDevicesOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListBestUpdatesForGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDeploymentsForGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDeviceClassesOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListDevicesOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListGroupsOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListHealthOfDevicesOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListLogCollectionsOptionalParams |
Parametry opcjonalne. |
| DeviceManagementListOperationStatusesOptionalParams |
Parametry opcjonalne. |
| DeviceManagementOperations |
Interfejs reprezentujący operacje DeviceManagement. |
| DeviceManagementRetryDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementStartLogCollectionOptionalParams |
Parametry opcjonalne. |
| DeviceManagementStopDeploymentOptionalParams |
Parametry opcjonalne. |
| DeviceManagementUpdateDeviceClassOptionalParams |
Parametry opcjonalne. |
| DeviceOperation |
Metadane operacji. |
| DeviceUpdateAgentId |
Identyfikator agenta usługi Device Update |
| DeviceUpdateClientOptionalParams |
Parametry opcjonalne dla klienta. |
| DeviceUpdateDeleteUpdateOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateGetFileOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateGetOperationStatusOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateGetUpdateOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateImportUpdateOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListFilesOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListNamesOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListOperationStatusesOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListProvidersOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListUpdatesOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateListVersionsOptionalParams |
Parametry opcjonalne. |
| DeviceUpdateOperations |
Interfejs reprezentujący operacje DeviceUpdate. |
| ErrorModel |
Szczegóły błędu. |
| ErrorResponse |
Typowa odpowiedź na błąd. |
| FileImportMetadata |
Metadane opisujące plik aktualizacji. |
| Group |
Szczegóły grupy. |
| HealthCheck |
Sprawdzanie kondycji |
| ImportManifestMetadata |
Metadane opisujące manifest importu, dokument opisujący pliki i inne metadane dotyczące wersji aktualizacji. |
| ImportUpdateInputItem |
Zaimportuj metadane elementu wejściowego aktualizacji. |
| InnerError |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
| InstallResult |
Wynik instalacji aktualizacji i wszystkie wyniki tego kroku. |
| Instructions |
Aktualizacja instrukcji instalacji kontener. |
| LogCollection |
Treść żądania diagnostycznego |
| LogCollectionOperationDetailedStatus |
Szczegółowy stan operacji diagnostyki urządzenia |
| LogCollectionOperationDeviceStatus |
Stan urządzenia operacji diagnostyki |
| PageSettings |
Opcje dla metody byPage |
| PagedAsyncIterableIterator |
Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony. |
| PatchBody |
Treść żądania scalania JSON klasy urządzenia |
| RestorePollerOptions | |
| Step |
Aktualizowanie kroku instrukcji instalacji. |
| StepResult |
Wynik kroku w ramach aktualizacji. |
| Update |
Aktualizowanie metadanych. |
| UpdateCompliance |
Aktualizowanie informacji o zgodności. |
| UpdateFile |
Aktualizowanie metadanych pliku. |
| UpdateFileBase |
Aktualizowanie podstawowych metadanych pliku. |
| UpdateFileDownloadHandler |
Pobierz program obsługi na potrzeby korzystania z powiązanych plików w celu pobrania pliku ładunku. |
| UpdateId |
Aktualizowanie identyfikatora. |
| UpdateInfo |
Aktualizuj informacje. |
| UpdateOperation |
Metadane operacji. |
Aliasy typu
| ContinuablePage |
Interfejs opisujący stronę wyników. |
| DeploymentState |
Stan wdrożenia. |
| DeviceClassSubgroupDeploymentState |
Stan wdrożenia podgrupy klasy urządzenia. |
| DeviceDeploymentState |
Stan wdrożenia. |
| DeviceHealthState |
Stany kondycji urządzenia |
| DownloadSecurity |
Protokół, którego urządzenie powinno użyć podczas pobierania ładunku aktualizacyjnego. |
| GroupType |
Obsługiwane typy grup. |
| HealthCheckResult |
Wynik sprawdzania kondycji |
| ImportType |
Typ importu urządzenia. |
| OperationStatus |
Stan operacji. |
| StepType |
Typ kroku. |
Wyliczenia
| KnownVersions |
Dostępne wersje interfejsu API. |
Funkcje
| is |
Funkcja Typeguard dla błędu RestError |
| restore |
Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie. |
Zmienne
| Rest |
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem. |
Szczegóły funkcji
isRestError(unknown)
Funkcja Typeguard dla błędu RestError
function isRestError(e: unknown): eParametry
- e
-
unknown
Coś złapanego przez klauzulę catch.
Zwraca
e
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.
function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parametry
- client
- DeviceUpdateClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Zwraca
PollerLike<OperationState<TResult>, TResult>
Szczegóły zmiennej
RestError
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
RestError: RestErrorConstructor