IotHubProperties interface

  • Referência
Pacote:
@azure/arm-iothub

As propriedades de um hub IoT.

Propriedades

allowedFqdnList

Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.
authorizationPolicies

As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT.
cloudToDevice

As propriedades de mensagens de nuvem para dispositivo do Hub IoT.
comments

Comentários do Hub IoT.
disableDeviceSAS

Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.
disableLocalAuth

Se for true, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação.
disableModuleSAS

Se for true, todas as chaves SAS no escopo do módulo não poderão ser usadas para autenticação.
enableDataResidency

Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre.
enableFileUploadNotifications

Se True, as notificações de upload de arquivo serão habilitadas.
eventHubEndpoints

As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave precisa estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT.
features

Os recursos e recursos habilitados para o Hub IoT.
hostName

O nome do host. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
ipFilterRules

As regras de filtro IP.
locations

Local primário e secundário para o hub iot OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
messagingEndpoints

As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo.
minTlsVersion

Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão do TLS abaixo da 1.2 sejam rejeitados.
networkRuleSets

Propriedades do conjunto de regras de rede do IotHub
privateEndpointConnections

Conexões de ponto de extremidade privado criadas neste IotHub
provisioningState

O estado de provisionamento. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicNetworkAccess

Se as solicitações da Rede Pública são permitidas
restrictOutboundNetworkAccess

Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.
routing

As propriedades relacionadas ao roteamento do hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state

O estado do hub. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
storageEndpoints

A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado.

Detalhes da propriedade

allowedFqdnList

Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.

allowedFqdnList?: string[]

Valor da propriedade

string[]

authorizationPolicies

As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT.

authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]

Valor da propriedade

SharedAccessSignatureAuthorizationRule[]

cloudToDevice

As propriedades de mensagens de nuvem para dispositivo do Hub IoT.

cloudToDevice?: CloudToDeviceProperties

Valor da propriedade

CloudToDeviceProperties

comments

Comentários do Hub IoT.

comments?: string

Valor da propriedade

string

disableDeviceSAS

Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.

disableDeviceSAS?: boolean

Valor da propriedade

boolean

disableLocalAuth

Se for true, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação.

disableLocalAuth?: boolean

Valor da propriedade

boolean

disableModuleSAS

Se for true, todas as chaves SAS no escopo do módulo não poderão ser usadas para autenticação.

disableModuleSAS?: boolean

Valor da propriedade

boolean

enableDataResidency

Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre.

enableDataResidency?: boolean

Valor da propriedade

boolean

enableFileUploadNotifications

Se True, as notificações de upload de arquivo serão habilitadas.

enableFileUploadNotifications?: boolean

Valor da propriedade

boolean

eventHubEndpoints

As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave precisa estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT.

eventHubEndpoints?: {[propertyName: string]: EventHubProperties}

Valor da propriedade

{[propertyName: string]: EventHubProperties}

features

Os recursos e recursos habilitados para o Hub IoT.

features?: string

Valor da propriedade

string

hostName

O nome do host. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

hostName?: string

Valor da propriedade

string

ipFilterRules

As regras de filtro IP.

ipFilterRules?: IpFilterRule[]

Valor da propriedade

IpFilterRule[]

locations

Local primário e secundário para o hub iot OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

locations?: IotHubLocationDescription[]

Valor da propriedade

IotHubLocationDescription[]

messagingEndpoints

As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo.

messagingEndpoints?: {[propertyName: string]: MessagingEndpointProperties}

Valor da propriedade

{[propertyName: string]: MessagingEndpointProperties}

minTlsVersion

Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão do TLS abaixo da 1.2 sejam rejeitados.

minTlsVersion?: string

Valor da propriedade

string

networkRuleSets

Propriedades do conjunto de regras de rede do IotHub

networkRuleSets?: NetworkRuleSetProperties

Valor da propriedade

NetworkRuleSetProperties

privateEndpointConnections

Conexões de ponto de extremidade privado criadas neste IotHub

privateEndpointConnections?: PrivateEndpointConnection[]

Valor da propriedade

PrivateEndpointConnection[]

provisioningState

O estado de provisionamento. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor da propriedade

string

publicNetworkAccess

Se as solicitações da Rede Pública são permitidas

publicNetworkAccess?: string

Valor da propriedade

string

restrictOutboundNetworkAccess

Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.

restrictOutboundNetworkAccess?: boolean

Valor da propriedade

boolean

routing

As propriedades relacionadas ao roteamento do hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

routing?: RoutingProperties

Valor da propriedade

RoutingProperties

state

O estado do hub. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

state?: string

Valor da propriedade

string

storageEndpoints

A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado.

storageEndpoints?: {[propertyName: string]: StorageEndpointProperties}

Valor da propriedade

{[propertyName: string]: StorageEndpointProperties}