Partilhar via


@azure/arm-iothub package

Classes

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription

O certificado X509 serializado por JSON.

CertificateDescription

O certificado X509.

CertificateListDescription

A matriz serializada 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 desafio nonce emitido para o fluxo deOf-Possession de prova.

CertificateVerificationDescription

O certificado de folha serializado por JSON

CertificateWithNonceDescription

O certificado X509.

Certificates

Interface que representa um Certificado.

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 nuvem para dispositivo do hub IoT.

EndpointHealthData

Os dados de integridade de um ponto de extremidade

EndpointHealthDataListResult

A matriz serializada por 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 por JSON de nomes de grupos 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 região de failover ao solicitar failover manual para um hub.

FallbackRouteProperties

As propriedades da rota de fallback. O 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

Informações sobre a capacidade do Hub IoT.

IotHubClientOptionalParams

Parâmetros opcionais.

IotHubDescription

A descrição do hub IoT.

IotHubDescriptionListResult

A matriz serializada JSON de objetos IotHubDescription com um próximo link.

IotHubLocationDescription

Representação pública de um dos locais onde 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 por 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 JSON de objetos IotHubSkuDescription com um próximo link.

IotHubSkuInfo

Informações sobre o 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 JSON de objetos JobResponse com um próximo link.

ManagedIdentity

As propriedades da identidade gerenciada.

MatchedRoute

Rotas que corresponderam

MessagingEndpointProperties

As propriedades dos pontos de extremidade de mensagens usados por esse hub IoT.

Name

Nome do tipo de Hub Iot

NetworkRuleSetIpRule

Regra IP a ser aplicada como parte do Conjunto de Regras de Rede

NetworkRuleSetProperties

Propriedades do conjunto de regras de rede do IotHub

Operation

Operação da API REST do Hub IoT

OperationDisplay

O objeto que representa a operação.

OperationInputs

Valores de entrada.

OperationListResult

Resultado da solicitação para listar operações do Hub IoT. 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 uma Operação.

OperationsListNextOptionalParams

Parâmetros opcionais.

OperationsListOptionalParams

Parâmetros opcionais.

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um IotHub

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privada

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 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 o erro de rota aconteceu

RouteErrorRange

Gama de erros de rota

RouteProperties

As propriedades de uma regra de roteamento que seu 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 seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 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. Veja: 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 de 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 dupla. Este é 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 carregamento de arquivos.

SystemData

Metadados referentes à criação e última modificação do recurso.

TagsResource

Um contêiner que contém apenas as Tags de um recurso, permitindo que o usuário atualize as tags em uma instância do Hub IoT.

TestAllRoutesInput

Entrada para testar todas as rotas

TestAllRoutesResult

Resultado do teste de todas as rotas

TestRouteInput

Entrada para 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 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

keyBased
identityBased

Capabilities

Define valores para Capacidades.
KnownCapabilities pode ser usado de forma intercambiável com Capabilities, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Nenhum
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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

do Utilizador
Application
ManagedIdentity
Key

DefaultAction

Define valores para DefaultAction.
KnownDefaultAction pode ser usado de forma intercambiável com DefaultAction, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Negar
Permitir

EndpointHealthStatus

Define valores para EndpointHealthStatus.
KnownEndpointHealthStatus pode ser usado de forma intercambiável com EndpointHealthStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

desconhecido
saudável
degradado
insalubre
mortos

IotHubNameUnavailabilityReason

Define valores para IotHubNameUnavailabilityReason.

IotHubReplicaRoleType

Define valores para IotHubReplicaRoleType.
KnownIotHubReplicaRoleType pode ser usado de forma intercambiável com IotHubReplicaRoleType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

primária
secundária

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.
o KnownIotHubSku pode ser usado de forma intercambiável com o IotHubSku, esse 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 usado de forma intercambiável com JobType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

desconhecido
de exportação
importar
backup
readDeviceProperties
writeDeviceProperties
updateDeviceConfiguration
rebootDevice
factoryResetDevice
firmwareAtualizar

NetworkRuleIPAction

Define valores para NetworkRuleIPAction.
KnownNetworkRuleIPAction pode ser usado de forma intercambiável com NetworkRuleIPAction, esse enum contém os valores conhecidos que o serviço suporta.

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 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

pendente
Aprovado
Rejeitado
Desconectado

PublicNetworkAccess

Define valores para PublicNetworkAccess.
KnownPublicNetworkAccess pode ser usado de forma intercambiável com PublicNetworkAccess, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ativado
Deficientes

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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

erro
de advertência

RoutingSource

Define valores para RoutingSource.
KnownRoutingSource pode ser usado de forma intercambiável com RoutingSource, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

inválido
DeviceMessages
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DeviceConnectionStateEvents

RoutingStorageContainerPropertiesEncoding

Define valores para RoutingStorageContainerPropertiesEncoding.
KnownRoutingStorageContainerPropertiesEncoding pode ser usado de forma intercambiável com RoutingStorageContainerPropertiesEncoding, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Avro
AvroDeflate
JSON

TestResultStatus

Define valores para TestResultStatus.
KnownTestResultStatus pode ser usado de forma intercambiável com TestResultStatus, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

indefinido
falso
verdadeiro

Enumerações

KnownAuthenticationType

Os valores conhecidos de AuthenticationType que o serviço aceita.

KnownCapabilities

Os valores conhecidos de Capabilities que o serviço aceita.

KnownCreatedByType

Os valores conhecidos de CreatedByType que o serviço aceita.

KnownDefaultAction

Os valores conhecidos de DefaultAction que o serviço aceita.

KnownEndpointHealthStatus

Os valores conhecidos de EndpointHealthStatus que o serviço aceita.

KnownIotHubReplicaRoleType

Os valores conhecidos de IotHubReplicaRoleType que o serviço aceita.

KnownIotHubSku

Os valores conhecidos de IotHubSku que o serviço aceita.

KnownJobType

Os valores conhecidos de JobType que o serviço aceita.

KnownNetworkRuleIPAction

Os valores conhecidos de NetworkRuleIPAction que o serviço aceita.

KnownPrivateLinkServiceConnectionStatus

Os valores conhecidos de PrivateLinkServiceConnectionStatus que o serviço aceita.

KnownPublicNetworkAccess

Os valores conhecidos de PublicNetworkAccess que o serviço aceita.

KnownRouteErrorSeverity

Os valores conhecidos de RouteErrorSeverity que o serviço aceita.

KnownRoutingSource

Os valores conhecidos de RoutingSource que o serviço aceita.

KnownRoutingStorageContainerPropertiesEncoding

Os valores conhecidos de RoutingStorageContainerPropertiesEncoding que o serviço aceita.

KnownTestResultStatus

Os valores conhecidos de TestResultStatus que o serviço aceita.

Funções

getContinuationToken(unknown)

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

Detalhes de Função

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

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

Devoluções

string | undefined

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