@azure/arm-iothub package

Classes

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	O Certificado X509 serializado em JSON.
CertificateDescription	O certificado X509.
CertificateListDescription	A matriz serializada em JSON de objetos Certificate.
CertificateProperties	A descrição de um Certificado de Autoridade de Certificação X509.
CertificatePropertiesWithNonce	A descrição de um Certificado de Autoridade de Certificação X509, incluindo o nonce de desafio emitido para o fluxo de Prova de Posse.
CertificateVerificationDescription	O certificado folha serializado em JSON
CertificateWithNonceDescription	O certificado X509.
Certificates	Interface que representa um Certificados.
CertificatesCreateOrUpdateOptionalParams	Parâmetros opcionais.
CertificatesDeleteOptionalParams	Parâmetros opcionais.
CertificatesGenerateVerificationCodeOptionalParams	Parâmetros opcionais.
CertificatesGetOptionalParams	Parâmetros opcionais.
CertificatesListByIotHubOptionalParams	Parâmetros opcionais.
CertificatesVerifyOptionalParams	Parâmetros opcionais.
CloudToDeviceProperties	As propriedades de mensagens da nuvem para o dispositivo do Hub IoT.
EndpointHealthData	Os dados de integridade de um ponto de extremidade
EndpointHealthDataListResult	A matriz serializada em JSON de objetos EndpointHealthData com um próximo link.
EnrichmentProperties	As propriedades de um enriquecimento que seu Hub IoT aplica às mensagens entregues aos pontos de extremidade.
ErrorDetails	Detalhes do erro.
EventHubConsumerGroupBodyDescription	O grupo de consumidores do EventHub.
EventHubConsumerGroupInfo	As propriedades do objeto EventHubConsumerGroupInfo.
EventHubConsumerGroupName	O nome do grupo de consumidores do EventHub.
EventHubConsumerGroupsListResult	A matriz serializada em JSON de nomes de grupo de consumidores compatíveis com o Hub de Eventos com um próximo link.
EventHubProperties	As propriedades do ponto de extremidade compatível com o Hub de Eventos provisionado usado pelo Hub IoT.
ExportDevicesRequest	Use para fornecer parâmetros ao solicitar uma exportação de todos os dispositivos no Hub IoT.
FailoverInput	Use para fornecer a região de failover ao solicitar failover manual para um hub.
FallbackRouteProperties	As propriedades da rota de fallback. Hub IoT usa essas propriedades quando roteia mensagens para o ponto de extremidade de fallback.
FeedbackProperties	As propriedades da fila de comentários para mensagens da nuvem para o dispositivo.
GroupIdInformation	As informações do grupo para criar um ponto de extremidade privado em um IotHub
GroupIdInformationProperties	As propriedades de um objeto de informações de grupo
ImportDevicesRequest	Use para fornecer parâmetros ao solicitar uma importação de todos os dispositivos no hub.
IotHub	Interface que representa um IotHub.
IotHubCapacity	Hub IoT informações de capacidade.
IotHubClientOptionalParams	Parâmetros opcionais.
IotHubDescription	A descrição do Hub IoT.
IotHubDescriptionListResult	A matriz serializada em JSON de objetos IotHubDescription com um próximo link.
IotHubLocationDescription	Representação pública de um dos locais em que um recurso é provisionado.
IotHubManualFailoverHeaders	Define cabeçalhos para IotHub_manualFailover operação.
IotHubManualFailoverOptionalParams	Parâmetros opcionais.
IotHubNameAvailabilityInfo	As propriedades que indicam se um determinado nome de hub IoT está disponível.
IotHubProperties	As propriedades de um hub IoT.
IotHubQuotaMetricInfo	Propriedades de métricas de cota.
IotHubQuotaMetricInfoListResult	A matriz serializada em JSON de objetos IotHubQuotaMetricInfo com um próximo link.
IotHubResource	Interface que representa um IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Parâmetros opcionais.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Parâmetros opcionais.
IotHubResourceCreateOrUpdateOptionalParams	Parâmetros opcionais.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Parâmetros opcionais.
IotHubResourceDeleteHeaders	Define cabeçalhos para IotHubResource_delete operação.
IotHubResourceDeleteOptionalParams	Parâmetros opcionais.
IotHubResourceExportDevicesOptionalParams	Parâmetros opcionais.
IotHubResourceGetEndpointHealthNextOptionalParams	Parâmetros opcionais.
IotHubResourceGetEndpointHealthOptionalParams	Parâmetros opcionais.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Parâmetros opcionais.
IotHubResourceGetJobOptionalParams	Parâmetros opcionais.
IotHubResourceGetKeysForKeyNameOptionalParams	Parâmetros opcionais.
IotHubResourceGetOptionalParams	Parâmetros opcionais.
IotHubResourceGetQuotaMetricsNextOptionalParams	Parâmetros opcionais.
IotHubResourceGetQuotaMetricsOptionalParams	Parâmetros opcionais.
IotHubResourceGetStatsOptionalParams	Parâmetros opcionais.
IotHubResourceGetValidSkusNextOptionalParams	Parâmetros opcionais.
IotHubResourceGetValidSkusOptionalParams	Parâmetros opcionais.
IotHubResourceImportDevicesOptionalParams	Parâmetros opcionais.
IotHubResourceListByResourceGroupNextOptionalParams	Parâmetros opcionais.
IotHubResourceListByResourceGroupOptionalParams	Parâmetros opcionais.
IotHubResourceListBySubscriptionNextOptionalParams	Parâmetros opcionais.
IotHubResourceListBySubscriptionOptionalParams	Parâmetros opcionais.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Parâmetros opcionais.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Parâmetros opcionais.
IotHubResourceListJobsNextOptionalParams	Parâmetros opcionais.
IotHubResourceListJobsOptionalParams	Parâmetros opcionais.
IotHubResourceListKeysNextOptionalParams	Parâmetros opcionais.
IotHubResourceListKeysOptionalParams	Parâmetros opcionais.
IotHubResourceTestAllRoutesOptionalParams	Parâmetros opcionais.
IotHubResourceTestRouteOptionalParams	Parâmetros opcionais.
IotHubResourceUpdateOptionalParams	Parâmetros opcionais.
IotHubSkuDescription	Propriedades de SKU.
IotHubSkuDescriptionListResult	A matriz serializada por JSON de objetos IotHubSkuDescription com um próximo link.
IotHubSkuInfo	Informações sobre a SKU do hub IoT.
IpFilterRule	As regras de filtro IP para o hub IoT.
JobResponse	As propriedades do objeto Job Response.
JobResponseListResult	A matriz serializada por JSON de objetos JobResponse com um próximo link.
ManagedIdentity	As propriedades da identidade gerenciada.
MatchedRoute	Rotas correspondentes
MessagingEndpointProperties	As propriedades dos pontos de extremidade de mensagens usados por esse Hub IoT.
Name	Nome do tipo hub IoT
NetworkRuleSetIpRule	Regra de IP a ser aplicada como parte do conjunto de regras de rede
NetworkRuleSetProperties	Propriedades do conjunto de regras de rede do IotHub
Operation	Hub IoT operação da API REST
OperationDisplay	O objeto que representa a operação.
OperationInputs	Valores de entrada.
OperationListResult	Resultado da solicitação para listar Hub IoT operações. Ele contém uma lista de operações e um link de URL para obter o próximo conjunto de resultados.
Operations	Interface que representa operações.
OperationsListNextOptionalParams	Parâmetros opcionais.
OperationsListOptionalParams	Parâmetros opcionais.
PrivateEndpoint	A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado
PrivateEndpointConnection	A conexão de ponto de extremidade privado de um IotHub
PrivateEndpointConnectionProperties	As propriedades de uma conexão de ponto de extremidade privado
PrivateEndpointConnections	Interface que representa um PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Define cabeçalhos para PrivateEndpointConnections_delete operação.
PrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsListOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsUpdateOptionalParams	Parâmetros opcionais.
PrivateLinkResources	Os recursos de link privado disponíveis para um IotHub
PrivateLinkResourcesGetOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesListOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesOperations	Interface que representa um PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	O estado atual de uma conexão de ponto de extremidade privado
RegistryStatistics	Estatísticas do registro de identidade.
Resource	As propriedades comuns de um recurso do Azure.
ResourceProviderCommon	Interface que representa um ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Parâmetros opcionais.
RouteCompilationError	Erro de compilação ao avaliar a rota
RouteErrorPosition	Posição em que o erro de rota ocorreu
RouteErrorRange	Intervalo de erros de rota
RouteProperties	As propriedades de uma regra de roteamento que o hub IoT usa para rotear mensagens para pontos de extremidade.
RoutingCosmosDBSqlApiProperties	As propriedades relacionadas a um ponto de extremidade de contêiner sql do Cosmos DB.
RoutingEndpoints	As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.
RoutingEventHubProperties	As propriedades relacionadas a um ponto de extremidade do hub de eventos.
RoutingMessage	Mensagem de roteamento
RoutingProperties	As propriedades relacionadas ao roteamento do Hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	As propriedades relacionadas aos tipos de ponto de extremidade da fila do barramento de serviço.
RoutingServiceBusTopicEndpointProperties	As propriedades relacionadas aos tipos de ponto de extremidade do tópico do barramento de serviço.
RoutingStorageContainerProperties	As propriedades relacionadas a um ponto de extremidade de contêiner de armazenamento.
RoutingTwin	Parâmetro de entrada de referência de gêmeo. Esse é um parâmetro opcional
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	As propriedades de uma política de acesso compartilhado do Hub IoT.
SharedAccessSignatureAuthorizationRuleListResult	A lista de políticas de acesso compartilhado com um próximo link.
StorageEndpointProperties	As propriedades do ponto de extremidade do Armazenamento do Azure para upload de arquivo.
SystemData	Metadados relativos à criação e à última modificação do recurso.
TagsResource	Um contêiner que contém apenas as Marcas de um recurso, permitindo que o usuário atualize as marcas em uma instância de Hub IoT.
TestAllRoutesInput	Entrada para testar todas as rotas
TestAllRoutesResult	Resultado do teste de todas as rotas
TestRouteInput	Entrada para testar a rota
TestRouteResult	Resultado do teste de uma rota
TestRouteResultDetails	Resultado detalhado do teste de uma rota
UserSubscriptionQuota	Resposta de cota de assinatura do usuário
UserSubscriptionQuotaListResult	Matriz serializada em Json da resposta de cota de assinatura do usuário

Aliases de tipo

AccessRights	Define valores para AccessRights.
AuthenticationType	Define valores para AuthenticationType. KnownAuthenticationType pode ser usado de forma intercambiável com AuthenticationType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço keyBased identityBased
Capabilities	Define valores para Funcionalidades. KnownCapabilities pode ser usado de forma intercambiável com Funcionalidades. Essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhuma DeviceManagement
CertificatesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Contém dados de resposta para a operação generateVerificationCode.
CertificatesGetResponse	Contém dados de resposta para a operação get.
CertificatesListByIotHubResponse	Contém dados de resposta para a operação listByIotHub.
CertificatesVerifyResponse	Contém dados de resposta para a operação de verificação.
CreatedByType	Define valores para CreatedByType. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Usuário Aplicativo ManagedIdentity Chave
DefaultAction	Define valores para DefaultAction. KnownDefaultAction pode ser usado de forma intercambiável com DefaultAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Deny Permitir
EndpointHealthStatus	Define valores para EndpointHealthStatus. KnownEndpointHealthStatus pode ser usado de forma intercambiável com EndpointHealthStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Desconhecido Saudável Degradado Insalubre inativo
IotHubNameUnavailabilityReason	Define valores para IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Define valores para IotHubReplicaRoleType. KnownIotHubReplicaRoleType pode ser usado de forma intercambiável com IotHubReplicaRoleType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Primária Secundário
IotHubResourceCheckNameAvailabilityResponse	Contém dados de resposta para a operação checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Contém dados de resposta para a operação createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
IotHubResourceDeleteResponse	Contém dados de resposta para a operação de exclusão.
IotHubResourceExportDevicesResponse	Contém dados de resposta para a operação exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Contém dados de resposta para a operação getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Contém dados de resposta para a operação getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Contém dados de resposta para a operação getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Contém dados de resposta para a operação getJob.
IotHubResourceGetKeysForKeyNameResponse	Contém dados de resposta para a operação getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Contém dados de resposta para a operação getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Contém dados de resposta para a operação getQuotaMetrics.
IotHubResourceGetResponse	Contém dados de resposta para a operação get.
IotHubResourceGetStatsResponse	Contém dados de resposta para a operação getStats.
IotHubResourceGetValidSkusNextResponse	Contém dados de resposta para a operação getValidSkusNext.
IotHubResourceGetValidSkusResponse	Contém dados de resposta para a operação getValidSkus.
IotHubResourceImportDevicesResponse	Contém dados de resposta para a operação importDevices.
IotHubResourceListByResourceGroupNextResponse	Contém dados de resposta para a operação listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Contém dados de resposta para a operação listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Contém dados de resposta para a operação listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Contém dados de resposta para a operação listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Contém dados de resposta para a operação listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Contém dados de resposta para a operação listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Contém dados de resposta para a operação listJobsNext.
IotHubResourceListJobsResponse	Contém dados de resposta para a operação listJobs.
IotHubResourceListKeysNextResponse	Contém dados de resposta para a operação listKeysNext.
IotHubResourceListKeysResponse	Contém dados de resposta para a operação listKeys.
IotHubResourceTestAllRoutesResponse	Contém dados de resposta para a operação testAllRoutes.
IotHubResourceTestRouteResponse	Contém dados de resposta para a operação testRoute.
IotHubResourceUpdateResponse	Contém dados de resposta para a operação de atualização.
IotHubScaleType	Define valores para IotHubScaleType.
IotHubSku	Define valores para IotHubSku. KnownIotHubSku pode ser usado de forma intercambiável com IotHubSku, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Define valores para IotHubSkuTier.
IpFilterActionType	Define valores para IpFilterActionType.
JobStatus	Define valores para JobStatus.
JobType	Define valores para JobType. KnownJobType pode ser usado de forma intercambiável com JobType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Desconhecido export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Define valores para NetworkRuleIPAction. KnownNetworkRuleIPAction pode ser usado de forma intercambiável com NetworkRuleIPAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Permitir
OperationsListNextResponse	Contém dados de resposta para a operação listNext.
OperationsListResponse	Contém dados de resposta para a operação de lista.
PrivateEndpointConnectionsDeleteResponse	Contém dados de resposta para a operação de exclusão.
PrivateEndpointConnectionsGetResponse	Contém dados de resposta para a operação get.
PrivateEndpointConnectionsListResponse	Contém dados de resposta para a operação de lista.
PrivateEndpointConnectionsUpdateResponse	Contém dados de resposta para a operação de atualização.
PrivateLinkResourcesGetResponse	Contém dados de resposta para a operação get.
PrivateLinkResourcesListResponse	Contém dados de resposta para a operação de lista.
PrivateLinkServiceConnectionStatus	Define valores para PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus pode ser usado de forma intercambiável com PrivateLinkServiceConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Pendente Aprovado Rejeitado Desconectado
PublicNetworkAccess	Define valores para PublicNetworkAccess. KnownPublicNetworkAccess pode ser usado de forma intercambiável com PublicNetworkAccess, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Enabled Desabilitado
ResourceIdentityType	Define valores para ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Contém dados de resposta para a operação getSubscriptionQuota.
RouteErrorSeverity	Define valores para RouteErrorSeverity. KnownRouteErrorSeverity pode ser usado de forma intercambiável com RouteErrorSeverity, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço error warning
RoutingSource	Define valores para RoutingSource. KnownRoutingSource pode ser usado de forma intercambiável com RoutingSource, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Inválido DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Define valores para RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding pode ser usado de forma intercambiável com RoutingStorageContainerPropertiesEncoding. Essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Avro AvroDeflate JSON
TestResultStatus	Define valores para TestResultStatus. KnownTestResultStatus pode ser usado de forma intercambiável com TestResultStatus. Essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço não definido false true

Enumerações

KnownAuthenticationType	Valores conhecidos de AuthenticationType que o serviço aceita.
KnownCapabilities	Valores conhecidos de Funcionalidades que o serviço aceita.
KnownCreatedByType	Valores conhecidos de CreatedByType que o serviço aceita.
KnownDefaultAction	Valores conhecidos de DefaultAction que o serviço aceita.
KnownEndpointHealthStatus	Valores conhecidos de EndpointHealthStatus que o serviço aceita.
KnownIotHubReplicaRoleType	Valores conhecidos de IotHubReplicaRoleType que o serviço aceita.
KnownIotHubSku	Valores conhecidos de IotHubSku que o serviço aceita.
KnownJobType	Valores conhecidos de JobType que o serviço aceita.
KnownNetworkRuleIPAction	Valores conhecidos de NetworkRuleIPAction que o serviço aceita.
KnownPrivateLinkServiceConnectionStatus	Valores conhecidos de PrivateLinkServiceConnectionStatus que o serviço aceita.
KnownPublicNetworkAccess	Valores conhecidos de PublicNetworkAccess que o serviço aceita.
KnownRouteErrorSeverity	Valores conhecidos de RouteErrorSeverity que o serviço aceita.
KnownRoutingSource	Valores conhecidos de RoutingSource que o serviço aceita.
KnownRoutingStorageContainerPropertiesEncoding	Valores conhecidos de RoutingStorageContainerPropertiesEncoding que o serviço aceita.
KnownTestResultStatus	Valores conhecidos de TestResultStatus que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acesso value no IteratorResult de um byPage iterador.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.