@azure/iot-device-update package
Classes
| DeviceUpdateClient |
Interfaces
| CloudInitiatedRollbackPolicy |
Política de reversão para implantação |
| CloudInitiatedRollbackPolicyFailure |
Condições de falha para iniciar a política de reversão |
| Compatibility |
Pares chave-valor que representam informação de compatibilidade de atualizações. |
| ContractModel |
O modelo de contrato do agente de Atualização de Dispositivo. |
| Deployment |
Metadados de implantação. |
| DeploymentDeviceState |
Status do dispositivo de implantação. |
| DeploymentStatus |
Metadados de status de implantação. |
| Device |
Metadados do dispositivo. |
| DeviceClass |
Metadados de classe de dispositivo. |
| DeviceClassProperties |
As propriedades da classe de dispositivo que são usadas para calcular a ID da classe de dispositivo |
| DeviceClassSubgroup |
Detalhes do subgrupo da classe do dispositivo. Um subgrupo de classe de dispositivo é um subconjunto de dispositivos em um grupo que compartilham a mesma ID de classe de dispositivo. |
| DeviceClassSubgroupDeploymentStatus |
Metadados de status de implantação do subgrupo de classe de dispositivo. |
| DeviceClassSubgroupUpdatableDevices |
Subgrupo de classe de dispositivo, informações de atualização e o número de dispositivos para os quais a atualização é aplicável. |
| DeviceHealth |
Estado de Funcionamento dos Dispositivos |
| DeviceManagementCreateOrUpdateDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementDeleteDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementDeleteDeviceClassOptionalParams |
Parâmetros opcionais. |
| DeviceManagementDeleteDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementDeleteGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeploymentStatusOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceClassOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceModuleOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetDeviceOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetLogCollectionDetailedStatusOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetLogCollectionOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetOperationStatusOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetUpdateComplianceForGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementGetUpdateComplianceOptionalParams |
Parâmetros opcionais. |
| DeviceManagementImportDevicesOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListBestUpdatesForGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDeploymentsForGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDeviceClassesOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListDevicesOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListGroupsOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListHealthOfDevicesOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListLogCollectionsOptionalParams |
Parâmetros opcionais. |
| DeviceManagementListOperationStatusesOptionalParams |
Parâmetros opcionais. |
| DeviceManagementOperations |
Interface representando uma operação de Gestão de Dispositivos. |
| DeviceManagementRetryDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementStartLogCollectionOptionalParams |
Parâmetros opcionais. |
| DeviceManagementStopDeploymentOptionalParams |
Parâmetros opcionais. |
| DeviceManagementUpdateDeviceClassOptionalParams |
Parâmetros opcionais. |
| DeviceOperation |
Metadados da operação. |
| DeviceUpdateAgentId |
ID do agente de Atualização de Dispositivo |
| DeviceUpdateClientOptionalParams |
Parâmetros opcionais para o cliente. |
| DeviceUpdateDeleteUpdateOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateGetFileOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateGetOperationStatusOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateGetUpdateOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateImportUpdateOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListFilesOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListNamesOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListOperationStatusesOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListProvidersOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListUpdatesOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateListVersionsOptionalParams |
Parâmetros opcionais. |
| DeviceUpdateOperations |
Interface representando operações DeviceUpdate. |
| ErrorModel |
Detalhes do erro. |
| ErrorResponse |
Resposta de erro comum. |
| FileImportMetadata |
Metadados que descrevem um arquivo de atualização. |
| Group |
Detalhes do grupo. |
| HealthCheck |
Exame de saúde |
| ImportManifestMetadata |
Metadados que descrevem o manifesto de importação, um documento que descreve os arquivos e outros metadados sobre uma versão de atualização. |
| ImportUpdateInputItem |
Importar metadados do item de entrada de atualização. |
| InnerError |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
| InstallResult |
O resultado da instalação de uma atualização e qualquer etapa resulta nela. |
| Instructions |
Atualizar o contentor de instruções de instalação. |
| LogCollection |
Corpo da solicitação de diagnóstico |
| LogCollectionOperationDetailedStatus |
Status detalhado da operação de diagnóstico do dispositivo |
| LogCollectionOperationDeviceStatus |
Estado do dispositivo de operação de diagnóstico |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável até a conclusão e por página. |
| PatchBody |
Corpo da solicitação do patch de mesclagem JSON da classe de dispositivo |
| RestorePollerOptions | |
| Step |
Etapa de instruções de instalação da atualização. |
| StepResult |
O resultado da etapa sob uma atualização. |
| Update |
Atualizar metadados. |
| UpdateCompliance |
Atualize as informações de conformidade. |
| UpdateFile |
Atualizar metadados do arquivo. |
| UpdateFileBase |
Atualizar metadados básicos do arquivo. |
| UpdateFileDownloadHandler |
Manipulador de download para utilizar arquivos relacionados para baixar o arquivo de carga útil. |
| UpdateId |
Atualizar identificador. |
| UpdateInfo |
Atualizar informações. |
| UpdateOperation |
Metadados da operação. |
Aliases de Tipo
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| DeploymentState |
Estado de implantação. |
| DeviceClassSubgroupDeploymentState |
Estado de implantação do subgrupo de classe de dispositivo. |
| DeviceDeploymentState |
Estado de implantação. |
| DeviceHealthState |
Estados de integridade do dispositivo |
| DownloadSecurity |
O protocolo que o dispositivo deve usar ao descarregar a carga útil de atualização. |
| GroupType |
Tipos de grupo suportados. |
| HealthCheckResult |
Resultado do exame de saúde |
| ImportType |
O tipo de importação do dispositivo. |
| OperationStatus |
Estado da operação. |
| StepType |
Tipo de passo. |
Enumerações
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes de Função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): eParâmetros
- e
-
unknown
Algo apanhado por uma cláusula de captura.
Devoluções
e
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.
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>
Devoluções
PollerLike<OperationState<TResult>, TResult>
Detalhes das variáveis
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor