Microsoft.Devices IotHubs

Artigo
12/09/2024

Definição de recurso do Bicep

O tipo de recurso IotHubs pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        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: 'string'
          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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dicionário de <ArmUserIdentity>	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor

ArmUserIdentity

Nome	Descrição	Valor

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corda
realimentação	As propriedades da fila de comentários para mensagens de nuvem para dispositivo.	feedbackproperties
maxDeliveryCount	A contagem máxima de entrega para mensagens de nuvem para 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

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem.	string[] (obrigatório)
chave	A chave ou o nome da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)
valor	O valor da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade 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 para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se a rota de fallback está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda
fonte	A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

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.	corda
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 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.	corda

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens de nuvem para dispositivo do Hub IoT.	CloudToDeviceProperties
Comentários	Comentários do Hub IoT.	corda
disableDeviceSAS	Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.	Bool
disableLocalAuth	Se for true, tokens SAS com chaves SAS com escopo de hub Iot não poderão ser usados para autenticação.	Bool
disableModuleSAS	Se for true, todas as chaves SAS com escopo de módulo não poderão ser usadas para autenticação.	Bool
enableDataResidency	Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre.	Bool
enableFileUploadNotifications	Se True, as notificações de upload de arquivo serão habilitadas.	Bool
eventHubEndpoints	As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Essa chave precisa estar presente no dicionário ao criar ou atualizar chamadas para o Hub IoT.	IotHubPropertiesEventHubEndpoints
Características	Os recursos e recursos habilitados para o Hub IoT.	'DeviceManagement' 'None'
ipFilterRules	As regras de filtro IP.	IpFilterRule []
messagingEndpoints	As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo da 1.2 sejam rejeitados.	corda
networkRuleSets	Propriedades do conjunto de regras de rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexões de ponto de extremidade privado criadas neste IotHub	PrivateEndpointConnection []
publicNetworkAccess	Se as solicitações da Rede Pública são permitidas	'Desabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.	Bool
roteamento	As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor

IotHubSkuInfo

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

IpFilterRule

Nome	Descrição	Valor
ação	A ação desejada para solicitações capturadas por essa regra.	'Aceitar' 'Reject' (obrigatório)
filterName	O nome da regra de filtro IP.	cadeia de caracteres (obrigatório)
ipMask	Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra.	cadeia de caracteres (obrigatório)

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo usuário.	corda

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	corda
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 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.	corda

Microsoft.Devices/IotHubs

Nome	Descrição	Valor
etag	O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	corda
identidade	As identidades gerenciadas do IotHub.	ArmIdentity
localização	O local do recurso.	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do IotHub	IotHubProperties
Sku	Informações de SKU do IotHub	IotHubSkuInfo (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

NetworkRuleSetIpRule

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

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se true, o conjunto de regras de rede também será aplicado ao Ponto de Extremidade do EventHub builtin do IotHub	bool (obrigatório)
defaultAction	Ação padrão para o conjunto de regras de rede	'Permitir' 'Negar'
ipRules	Lista de regras de IP	NetworkRuleSetIpRule [] (obrigatório)

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	As propriedades de uma conexão de ponto de extremidade privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma conexão de ponto de extremidade privado	corda
descrição	A descrição do estado atual de uma conexão de ponto de extremidade privado	cadeia de caracteres (obrigatório)
estado	O status de uma conexão de ponto de extremidade privado	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório)

ResourceTags

Nome	Descrição	Valor

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se uma rota está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
fonte	A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de contêiner sql do Cosmos DB	'identityBased' 'keyBased'
containerName	O nome do contêiner sql do Cosmos DB no banco de dados cosmos DB.	cadeia de caracteres (obrigatório)
databaseName	O nome do banco de dados cosmos DB na conta do Cosmos DB.	cadeia de caracteres (obrigatório)
endpointUri	A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
partitionKeyName	O nome da chave de partição associada a esse contêiner sql do Cosmos DB se existir. Esse é um parâmetro opcional.	corda
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado.	corda
primaryKey	A chave primária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta do Cosmos DB.	corda
secondaryKey	A chave secundária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
subscriptionId	O identificador de assinatura da conta do Cosmos DB.	corda

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do hub de eventos	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do hub de eventos.	corda
endpointUri	A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb://	corda
entityPath	Nome do hub de eventos no namespace do hub de eventos	corda
id	ID do ponto de extremidade do hub de eventos	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do hub de eventos.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do hub de eventos.	corda

RoutingProperties

Nome	Descrição	Valor
Extremidade	As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.	RoutingEndpoints
enriquecimentos	A lista de enriquecimentos fornecidos pelo usuário que o Hub IoT aplica às mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão.	fallbackRouteProperties
Rotas	A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos.	RouteProperties []

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade da fila do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade da fila do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no namespace do barramento de serviço	corda
id	ID do ponto de extremidade da fila do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade da fila do barramento de serviço.	corda

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do tópico do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no tópico do barramento de serviço	corda
id	ID do ponto de extremidade do tópico do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço.	corda

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de armazenamento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de conexão da conta de armazenamento.	corda
containerName	O nome do contêiner de armazenamento na conta de armazenamento.	cadeia de caracteres (obrigatório)
codificação	Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.	'Avro' 'AvroDeflate' 'JSON'
endpointUri	A URL do ponto de extremidade de armazenamento. Ele deve incluir o protocolo https://	corda
fileNameFormat	Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	corda
id	ID do ponto de extremidade do contêiner de armazenamento	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento de roteamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	corda
subscriptionId	O identificador de assinatura da conta de armazenamento.	corda

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso compartilhado.	cadeia de caracteres (obrigatório)
primaryKey	A chave primária.	corda
direitos	As permissões atribuídas à política de acesso compartilhado.	'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.	corda

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.	'identityBased' 'keyBased'
connectionString	A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados.	cadeia de caracteres (obrigatório)
containerName	O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado.	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para upload de arquivo.	ManagedIdentity
sasTtlAsIso8601	O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corda

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep	Descrição
criar um Hub IoT e um grupo de consumidores de dispositivo para nuvem	Esse modelo permite implantar uma instância do Hub IoT com dispositivo para nuvem e nuvem para configurações de mensagens de dispositivo e um dispositivo para o grupo de consumidores de nuvem.
criar um serviço de provisionamento de dispositivos do Hub IoT	Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos.
Criar Atualização de Dispositivo para a conta do Hub IoT, instância, Hub IoT	Esse modelo cria uma conta, uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, as rotas e o grupo de consumidores necessários.
implantar o serviço MedTech, incluindo um Hub IoT do Azure	O serviço MedTech é um dos Serviços de Dados de Integridade do Azure projetados para ingerir dados do dispositivo de vários dispositivos, transformar os dados do dispositivo em observações FHIR, que são então persistentes no serviço FHIR dos Serviços de Dados de Integridade do Azure.
usar o modelo do ARM para criar o Hub IoT, rotear e exibir mensagens	Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, exiba os resultados.

Definição de recurso de modelo do ARM

O tipo de recurso IotHubs pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "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": "string",
          "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dicionário de <ArmUserIdentity>	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor

ArmUserIdentity

Nome	Descrição	Valor

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corda
realimentação	As propriedades da fila de comentários para mensagens de nuvem para dispositivo.	feedbackproperties
maxDeliveryCount	A contagem máxima de entrega para mensagens de nuvem para 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

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem.	string[] (obrigatório)
chave	A chave ou o nome da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)
valor	O valor da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade 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 para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se a rota de fallback está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda
fonte	A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

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.	corda
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 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.	corda

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens de nuvem para dispositivo do Hub IoT.	CloudToDeviceProperties
Comentários	Comentários do Hub IoT.	corda
disableDeviceSAS	Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.	Bool
disableLocalAuth	Se for true, tokens SAS com chaves SAS com escopo de hub Iot não poderão ser usados para autenticação.	Bool
disableModuleSAS	Se for true, todas as chaves SAS com escopo de módulo não poderão ser usadas para autenticação.	Bool
enableDataResidency	Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre.	Bool
enableFileUploadNotifications	Se True, as notificações de upload de arquivo serão habilitadas.	Bool
eventHubEndpoints	As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Essa chave precisa estar presente no dicionário ao criar ou atualizar chamadas para o Hub IoT.	IotHubPropertiesEventHubEndpoints
Características	Os recursos e recursos habilitados para o Hub IoT.	'DeviceManagement' 'None'
ipFilterRules	As regras de filtro IP.	IpFilterRule []
messagingEndpoints	As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo da 1.2 sejam rejeitados.	corda
networkRuleSets	Propriedades do conjunto de regras de rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexões de ponto de extremidade privado criadas neste IotHub	PrivateEndpointConnection []
publicNetworkAccess	Se as solicitações da Rede Pública são permitidas	'Desabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.	Bool
roteamento	As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor

IotHubSkuInfo

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

IpFilterRule

Nome	Descrição	Valor
ação	A ação desejada para solicitações capturadas por essa regra.	'Aceitar' 'Reject' (obrigatório)
filterName	O nome da regra de filtro IP.	cadeia de caracteres (obrigatório)
ipMask	Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra.	cadeia de caracteres (obrigatório)

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo usuário.	corda

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	corda
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 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.	corda

Microsoft.Devices/IotHubs

Nome	Descrição	Valor
apiVersion	A versão da API	'2023-06-30'
etag	O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	corda
identidade	As identidades gerenciadas do IotHub.	ArmIdentity
localização	O local do recurso.	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do IotHub	IotHubProperties
Sku	Informações de SKU do IotHub	IotHubSkuInfo (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo	O tipo de recurso	'Microsoft.Devices/IotHubs'

NetworkRuleSetIpRule

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

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se true, o conjunto de regras de rede também será aplicado ao Ponto de Extremidade do EventHub builtin do IotHub	bool (obrigatório)
defaultAction	Ação padrão para o conjunto de regras de rede	'Permitir' 'Negar'
ipRules	Lista de regras de IP	NetworkRuleSetIpRule [] (obrigatório)

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	As propriedades de uma conexão de ponto de extremidade privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma conexão de ponto de extremidade privado	corda
descrição	A descrição do estado atual de uma conexão de ponto de extremidade privado	cadeia de caracteres (obrigatório)
estado	O status de uma conexão de ponto de extremidade privado	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório)

ResourceTags

Nome	Descrição	Valor

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se uma rota está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
fonte	A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de contêiner sql do Cosmos DB	'identityBased' 'keyBased'
containerName	O nome do contêiner sql do Cosmos DB no banco de dados cosmos DB.	cadeia de caracteres (obrigatório)
databaseName	O nome do banco de dados cosmos DB na conta do Cosmos DB.	cadeia de caracteres (obrigatório)
endpointUri	A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
partitionKeyName	O nome da chave de partição associada a esse contêiner sql do Cosmos DB se existir. Esse é um parâmetro opcional.	corda
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado.	corda
primaryKey	A chave primária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta do Cosmos DB.	corda
secondaryKey	A chave secundária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
subscriptionId	O identificador de assinatura da conta do Cosmos DB.	corda

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do hub de eventos	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do hub de eventos.	corda
endpointUri	A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb://	corda
entityPath	Nome do hub de eventos no namespace do hub de eventos	corda
id	ID do ponto de extremidade do hub de eventos	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do hub de eventos.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do hub de eventos.	corda

RoutingProperties

Nome	Descrição	Valor
Extremidade	As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.	RoutingEndpoints
enriquecimentos	A lista de enriquecimentos fornecidos pelo usuário que o Hub IoT aplica às mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão.	fallbackRouteProperties
Rotas	A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos.	RouteProperties []

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade da fila do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade da fila do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no namespace do barramento de serviço	corda
id	ID do ponto de extremidade da fila do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade da fila do barramento de serviço.	corda

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do tópico do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no tópico do barramento de serviço	corda
id	ID do ponto de extremidade do tópico do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço.	corda

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de armazenamento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de conexão da conta de armazenamento.	corda
containerName	O nome do contêiner de armazenamento na conta de armazenamento.	cadeia de caracteres (obrigatório)
codificação	Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.	'Avro' 'AvroDeflate' 'JSON'
endpointUri	A URL do ponto de extremidade de armazenamento. Ele deve incluir o protocolo https://	corda
fileNameFormat	Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	corda
id	ID do ponto de extremidade do contêiner de armazenamento	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento de roteamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	corda
subscriptionId	O identificador de assinatura da conta de armazenamento.	corda

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso compartilhado.	cadeia de caracteres (obrigatório)
primaryKey	A chave primária.	corda
direitos	As permissões atribuídas à política de acesso compartilhado.	'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.	corda

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.	'identityBased' 'keyBased'
connectionString	A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados.	cadeia de caracteres (obrigatório)
containerName	O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado.	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para upload de arquivo.	ManagedIdentity
sasTtlAsIso8601	O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
criar um ambiente pay as you go (PAYG) com um Hub IoT	Esse modelo permite implantar um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT.
criar um Hub IoT e um grupo de consumidores de dispositivo para nuvem	Esse modelo permite implantar uma instância do Hub IoT com dispositivo para nuvem e nuvem para configurações de mensagens de dispositivo e um dispositivo para o grupo de consumidores de nuvem.
Criar um Hub IOT e um simulador de borda do Ubuntu	Esse modelo cria um simulador de borda do Ubuntu do Hub IOT e da Máquina Virtual.
criar um serviço de provisionamento de dispositivos do Hub IoT	Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos.
Criar Atualização de Dispositivo para a conta do Hub IoT, instância, Hub IoT	Esse modelo cria uma conta, uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, as rotas e o grupo de consumidores necessários.
implantar o serviço MedTech, incluindo um Hub IoT do Azure	O serviço MedTech é um dos Serviços de Dados de Integridade do Azure projetados para ingerir dados do dispositivo de vários dispositivos, transformar os dados do dispositivo em observações FHIR, que são então persistentes no serviço FHIR dos Serviços de Dados de Integridade do Azure.
usar o modelo do ARM para criar o Hub IoT, rotear e exibir mensagens	Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, exiba os resultados.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso IotHubs pode ser implantado com operações de destino:

grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          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 = "string"
            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

ArmIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dicionário de <ArmUserIdentity>	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome	Descrição	Valor

ArmUserIdentity

Nome	Descrição	Valor

CloudToDeviceProperties

Nome	Descrição	Valor
defaultTtlAsIso8601	O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corda
realimentação	As propriedades da fila de comentários para mensagens de nuvem para dispositivo.	feedbackproperties
maxDeliveryCount	A contagem máxima de entrega para mensagens de nuvem para 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

EnrichmentProperties

Nome	Descrição	Valor
endpointNames	A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem.	string[] (obrigatório)
chave	A chave ou o nome da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)
valor	O valor da propriedade de enriquecimento.	cadeia de caracteres (obrigatório)

EventHubProperties

Nome	Descrição	Valor
partitionCount	O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade 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 para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

FallbackRouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se a rota de fallback está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda
fonte	A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

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.	corda
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 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.	corda

IotHubProperties

Nome	Descrição	Valor
allowedFqdnList	Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.	string[]
authorizationPolicies	As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	As propriedades de mensagens de nuvem para dispositivo do Hub IoT.	CloudToDeviceProperties
Comentários	Comentários do Hub IoT.	corda
disableDeviceSAS	Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.	Bool
disableLocalAuth	Se for true, tokens SAS com chaves SAS com escopo de hub Iot não poderão ser usados para autenticação.	Bool
disableModuleSAS	Se for true, todas as chaves SAS com escopo de módulo não poderão ser usadas para autenticação.	Bool
enableDataResidency	Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre.	Bool
enableFileUploadNotifications	Se True, as notificações de upload de arquivo serão habilitadas.	Bool
eventHubEndpoints	As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Essa chave precisa estar presente no dicionário ao criar ou atualizar chamadas para o Hub IoT.	IotHubPropertiesEventHubEndpoints
Características	Os recursos e recursos habilitados para o Hub IoT.	'DeviceManagement' 'None'
ipFilterRules	As regras de filtro IP.	IpFilterRule []
messagingEndpoints	As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo da 1.2 sejam rejeitados.	corda
networkRuleSets	Propriedades do conjunto de regras de rede do IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexões de ponto de extremidade privado criadas neste IotHub	PrivateEndpointConnection []
publicNetworkAccess	Se as solicitações da Rede Pública são permitidas	'Desabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.	Bool
roteamento	As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nome	Descrição	Valor

IotHubPropertiesMessagingEndpoints

Nome	Descrição	Valor

IotHubPropertiesStorageEndpoints

Nome	Descrição	Valor

IotHubSkuInfo

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

IpFilterRule

Nome	Descrição	Valor
ação	A ação desejada para solicitações capturadas por essa regra.	'Aceitar' 'Reject' (obrigatório)
filterName	O nome da regra de filtro IP.	cadeia de caracteres (obrigatório)
ipMask	Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra.	cadeia de caracteres (obrigatório)

ManagedIdentity

Nome	Descrição	Valor
userAssignedIdentity	A identidade atribuída pelo usuário.	corda

MessagingEndpointProperties

Nome	Descrição	Valor
lockDurationAsIso8601	A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	corda
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 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.	corda

Microsoft.Devices/IotHubs

Nome	Descrição	Valor
etag	O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal.	corda
identidade	As identidades gerenciadas do IotHub.	ArmIdentity
localização	O local do recurso.	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do IotHub	IotHubProperties
Sku	Informações de SKU do IotHub	IotHubSkuInfo (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.Devices/IotHubs@2023-06-30"

NetworkRuleSetIpRule

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

NetworkRuleSetProperties

Nome	Descrição	Valor
applyToBuiltInEventHubEndpoint	Se true, o conjunto de regras de rede também será aplicado ao Ponto de Extremidade do EventHub builtin do IotHub	bool (obrigatório)
defaultAction	Ação padrão para o conjunto de regras de rede	'Permitir' 'Negar'
ipRules	Lista de regras de IP	NetworkRuleSetIpRule [] (obrigatório)

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	As propriedades de uma conexão de ponto de extremidade privado	PrivateEndpointConnectionProperties (obrigatório)

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
actionsRequired	Ações necessárias para uma conexão de ponto de extremidade privado	corda
descrição	A descrição do estado atual de uma conexão de ponto de extremidade privado	cadeia de caracteres (obrigatório)
estado	O status de uma conexão de ponto de extremidade privado	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório)

ResourceTags

Nome	Descrição	Valor

RouteProperties

Nome	Descrição	Valor
condição	A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language	corda
endpointNames	A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido.	string[] (obrigatório)
isEnabled	Usado para especificar se uma rota está habilitada.	bool (obrigatório)
nome	O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
fonte	A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Inválido' 'TwinChangeEvents' (obrigatório)

RoutingCosmosDBSqlApiProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de contêiner sql do Cosmos DB	'identityBased' 'keyBased'
containerName	O nome do contêiner sql do Cosmos DB no banco de dados cosmos DB.	cadeia de caracteres (obrigatório)
databaseName	O nome do banco de dados cosmos DB na conta do Cosmos DB.	cadeia de caracteres (obrigatório)
endpointUri	A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
partitionKeyName	O nome da chave de partição associada a esse contêiner sql do Cosmos DB se existir. Esse é um parâmetro opcional.	corda
partitionKeyTemplate	O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado.	corda
primaryKey	A chave primária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
resourceGroup	O nome do grupo de recursos da conta do Cosmos DB.	corda
secondaryKey	A chave secundária da conta do Cosmos DB.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
subscriptionId	O identificador de assinatura da conta do Cosmos DB.	corda

RoutingEndpoints

Nome	Descrição	Valor
cosmosDBSqlContainers	A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos.	RoutingEventHubProperties[]
serviceBusQueues	A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do hub de eventos	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do hub de eventos.	corda
endpointUri	A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb://	corda
entityPath	Nome do hub de eventos no namespace do hub de eventos	corda
id	ID do ponto de extremidade do hub de eventos	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do hub de eventos.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do hub de eventos.	corda

RoutingProperties

Nome	Descrição	Valor
Extremidade	As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.	RoutingEndpoints
enriquecimentos	A lista de enriquecimentos fornecidos pelo usuário que o Hub IoT aplica às mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão.	fallbackRouteProperties
Rotas	A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos.	RouteProperties []

RoutingServiceBusQueueEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade da fila do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade da fila do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no namespace do barramento de serviço	corda
id	ID do ponto de extremidade da fila do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade da fila do barramento de serviço.	corda

RoutingServiceBusTopicEndpointProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade do tópico do barramento de serviço	'identityBased' 'keyBased'
connectionString	A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço.	corda
endpointUri	A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb://	corda
entityPath	Nome da fila no tópico do barramento de serviço	corda
id	ID do ponto de extremidade do tópico do barramento de serviço	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento.	ManagedIdentity
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço.	corda
subscriptionId	O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço.	corda

RoutingStorageContainerProperties

Nome	Descrição	Valor
authenticationType	Método usado para autenticar no ponto de extremidade de armazenamento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos.	int Restrições: Valor mínimo = 60 Valor máximo = 720
connectionString	A cadeia de conexão da conta de armazenamento.	corda
containerName	O nome do contêiner de armazenamento na conta de armazenamento.	cadeia de caracteres (obrigatório)
codificação	Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.	'Avro' 'AvroDeflate' 'JSON'
endpointUri	A URL do ponto de extremidade de armazenamento. Ele deve incluir o protocolo https://	corda
fileNameFormat	Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.	corda
id	ID do ponto de extremidade do contêiner de armazenamento	corda
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento de roteamento.	ManagedIdentity
maxChunkSizeInBytes	Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB).	int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000
nome	O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.	corda Restrições: Padrão = `^[A-Za-z0-9-._]{1,64}$` (obrigatório)
resourceGroup	O nome do grupo de recursos da conta de armazenamento.	corda
subscriptionId	O identificador de assinatura da conta de armazenamento.	corda

SharedAccessSignatureAuthorizationRule

Nome	Descrição	Valor
keyName	O nome da política de acesso compartilhado.	cadeia de caracteres (obrigatório)
primaryKey	A chave primária.	corda
direitos	As permissões atribuídas à política de acesso compartilhado.	'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.	corda

StorageEndpointProperties

Nome	Descrição	Valor
authenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.	'identityBased' 'keyBased'
connectionString	A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados.	cadeia de caracteres (obrigatório)
containerName	O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado.	cadeia de caracteres (obrigatório)
identidade	Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para upload de arquivo.	ManagedIdentity
sasTtlAsIso8601	O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corda

Compartilhar via

Microsoft.Devices IotHubs

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Exemplos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Modelos de início rápido

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso