@azure/arm-iothub package

Classes

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	O Certificado X509 serializado JSON.
CertificateDescription	O Certificado X509.
CertificateListDescription	A matriz serializada JSON de objetos de Certificado.
CertificateProperties	A descrição de um Certificado de AC X509.
CertificatePropertiesWithNonce	A descrição de um Certificado de AC X509, incluindo o nonce de desafio emitido para o fluxo Prova de Posse.
CertificateVerificationDescription	O certificado de folha serializado 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 de cloud para dispositivo do hub IoT.
EndpointHealthData	Os dados de estado de funcionamento de um ponto final
EndpointHealthDataListResult	A matriz serializada JSON de objetos EndpointHealthData com uma ligação seguinte.
EnrichmentProperties	As propriedades de um melhoramento que o hub IoT aplica às mensagens entregues aos pontos finais.
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 JSON de nomes de grupos de consumidores compatíveis com o Hub de Eventos com uma ligação seguinte.
EventHubProperties	As propriedades do ponto final compatível com o Hub de Eventos aprovisionado utilizado pelo hub IoT.
ExportDevicesRequest	Utilize para fornecer parâmetros ao pedir uma exportação de todos os dispositivos no hub IoT.
FailoverInput	Utilize para fornecer a região de ativação pós-falha ao pedir a Ativação Pós-falha manual para um hub.
FallbackRouteProperties	As propriedades da rota de contingência. Hub IoT utiliza estas propriedades quando encaminha mensagens para o ponto final de contingência.
FeedbackProperties	As propriedades da fila de comentários para mensagens da cloud para o dispositivo.
GroupIdInformation	As informações de grupo para criar um ponto final privado num IotHub
GroupIdInformationProperties	As propriedades de um objeto de informações de grupo
ImportDevicesRequest	Utilize para fornecer parâmetros ao pedir 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 JSON de objetos IotHubDescription com uma ligação seguinte.
IotHubLocationDescription	Representação pública de uma das localizações onde um recurso é aprovisionado.
IotHubManualFailoverHeaders	Define cabeçalhos para IotHub_manualFailover operação.
IotHubManualFailoverOptionalParams	Parâmetros opcionais.
IotHubNameAvailabilityInfo	As propriedades que indicam se um determinado nome do hub IoT está disponível.
IotHubProperties	As propriedades de um hub IoT.
IotHubQuotaMetricInfo	Propriedades de métricas de quota.
IotHubQuotaMetricInfoListResult	A matriz serializada JSON de objetos IotHubQuotaMetricInfo com uma ligação seguinte.
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 do SKU.
IotHubSkuDescriptionListResult	A matriz serializada JSON de objetos IotHubSkuDescription com uma ligação seguinte.
IotHubSkuInfo	Informações sobre o SKU do hub IoT.
IpFilterRule	As regras de filtro ip do hub IoT.
JobResponse	As propriedades do objeto Resposta a Tarefas.
JobResponseListResult	A matriz serializada JSON de objetos JobResponse com uma ligação seguinte.
ManagedIdentity	As propriedades da identidade gerida.
MatchedRoute	Rotas correspondentes
MessagingEndpointProperties	As propriedades dos pontos finais de mensagens utilizados por este hub IoT.
Name	Nome do tipo hub Iot
NetworkRuleSetIpRule	Regra de IP a aplicar 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 do pedido para listar Hub IoT operações. Contém uma lista de operações e uma ligação de URL para obter o próximo conjunto de resultados.
Operations	Interface que representa uma Operação.
OperationsListNextOptionalParams	Parâmetros opcionais.
OperationsListOptionalParams	Parâmetros opcionais.
PrivateEndpoint	A propriedade de ponto final privado de uma ligação de ponto final privado
PrivateEndpointConnection	A ligação de ponto final privado de um IotHub
PrivateEndpointConnectionProperties	As propriedades de uma ligação de ponto final 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 ligação privada disponíveis para um IotHub
PrivateLinkResourcesGetOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesListOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesOperations	Interface que representa uma PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	O estado atual de uma ligação de ponto final privado
RegistryStatistics	Estatísticas do registo 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 onde ocorreu o erro de rota
RouteErrorRange	Intervalo de erros de rota
RouteProperties	As propriedades de uma regra de encaminhamento que o seu hub IoT utiliza para encaminhar mensagens para pontos finais.
RoutingCosmosDBSqlApiProperties	As propriedades relacionadas com um ponto final de contentor sql do cosmos DB.
RoutingEndpoints	As propriedades relacionadas com os pontos finais personalizados para os quais o seu hub IoT encaminha mensagens com base nas regras de encaminhamento. Um máximo de 10 pontos finais personalizados são permitidos em todos os tipos de pontos finais para hubs pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para hubs gratuitos.
RoutingEventHubProperties	As propriedades relacionadas com um ponto final do hub de eventos.
RoutingMessage	Mensagem de encaminhamento
RoutingProperties	As propriedades relacionadas com o encaminhamento do hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	As propriedades relacionadas com os tipos de ponto final da fila do service bus.
RoutingServiceBusTopicEndpointProperties	As propriedades relacionadas com os tipos de ponto final do tópico do service bus.
RoutingStorageContainerProperties	As propriedades relacionadas com um ponto final de contentor de armazenamento.
RoutingTwin	Parâmetro de entrada de referência de duplos. Este é um parâmetro opcional
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	As propriedades de uma política de acesso partilhado do hub IoT.
SharedAccessSignatureAuthorizationRuleListResult	A lista de políticas de acesso partilhado com uma ligação seguinte.
StorageEndpointProperties	As propriedades do ponto final do Armazenamento do Azure para carregamento de ficheiros.
SystemData	Metadados relativos à criação e última modificação do recurso.
TagsResource	Um contentor que contém apenas as Etiquetas de um recurso, permitindo ao utilizador atualizar as etiquetas numa instância de Hub IoT.
TestAllRoutesInput	Entrada para testar todas as rotas
TestAllRoutesResult	Resultado do teste de todas as rotas
TestRouteInput	Entrada para a rota de teste
TestRouteResult	Resultado do teste de uma rota
TestRouteResultDetails	Resultado detalhado do teste de uma rota
UserSubscriptionQuota	Resposta da quota de subscrição do utilizador
UserSubscriptionQuotaListResult	Matriz serializada por Json da resposta de quota de subscrição de utilizador

Aliases de Tipo

AccessRights	Define valores para AccessRights.
AuthenticationType	Define valores para AuthenticationType. KnownAuthenticationType pode ser utilizado alternadamente com AuthenticationType. Este enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço keyBased identityBased
Capabilities	Define valores para Capacidades. KnownCapabilities pode ser utilizado alternadamente com Capacidades. Esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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 utilizado alternadamente com CreatedByType, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Utilizador Aplicação ManagedIdentity Chave
DefaultAction	Define valores para DefaultAction. KnownDefaultAction pode ser utilizado alternadamente com DefaultAction, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Negar Permitir
EndpointHealthStatus	Define valores para EndpointHealthStatus. KnownEndpointHealthStatus pode ser utilizado alternadamente com EndpointHealthStatus. Este enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço desconhecido bom estado de funcionamento degradado mau estado de funcionamento morto
IotHubNameUnavailabilityReason	Define valores para IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Define valores para IotHubReplicaRoleType. KnownIotHubReplicaRoleType pode ser utilizado alternadamente com iotHubReplicaRoleType, esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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 eliminaçã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. O KnownIotHubSku pode ser utilizado alternadamente com o IotHubSku. Esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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 utilizado alternadamente com JobType. Este enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço desconhecido exportar importar cópia de segurança readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Define valores para NetworkRuleIPAction. KnownNetworkRuleIPAction pode ser utilizado alternadamente com NetworkRuleIPAction. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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 eliminaçã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 utilizado alternadamente com PrivateLinkServiceConnectionStatus. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Pendente Aprovado Rejeitado Desligado
PublicNetworkAccess	Define valores para PublicNetworkAccess. KnownPublicNetworkAccess pode ser utilizado alternadamente com PublicNetworkAccess. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Ativado Desativado
ResourceIdentityType	Define valores para ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Contém dados de resposta para a operação getSubscriptionQuota.
RouteErrorSeverity	Define valores para RouteErrorSeverity. KnownRouteErrorSeverity pode ser utilizado alternadamente com RouteErrorSeverity. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço erro aviso
RoutingSource	Define valores para RoutingSource. O KnownRoutingSource pode ser utilizado alternadamente com o RoutingSource. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Inválido DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Define valores para RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding pode ser utilizado alternadamente com RoutingStorageContainerPropertiesEncoding. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Avro MédiaDefinir JSON
TestResultStatus	Define valores para TestResultStatus. KnownTestResultStatus pode ser utilizado alternadamente com TestResultStatus. Esta enumeração contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço indefinido falso verdadeiro

Enumerações

KnownAuthenticationType	Valores conhecidos de AuthenticationType que o serviço aceita.
KnownCapabilities	Valores conhecidos das Capacidades 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 do 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, devolve um token de continuação que pode ser utilizado para começar a paginação a partir desse ponto mais tarde.

Detalhes de Função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, devolve um token de continuação que pode ser utilizado para começar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

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

Devoluções

string | undefined

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