Microsoft.Devices IotHubs

Artigo
04/11/2024

Definição de recurso do Bicep

O tipo de recurso IotHubs pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'Allow'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            partitionKeyName: 'string'
            partitionKeyTemplate: 'string'
            primaryKey: 'string'
            resourceGroup: 'string'
            secondaryKey: 'string'
            subscriptionId: 'string'
          }
        ]
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
}

Valores de propriedade

IotHubs

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-50 Carateres válidos: Alfanuméricos e hífenes. Não é possível terminar com hífen. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A localização do recurso.	cadeia (obrigatório)
etiquetas	As etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku	Informações do SKU do IotHub	IotHubSkuInfo (obrigatório)
etag	O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	string
identidade	As identidades geridas do IotHub.	ArmIdentity
propriedades	Propriedades do IotHub	IotHubProperties

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.	"Nenhum" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
userAssignedIdentities	Dicionário de {ArmUserIdentity}	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		ArmUserIdentity

ArmUserIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Completamente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso partilhado que pode utilizar para proteger uma ligação ao hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens da cloud para o dispositivo do hub IoT.	CloudToDeviceProperties
comentários	Comentários do hub IoT.	string
disableDeviceSAS	Se for verdadeiro, não é possível utilizar todas as chaves SAS no âmbito de dispositivos (incluindo dispositivos Edge, mas excluindo módulos) para autenticação.	bool
disableLocalAuth	Se for verdadeiro, os tokens de SAS com chaves SAS no âmbito do hub Iot não podem ser utilizados para autenticação.	bool
disableModuleSAS	Se for verdadeiro, todas as chaves SAS no âmbito do módulo não podem ser utilizadas para autenticação.	bool
enableDataResidency	Esta propriedade, quando definida como verdadeira, ativará a residência dos dados, desativando assim a recuperação após desastre.	bool
enableFileUploadNotifications	Se for Verdadeiro, as notificações de carregamento de ficheiros estão ativadas.	bool
eventHubEndpoints	As propriedades do ponto final compatível com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Esta chave tem de estar presente no dicionário ao criar ou atualizar chamadas para o hub IoT.	IotHubPropertiesEventHubEndpoints
funcionalidades	As capacidades e funcionalidades ativadas para o hub IoT.	"DeviceManagement" "Nenhum"
ipFilterRules	As regras de filtro de IP.	IpFilterRule[]
messagingEndpoints	As propriedades do ponto final de mensagens para a fila de notificação de carregamento de ficheiros.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS a suportar para este hub. Pode ser definido como "1.2" para que os clientes que utilizam uma versão do TLS abaixo da 1.2 sejam rejeitados.	string
networkRuleSets	Propriedades do Conjunto de Regras de Rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Ligações de ponto final privado criadas neste IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Se os pedidos da Rede Pública são permitidos	"Desativado" "Ativado"
restrictOutboundNetworkAccess	Se for verdadeiro, a saída do IotHub será restringida apenas aos FQDNs permitidos que estão configurados através de allowedFqdnList.	bool
encaminhamento	As propriedades relacionadas com o encaminhamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos finais do Armazenamento do Azure onde pode carregar ficheiros. Atualmente, só pode configurar uma conta de Armazenamento do Azure e esta tem de ter a respetiva chave como $default. Especificar mais do que uma conta de armazenamento causa um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications estiver definida como Verdadeiro, faz com que seja gerado um erro.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	A hora predefinida para as mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	As propriedades da fila de comentários para mensagens da cloud para o dispositivo.	FeedbackProperties
maxDeliveryCount	A contagem máxima de entrega para mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100

FeedbackProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor
{customized property}		EventHubProperties

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a cloud no ponto final compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	int
retentionTimeInDays	O tempo de retenção das mensagens do dispositivo para a cloud em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nome	Descrição	Valor
action	A ação pretendida para pedidos capturados por esta regra.	"Aceitar" "Rejeitar" (obrigatório)
filterName	O nome da regra de filtro IP.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor
{customized property}		MessagingEndpointProperties

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Veja: /azure/iot-hub/iot-hub-devguide-file-upload.	string

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se For Verdadeiro, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub	bool (obrigatório)
defaultAction	Ação Predefinida para Conjunto de Regras de Rede	"Permitir" "Negar"
ipRules	Lista de Regras de IP	NetworkRuleSetIpRule[] (obrigatório)

NetworkRuleSetIpRule

Nome	Descrição	Valor
action	Ação de Filtro ip	"Permitir"
filterName	Nome da regra de filtro ip.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

PrivateEndpointConnection

Nome	Descrição	Valor
propriedades	As propriedades de uma ligação de ponto final privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Nome	Descrição	Valor
privateEndpoint	A propriedade de ponto final privado de uma ligação de ponto final privado	PrivateEndpoint
privateLinkServiceConnectionState	O estado atual de uma ligação de ponto final privado	PrivateLinkServiceConnectionState (obrigatório)

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma ligação de ponto final privado	string
descrição	A descrição do estado atual de uma ligação de ponto final privado	cadeia (obrigatório)
status	O estado de uma ligação de ponto final privado	"Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório)

RoutingProperties

Nome	Descrição	Valor
pontos finais	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.	RoutingEndpoints
melhoramentos	A lista de melhoramentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a serem entregues em pontos finais incorporados e personalizados. Veja: `https://aka.ms/telemetryoneventgrid`	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é utilizada como uma rota de contingência quando nenhuma das condições especificadas na secção "rotas" é cumprida. Este é um parâmetro opcional. Quando esta propriedade não está presente no modelo, a rota de contingência é desativada por predefinição.	FallbackRouteProperties
rotas	A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. Um máximo de 100 regras de encaminhamento são permitidas para hubs pagos e são permitidas um máximo de 5 regras de encaminhamento para hubs gratuitos.	RouteProperties[]

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos finais de contentor do Cosmos DB para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos finais dos Hubs de Eventos para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento. Esta lista não inclui o ponto final incorporado dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos finais de fila do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos finais do tópico do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos finais de contentor de armazenamento para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.	RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do contentor sql do Cosmos DB	"identityBased" "keyBased"
containerName	O nome do contentor sql do cosmos DB na base de dados cosmos DB.	cadeia (obrigatório)
databaseName	O nome da base de dados cosmos DB na conta do cosmos DB.	cadeia (obrigatório)
endpointUri	O URL da conta do Cosmos DB. Tem de incluir o protocolo `https://`	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
partitionKeyName	O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.	string
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM}, e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.	string
primaryKey	A chave primária da conta do Cosmos DB.	string Restrições: Valor sensível. Transmita como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta cosmos DB.	string
secondaryKey	A chave secundária da conta do Cosmos DB.	string Restrições: Valor sensível. Transmita como um parâmetro seguro.
subscriptionId	O identificador de subscrição da conta do Cosmos DB.	string

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo utilizador.	string

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do hub de eventos	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final do hub de eventos.	string
endpointUri	O URL do ponto final do hub de eventos. Tem de incluir o protocolo sb://	string
entityPath	Nome do hub de eventos no espaço de nomes do hub de eventos	string
ID	ID do ponto final do hub de eventos	string
identidade	Propriedades de identidade gerida do ponto final do hub de eventos de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do hub de eventos.	string
subscriptionId	O identificador de subscrição do ponto final do hub de eventos.	string

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final da fila do service bus	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final da fila do service bus.	string
endpointUri	O URL do ponto final da fila do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no espaço de nomes do service bus	string
ID	ID do ponto final da fila do service bus	string
identidade	Propriedades de identidade gerida do ponto final da fila do service bus de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. O nome não tem de ser o mesmo que o nome da fila real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final da fila do service bus.	string
subscriptionId	O identificador de subscrição do ponto final da fila do service bus.	string

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do tópico do service bus	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final do tópico do service bus.	string
endpointUri	O URL do ponto final do tópico do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no tópico do service bus	string
ID	ID do ponto final do tópico do service bus	string
identidade	Propriedades de identidade gerida do ponto final do tópico do service bus de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. O nome não tem de ser o mesmo que o nome do tópico real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do tópico do service bus.	string
subscriptionId	O identificador de subscrição do ponto final do tópico do service bus.	string

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final de armazenamento	"identityBased" "keyBased"
batchFrequencyInSeconds	Intervalo de tempo em que os blobs são escritos no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de ligação da conta de armazenamento.	string
containerName	O nome do contentor de armazenamento na conta de armazenamento.	cadeia (obrigatório)
codificação	Codificação utilizada para serializar mensagens para blobs. Os valores suportados são "avro", "avrodeflate" e "JSON". O valor predefinido é "avro".	'Avro' "MédiaDefinir" 'JSON'
endpointUri	O URL do ponto final de armazenamento. Tem de incluir o protocolo `https://`	string
fileNameFormat	Formato de nome de ficheiro para o blob. O formato predefinido é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	string
ID	ID do ponto final do contentor de armazenamento	string
identidade	Propriedades de identidade gerida do ponto final de armazenamento de encaminhamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob escrito no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor predefinido é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	string
subscriptionId	O identificador da subscrição da conta de armazenamento.	string

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos finais para os quais o melhoramento é aplicado à mensagem.	string[] (obrigatório) Restrições: Comprimento mínimo = 1
key	A chave ou o nome da propriedade de melhoramento.	cadeia (obrigatório)
valor	O valor da propriedade de melhoramento.	cadeia (obrigatório)

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de contingência. Se a condição não for fornecida, será avaliada como verdadeira por predefinição. Para obter a gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se a rota de contingência está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	string
source	A origem à qual a regra de encaminhamento deve ser aplicada. Por exemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se uma rota está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
source	A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor
{customized property}		StorageEndpointProperties

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.	"identityBased" "keyBased"
connectionString	O cadeia de ligação para a conta de Armazenamento do Azure para a qual os ficheiros são carregados.	cadeia (obrigatório)
containerName	O nome do contentor de raiz onde carrega ficheiros. O contentor não precisa de existir, mas deve ser criável com a connectionString especificada.	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de armazenamento para carregamento de ficheiros.	ManagedIdentity
sasTtlAsIso8601	O período de tempo para o qual o URI de SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

Nome	Descrição	Valor
capacidade	O número de unidades de Hub IoT aprovisionadas. Veja: /azure/azure-subscription-service-limits#iot-hub-limits.	int
name	O nome do SKU.	"B1" 'B2' 'B3' 'F1' 'S1' 'S2' "S3" (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar um Hub IOT e um simulador do Ubuntu Edge	Este modelo cria um hub IOT e um simulador de periferia do Ubuntu da Máquina Virtual.
Utilizar o modelo do ARM para criar Hub IoT, encaminhar e ver mensagens	Utilize este modelo para implementar um Hub IoT e uma conta de armazenamento. Execute uma aplicação para enviar mensagens para o hub que são encaminhadas para o armazenamento e, em seguida, veja os resultados.
Criar um Serviço de Aprovisionamento de Dispositivos Hub IoT	Este modelo permite-lhe criar um hub IoT e um Serviço de Aprovisionamento de Dispositivos Hub IoT e associar os dois serviços.
Criar um Hub IoT e um Dispositivo para o Grupo de Consumidores da Cloud	Este modelo permite-lhe implementar uma instância de Hub IoT com dispositivos na cloud e na cloud para configurações de mensagens de dispositivos e um dispositivo para o grupo de consumidores na cloud.
Criar a Atualização de Dispositivos para Hub IoT conta, instância Hub IoT	Este modelo cria uma conta e uma instância e um hub para ligar a instância. Configura o hub com as políticas, rotas e grupos de consumidores de acesso necessários.
Implementar o serviço MedTech, incluindo um Hub IoT do Azure	O serviço MedTech é um dos Serviços de Dados de Saúde do Azure concebido para ingerir dados de dispositivos a partir de vários dispositivos, transformando os dados do dispositivo em Observações FHIR, que são depois persistentes no serviço FHIR dos Serviços de Dados de Saúde do Azure.
Criar um Ambiente Pay As You Go (PAYG) com um Hub IoT	Este modelo permite-lhe implementar um ambiente pay as you go (PAYG) do Time Series Insights configurado para consumir eventos de um Hub IoT.

Definição de recurso do modelo arm

O tipo de recurso IotHubs pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "partitionKeyName": "string",
            "partitionKeyTemplate": "string",
            "primaryKey": "string",
            "resourceGroup": "string",
            "secondaryKey": "string",
            "subscriptionId": "string"
          }
        ],
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  }
}

Valores de propriedade

IotHubs

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Devices/IotHubs"
apiVersion	A versão da API de recursos	'2023-06-30'
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-50 Carateres válidos: Alfanuméricos e hífenes. Não é possível terminar com hífen. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A localização do recurso.	cadeia (obrigatório)
etiquetas	As etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku	Informações do SKU do IotHub	IotHubSkuInfo (obrigatório)
etag	O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	string
identidade	As identidades geridas do IotHub.	ArmIdentity
propriedades	Propriedades do IotHub	IotHubProperties

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.	"Nenhum" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
userAssignedIdentities	Dicionário de {ArmUserIdentity}	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		ArmUserIdentity

ArmUserIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Completamente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso partilhado que pode utilizar para proteger uma ligação ao hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens da cloud para o dispositivo do hub IoT.	CloudToDeviceProperties
comentários	Comentários do hub IoT.	string
disableDeviceSAS	Se for verdadeiro, não é possível utilizar todas as chaves SAS no âmbito de dispositivos (incluindo dispositivos Edge, mas excluindo módulos) para autenticação.	bool
disableLocalAuth	Se for verdadeiro, os tokens de SAS com chaves SAS no âmbito do hub Iot não podem ser utilizados para autenticação.	bool
disableModuleSAS	Se for verdadeiro, todas as chaves SAS no âmbito do módulo não podem ser utilizadas para autenticação.	bool
enableDataResidency	Esta propriedade, quando definida como verdadeira, ativará a residência dos dados, desativando assim a recuperação após desastre.	bool
enableFileUploadNotifications	Se for Verdadeiro, as notificações de carregamento de ficheiros estão ativadas.	bool
eventHubEndpoints	As propriedades do ponto final compatível com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Esta chave tem de estar presente no dicionário ao criar ou atualizar chamadas para o hub IoT.	IotHubPropertiesEventHubEndpoints
funcionalidades	As capacidades e funcionalidades ativadas para o hub IoT.	"DeviceManagement" "Nenhum"
ipFilterRules	As regras de filtro de IP.	IpFilterRule[]
messagingEndpoints	As propriedades do ponto final de mensagens para a fila de notificação de carregamento de ficheiros.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS a suportar para este hub. Pode ser definido como "1.2" para que os clientes que utilizam uma versão do TLS abaixo da 1.2 sejam rejeitados.	string
networkRuleSets	Propriedades do Conjunto de Regras de Rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Ligações de ponto final privado criadas neste IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Se os pedidos da Rede Pública são permitidos	"Desativado" "Ativado"
restrictOutboundNetworkAccess	Se for verdadeiro, a saída do IotHub será restringida apenas aos FQDNs permitidos que estão configurados através de allowedFqdnList.	bool
encaminhamento	As propriedades relacionadas com o encaminhamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos finais do Armazenamento do Azure onde pode carregar ficheiros. Atualmente, só pode configurar uma conta de Armazenamento do Azure e esta tem de ter a respetiva chave como $default. Especificar mais do que uma conta de armazenamento causa um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications estiver definida como Verdadeiro, faz com que seja gerado um erro.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	O tempo de funcionamento predefinido para mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	As propriedades da fila de comentários para mensagens da cloud para o dispositivo.	FeedbackPropriedades
maxDeliveryCount	O número máximo de entregas para mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100

FeedbackPropriedades

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo durante o qual uma mensagem está disponível para ser consumida antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor
{customized property}		EventHubProperties

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a cloud no ponto final compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	int
retentionTimeInDays	O tempo de retenção das mensagens do dispositivo para a cloud em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nome	Descrição	Valor
action	A ação pretendida para pedidos capturados por esta regra.	"Aceitar" "Rejeitar" (obrigatório)
filterName	O nome da regra de filtro ip.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor
{customized property}		MessagingEndpointProperties

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Veja: /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem. Veja: /azure/iot-hub/iot-hub-devguide-file-upload.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo durante o qual uma mensagem está disponível para ser consumida antes de expirar pelo hub IoT. Veja: /azure/iot-hub/iot-hub-devguide-file-upload.	string

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se For Verdadeiro, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub	bool (obrigatório)
defaultAction	Ação Predefinida para Conjunto de Regras de Rede	"Permitir" 'Negar'
ipRules	Lista de Regras de IP	NetworkRuleSetIpRule[] (obrigatório)

NetworkRuleSetIpRule

Nome	Descrição	Valor
action	Ação de Filtro ip	"Permitir"
filterName	Nome da regra de filtro ip.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

PrivateEndpointConnection

Nome	Descrição	Valor
propriedades	As propriedades de uma ligação de ponto final privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Nome	Descrição	Valor
privateEndpoint	A propriedade de ponto final privado de uma ligação de ponto final privado	PrivateEndpoint
privateLinkServiceConnectionState	O estado atual de uma ligação de ponto final privado	PrivateLinkServiceConnectionState (obrigatório)

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma ligação de ponto final privado	string
descrição	A descrição do estado atual de uma ligação de ponto final privado	cadeia (obrigatório)
status	O estado de uma ligação de ponto final privado	"Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório)

RoutingProperties

Nome	Descrição	Valor
pontos finais	As propriedades relacionadas com os pontos finais personalizados aos quais o 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.	RoutingEndpoints
melhoramentos	A lista de melhoramentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a entregar a pontos finais incorporados e personalizados. Veja: `https://aka.ms/telemetryoneventgrid`	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é utilizada como uma rota de contingência quando nenhuma das condições especificadas na secção "rotas" é cumprida. Este é um parâmetro opcional. Quando esta propriedade não está presente no modelo, a rota de contingência é desativada por predefinição.	FallbackRouteProperties
rotas	A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. São permitidas no máximo 100 regras de encaminhamento para hubs pagos e são permitidas 5 regras de encaminhamento para hubs gratuitos.	RouteProperties[]

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos finais de contentor do Cosmos DB para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos finais dos Hubs de Eventos para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento. Esta lista não inclui o ponto final incorporado dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos finais de fila do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos finais do tópico do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos finais de contentor de armazenamento para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.	RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do contentor sql do cosmos DB	"identityBased" 'keyBased'
containerName	O nome do contentor sql do cosmos DB na base de dados cosmos DB.	cadeia (obrigatório)
databaseName	O nome da base de dados cosmos DB na conta do Cosmos DB.	cadeia (obrigatório)
endpointUri	O URL da conta do Cosmos DB. Tem de incluir o protocolo `https://`	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
partitionKeyName	O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.	string
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do Cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM} e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.	string
primaryKey	A chave primária da conta do Cosmos DB.	string Restrições: Valor confidencial. Transmita como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta cosmos DB.	string
secondaryKey	A chave secundária da conta do Cosmos DB.	string Restrições: Valor confidencial. Transmita como um parâmetro seguro.
subscriptionId	O identificador da subscrição da conta do Cosmos DB.	string

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo utilizador.	string

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do hub de eventos	"identityBased" 'keyBased'
connectionString	A cadeia de ligação do ponto final do hub de eventos.	string
endpointUri	O URL do ponto final do hub de eventos. Tem de incluir o protocolo sb://	string
entityPath	Nome do hub de eventos no espaço de nomes do hub de eventos	string
ID	ID do ponto final do hub de eventos	string
identidade	Propriedades de identidade gerida do ponto final do hub de eventos de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do hub de eventos.	string
subscriptionId	O identificador da subscrição do ponto final do hub de eventos.	string

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final da fila do service bus	"identityBased" 'keyBased'
connectionString	A cadeia de ligação do ponto final da fila do service bus.	string
endpointUri	O URL do ponto final da fila do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no espaço de nomes do service bus	string
ID	ID do ponto final da fila do service bus	string
identidade	Propriedades de identidade gerida do ponto final da fila do service bus de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais. O nome não tem de ser o mesmo que o nome da fila real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final da fila do service bus.	string
subscriptionId	O identificador da subscrição do ponto final da fila do service bus.	string

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do tópico do service bus	"identityBased" 'keyBased'
connectionString	A cadeia de ligação do ponto final do tópico do service bus.	string
endpointUri	O URL do ponto final do tópico do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no tópico do service bus	string
ID	ID do ponto final do tópico do service bus	string
identidade	Propriedades de identidade gerida do ponto final do tópico do barramento de serviço de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais. O nome não tem de ser o mesmo que o nome do tópico real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do tópico do service bus.	string
subscriptionId	O identificador da subscrição do ponto final do tópico do service bus.	string

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final de armazenamento	"identityBased" 'keyBased'
batchFrequencyInSeconds	Intervalo de tempo em que os blobs são escritos no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de ligação da conta de armazenamento.	string
containerName	O nome do contentor de armazenamento na conta de armazenamento.	cadeia (obrigatório)
codificação	Codificação que é utilizada para serializar mensagens em blobs. Os valores suportados são "avro", "avrodeflate" e "JSON". O valor predefinido é "avro".	'Avro' "AvroDeflate" 'JSON'
endpointUri	O URL do ponto final de armazenamento. Tem de incluir o protocolo `https://`	string
fileNameFormat	Formato de nome de ficheiro para o blob. O formato predefinido é {iothub}/{partition}/{YYYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	string
ID	ID do ponto final do contentor de armazenamento	string
identidade	Propriedades de identidade gerida do ponto final de armazenamento de encaminhamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob escrito no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor predefinido é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	string
subscriptionId	O identificador de subscrição da conta de armazenamento.	string

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos finais para os quais o melhoramento é aplicado à mensagem.	string[] (obrigatório) Restrições: Comprimento mínimo = 1
key	A chave ou o nome da propriedade de melhoramento.	cadeia (obrigatório)
valor	O valor da propriedade de melhoramento.	cadeia (obrigatório)

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de contingência. Se a condição não for fornecida, será avaliada como verdadeira por predefinição. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se a rota de contingência está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	string
source	A origem à qual a regra de encaminhamento deve ser aplicada. Por exemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para obter a gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se uma rota está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
source	A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor
{customized property}		StorageEndpointProperties

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.	"identityBased" 'keyBased'
connectionString	O cadeia de ligação para a conta de Armazenamento do Azure para a qual os ficheiros são carregados.	cadeia (obrigatório)
containerName	O nome do contentor de raiz onde carrega ficheiros. O contentor não precisa de existir, mas deve ser criável com a connectionString especificada.	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de armazenamento para carregamento de ficheiros.	ManagedIdentity
sasTtlAsIso8601	O período de tempo durante o qual o URI de SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Veja: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

Nome	Descrição	Valor
capacidade	O número de unidades de Hub IoT aprovisionadas. Veja: /azure/azure-subscription-service-limits#iot-hub-limits.	int
name	O nome do SKU.	"B1" "B2" 'B3' 'F1' 'S1' 'S2' "S3" (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar um hub IOT e um simulador de periferia do Ubuntu	Este modelo cria um hub IOT e um simulador de periferia do Ubuntu da Máquina Virtual.
Utilizar o modelo do ARM para criar Hub IoT, encaminhar e ver mensagens	Utilize este modelo para implementar um Hub IoT e uma conta de armazenamento. Execute uma aplicação para enviar mensagens para o hub que são encaminhadas para o armazenamento e, em seguida, veja os resultados.
Criar um Serviço de Aprovisionamento de Dispositivos Hub IoT	Este modelo permite-lhe criar um hub IoT e um Hub IoT Serviço de Aprovisionamento de Dispositivos e associar os dois serviços.
Criar um Hub IoT e um Grupo de Consumidores do Dispositivo para a Cloud	Este modelo permite-lhe implementar uma instância de Hub IoT com o dispositivo na cloud e na cloud para configurações de mensagens de dispositivos e um dispositivo no grupo de consumidores da cloud.
Criar a Atualização de Dispositivos para Hub IoT conta, instância Hub IoT	Este modelo cria uma conta e uma instância e um hub ao qual ligar a instância. Configura o hub com as políticas, rotas e grupos de consumidores de acesso necessários.
Implementar o serviço MedTech, incluindo um Hub IoT do Azure	O serviço MedTech é um dos Serviços de Dados de Saúde do Azure concebido para ingerir dados de dispositivos a partir de vários dispositivos, transformando os dados do dispositivo em Observações FHIR, que são depois persistentes no serviço FHIR dos Serviços de Dados de Saúde do Azure.
Criar um Ambiente Pay As You Go (PAYG) com um Hub IoT	Este modelo permite-lhe implementar um ambiente pay as you go (PAYG) do Time Series Insights configurado para consumir eventos de um Hub IoT.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso IotHubs pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "Allow"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              partitionKeyName = "string"
              partitionKeyTemplate = "string"
              primaryKey = "string"
              resourceGroup = "string"
              secondaryKey = "string"
              subscriptionId = "string"
            }
          ]
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
    sku = {
      capacity = int
      name = "string"
    }
    etag = "string"
  })
}

Valores de propriedade

IotHubs

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Devices/IotHubs@2023-06-30"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 3-50 Carateres válidos: Alfanuméricos e hífenes. Não é possível terminar com hífen. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A localização do recurso.	cadeia (obrigatório)
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	As etiquetas de recursos.	Dicionário de nomes e valores de etiquetas.
sku	Informações do SKU do IotHub	IotHubSkuInfo (obrigatório)
etag	O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	string
identidade	As identidades geridas do IotHub.	ArmIdentity
propriedades	Propriedades do IotHub	IotHubProperties

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
identity_ids	Dicionário de {ArmUserIdentity}	Matriz de IDs de identidade do utilizador.

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor
{customized property}		ArmUserIdentity

ArmUserIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Completamente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso partilhado que pode utilizar para proteger uma ligação ao hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens da cloud para o dispositivo do hub IoT.	CloudToDeviceProperties
comentários	Comentários do hub IoT.	string
disableDeviceSAS	Se for verdadeiro, não é possível utilizar todas as chaves SAS no âmbito de dispositivos (incluindo dispositivos Edge, mas excluindo módulos) para autenticação.	bool
disableLocalAuth	Se for verdadeiro, os tokens de SAS com chaves SAS no âmbito do hub Iot não podem ser utilizados para autenticação.	bool
disableModuleSAS	Se for verdadeiro, todas as chaves SAS no âmbito do módulo não podem ser utilizadas para autenticação.	bool
enableDataResidency	Esta propriedade, quando definida como verdadeira, ativará a residência dos dados, desativando assim a recuperação após desastre.	bool
enableFileUploadNotifications	Se for Verdadeiro, as notificações de carregamento de ficheiros estão ativadas.	bool
eventHubEndpoints	As propriedades do ponto final compatível com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Esta chave tem de estar presente no dicionário ao criar ou atualizar chamadas para o hub IoT.	IotHubPropertiesEventHubEndpoints
funcionalidades	As capacidades e funcionalidades ativadas para o hub IoT.	"DeviceManagement" "Nenhum"
ipFilterRules	As regras de filtro de IP.	IpFilterRule[]
messagingEndpoints	As propriedades do ponto final de mensagens para a fila de notificação de carregamento de ficheiros.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS a suportar para este hub. Pode ser definido como "1.2" para que os clientes que utilizam uma versão TLS abaixo de 1.2 sejam rejeitados.	string
networkRuleSets	Propriedades do Conjunto de Regras de Rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Ligações de ponto final privados criadas neste IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Se os pedidos da Rede Pública são permitidos	"Desativado" "Ativado"
restrictOutboundNetworkAccess	Se for verdade, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados através de allowedFqdnList.	bool
encaminhamento	As propriedades relacionadas com o encaminhamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos finais do Armazenamento do Azure onde pode carregar ficheiros. Atualmente, só pode configurar uma conta de Armazenamento do Azure e essa tem de ter a respetiva chave como $default. Especificar mais do que uma conta de armazenamento faz com que seja emitido um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications estiver definida como Verdadeiro, faz com que seja emitido um erro.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string
keyName	O nome da política de acesso partilhado.	cadeia (obrigatório)
primaryKey	A chave primária.	string
direitos	As permissões atribuídas à política de acesso partilhado.	"DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório)
secondaryKey	A chave secundária.	string

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	A hora predefinida para as mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	As propriedades da fila de comentários para mensagens da cloud para o dispositivo.	FeedbackProperties
maxDeliveryCount	A contagem máxima de entrega para mensagens da cloud para o dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100

FeedbackProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor
{customized property}		EventHubProperties

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a cloud no ponto final compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	int
retentionTimeInDays	O tempo de retenção das mensagens do dispositivo para a cloud em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nome	Descrição	Valor
action	A ação pretendida para pedidos capturados por esta regra.	"Aceitar" "Rejeitar" (obrigatório)
filterName	O nome da regra de filtro IP.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor
{customized property}		MessagingEndpointProperties

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	O número de vezes que o hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	int Restrições: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se For Verdadeiro, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub	bool (obrigatório)
defaultAction	Ação Predefinida para Conjunto de Regras de Rede	"Permitir" "Negar"
ipRules	Lista de Regras de IP	NetworkRuleSetIpRule[] (obrigatório)

NetworkRuleSetIpRule

Nome	Descrição	Valor
action	Ação de Filtro ip	"Permitir"
filterName	Nome da regra de filtro ip.	cadeia (obrigatório)
ipMask	Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.	cadeia (obrigatório)

PrivateEndpointConnection

Nome	Descrição	Valor
propriedades	As propriedades de uma ligação de ponto final privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

Nome	Descrição	Valor
privateEndpoint	A propriedade de ponto final privado de uma ligação de ponto final privado	PrivateEndpoint
privateLinkServiceConnectionState	O estado atual de uma ligação de ponto final privado	PrivateLinkServiceConnectionState (obrigatório)

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma ligação de ponto final privado	string
descrição	A descrição do estado atual de uma ligação de ponto final privado	cadeia (obrigatório)
status	O estado de uma ligação de ponto final privado	"Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório)

RoutingProperties

Nome	Descrição	Valor
pontos finais	As propriedades relacionadas com os pontos finais personalizados aos quais o 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.	RoutingEndpoints
melhoramentos	A lista de melhoramentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a entregar a pontos finais incorporados e personalizados. Veja: `https://aka.ms/telemetryoneventgrid`	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é utilizada como uma rota de contingência quando nenhuma das condições especificadas na secção "rotas" é cumprida. Este é um parâmetro opcional. Quando esta propriedade não está presente no modelo, a rota de contingência é desativada por predefinição.	FallbackRouteProperties
rotas	A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. São permitidas no máximo 100 regras de encaminhamento para hubs pagos e são permitidas 5 regras de encaminhamento para hubs gratuitos.	RouteProperties[]

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos finais de contentor do Cosmos DB para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos finais dos Hubs de Eventos para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento. Esta lista não inclui o ponto final incorporado dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos finais de fila do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos finais do tópico do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos finais de contentor de armazenamento para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.	RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do contentor sql do Cosmos DB	"identityBased" "keyBased"
containerName	O nome do contentor sql do cosmos DB na base de dados cosmos DB.	cadeia (obrigatório)
databaseName	O nome da base de dados cosmos DB na conta do Cosmos DB.	cadeia (obrigatório)
endpointUri	O URL da conta do Cosmos DB. Tem de incluir o protocolo `https://`	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
partitionKeyName	O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.	string
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do Cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM} e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.	string
primaryKey	A chave primária da conta do Cosmos DB.	string Restrições: Valor confidencial. Transmita como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta cosmos DB.	string
secondaryKey	A chave secundária da conta do Cosmos DB.	string Restrições: Valor confidencial. Transmita como um parâmetro seguro.
subscriptionId	O identificador da subscrição da conta do Cosmos DB.	string

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo utilizador.	string

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do hub de eventos	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final do hub de eventos.	string
endpointUri	O URL do ponto final do hub de eventos. Tem de incluir o protocolo sb://	string
entityPath	Nome do hub de eventos no espaço de nomes do hub de eventos	string
ID	ID do ponto final do hub de eventos	string
identidade	Propriedades de identidade gerida do ponto final do hub de eventos de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do hub de eventos.	string
subscriptionId	O identificador da subscrição do ponto final do hub de eventos.	string

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final da fila do service bus	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final da fila do service bus.	string
endpointUri	O URL do ponto final da fila do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no espaço de nomes do service bus	string
ID	ID do ponto final da fila do service bus	string
identidade	Propriedades de identidade gerida do ponto final da fila do service bus de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. O nome não tem de ser o mesmo que o nome da fila real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final da fila do service bus.	string
subscriptionId	O identificador de subscrição do ponto final da fila do service bus.	string

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final do tópico do service bus	"identityBased" "keyBased"
connectionString	A cadeia de ligação do ponto final do tópico do service bus.	string
endpointUri	O URL do ponto final do tópico do service bus. Tem de incluir o protocolo sb://	string
entityPath	Nome da fila no tópico do service bus	string
ID	ID do ponto final do tópico do service bus	string
identidade	Propriedades de identidade gerida do ponto final do tópico do service bus de encaminhamento.	ManagedIdentity
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. O nome não tem de ser o mesmo que o nome do tópico real.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos do ponto final do tópico do service bus.	string
subscriptionId	O identificador de subscrição do ponto final do tópico do service bus.	string

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método utilizado para autenticar no ponto final de armazenamento	"identityBased" "keyBased"
batchFrequencyInSeconds	Intervalo de tempo em que os blobs são escritos no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de ligação da conta de armazenamento.	string
containerName	O nome do contentor de armazenamento na conta de armazenamento.	cadeia (obrigatório)
codificação	Codificação que é utilizada para serializar mensagens em blobs. Os valores suportados são "avro", "avrodeflate" e "JSON". O valor predefinido é "avro".	"Avro" "AvroDeflate" "JSON"
endpointUri	O URL do ponto final de armazenamento. Tem de incluir o protocolo `https://`	string
fileNameFormat	Formato de nome de ficheiro para o blob. O formato predefinido é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	string
ID	ID do ponto final do contentor de armazenamento	string
identidade	Propriedades de identidade gerida do ponto final de armazenamento de encaminhamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob escrito no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor predefinido é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
name	O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	string
subscriptionId	O identificador da subscrição da conta de armazenamento.	string

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos finais para os quais o melhoramento é aplicado à mensagem.	string[] (obrigatório) Restrições: Comprimento mínimo = 1
key	A chave ou o nome da propriedade de melhoramento.	cadeia (obrigatório)
valor	O valor da propriedade de melhoramento.	cadeia (obrigatório)

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de contingência. Se a condição não for fornecida, será avaliada como verdadeira por predefinição. Para obter a gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se a rota de contingência está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	string
source	A origem à qual a regra de encaminhamento deve ser aplicada. Por exemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para obter a gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.	string[] (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
isEnabled	Utilizado para especificar se uma rota está ativada.	bool (obrigatório)
name	O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.	cadeia (obrigatório) Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$`
source	A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Inválido" "TwinChangeEvents" (obrigatório)

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor
{customized property}		StorageEndpointProperties

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.	"identityBased" "keyBased"
connectionString	O cadeia de ligação para a conta de Armazenamento do Azure para a qual os ficheiros são carregados.	cadeia (obrigatório)
containerName	O nome do contentor de raiz onde carrega ficheiros. O contentor não precisa de existir, mas deve ser criável com a connectionString especificada.	cadeia (obrigatório)
identidade	Propriedades de identidade gerida do ponto final de armazenamento para carregamento de ficheiros.	ManagedIdentity
sasTtlAsIso8601	O período de tempo durante o qual o URI de SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Veja: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

Nome	Descrição	Valor
capacidade	O número de unidades de Hub IoT aprovisionadas. Veja: /azure/azure-subscription-service-limits#iot-hub-limits.	int
name	O nome do SKU.	"B1" "B2" "B3" "F1" "S1" "S2" "S3" (obrigatório)