Microsoft.Devices IotHubs 2022-11-15-preview
Definição de recurso do Bicep
O tipo de recurso IotHubs pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Devices/IotHubs@2022-11-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
enableFileUploadNotifications: bool
encryption: {
keySource: 'string'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyIdentifier: 'string'
}
]
}
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
ipVersion: 'string'
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
rootCertificate: {
enableRootCertificateV2: bool
}
routing: {
endpoints: {
cosmosDBSqlCollections: [
{
authenticationType: 'string'
collectionName: 'string'
databaseName: 'string'
endpointUri: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
}
Valores de propriedade
IotHubs
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3 a 50 Caracteres válidos: Caracteres alfanuméricos e hifens. Não pode terminar com hífen. O nome do recurso deve ser exclusivo no Azure. |
| local | O local do recurso. | cadeia de caracteres (obrigatório) |
| marcas | As marcas do recurso. | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| sku | Informações de SKU do IotHub | IotHubSkuInfo (obrigatório) |
| 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 de ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| properties | Propriedades do IotHub | IotHubProperties |
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á todas as identidades do serviço. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dicionário de {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ArmUserIdentity |
ArmUserIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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 da nuvem para o dispositivo do Hub IoT. | CloudToDeviceProperties |
| comments | Comentários do Hub IoT. | string |
| deviceStreams | O dispositivo transmite as propriedades do iothub. | IotHubPropertiesDeviceStreams |
| 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, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação. | bool |
| disableModuleSAS | Se for true, todas as chaves SAS no escopo do 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 |
| criptografia | As propriedades de criptografia para o Hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave deve estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
| recursos | As funcionalidades e os recursos habilitados para o Hub IoT. | 'DeviceManagement' 'None' |
| ipFilterRules | As regras de filtro ip. | IpFilterRule[] |
| ipVersion | Essa propriedade especifica a versão de IP que o hub está utilizando no momento. | 'ipv4' 'ipv4ipv6' 'ipv6' |
| 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 do TLS abaixo da 1.2 sejam rejeitados. | string |
| 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' 'Enabled' |
| restrictOutboundNetworkAccess | Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList. | bool |
| rootCertificate | Essas informações relacionadas ao certificado raiz do repositório de propriedades | RootCertificateProperties |
| roteamento | As propriedades relacionadas ao roteamento do Hub IoT. Confira: /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 |
SharedAccessSignatureAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
CloudToDeviceProperties
| Nome | Descrição | Valor |
|---|---|---|
| defaultTtlAsIso8601 | O tempo de vida padrão para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| comentários | As propriedades da fila de comentários para mensagens da nuvem para o dispositivo. | FeedbackProperties |
| maxDeliveryCount | A contagem máxima de entrega para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
FeedbackProperties
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Confira: /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. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
| Nome | Descrição | Valor |
|---|---|---|
| streamingEndpoints | Lista de pontos de extremidade de fluxos de dispositivo. | string[] |
EncryptionPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| keySource | A origem da chave. | string |
| keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Nome | Descrição | Valor |
|---|---|---|
| identidade | Propriedades de identidade gerenciada da chave KeyVault. | ManagedIdentity |
| keyIdentifier | O identificador da chave. | string |
ManagedIdentity
| Nome | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída pelo usuário. | string |
IotHubPropertiesEventHubEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | EventHubProperties |
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. Confira: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
| retentionTimeInDays | O tempo de retenção para mensagens de dispositivo para nuvem em dias. Confira: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | INT |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | 'Accept' '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) |
IotHubPropertiesMessagingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | MessagingEndpointProperties |
MessagingEndpointProperties
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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 conjunto de regras de rede | 'Allow' 'Deny' |
| ipRules | Lista de regras de IP | NetworkRuleSetIpRule[] (obrigatório) |
NetworkRuleSetIpRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | Ação de filtro IP | 'Allow' |
| 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) |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | string |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| status | O status de uma conexão de ponto de extremidade privado | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório) |
RootCertificateProperties
| Nome | Descrição | Valor |
|---|---|---|
| enableRootCertificateV2 | Essa propriedade quando definida como true, o hub usará o certificado G2; enquanto está definido como false, o hub usa Baltimore Cert. | bool |
RoutingProperties
| Nome | Descrição | Valor |
|---|---|---|
| pontos de extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 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. Confira: 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á definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | 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. No máximo 100 regras de roteamento são permitidas para hubs pagos e no máximo cinco regras de roteamento são permitidas para hubs gratuitos. | RouteProperties[] |
RoutingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| cosmosDBSqlCollections | A lista de pontos de extremidade de coleção 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[] |
RoutingCosmosDBSqlApiProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade da coleção sql do Cosmos DB | 'identityBased' 'keyBased' |
| collectionName | O nome da coleção 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) |
| id | ID do ponto de extremidade da coleção sql do Cosmos DB | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade de coleção do Cosmos DB de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | O nome da chave de partição associada a essa coleção sql do Cosmos DB, se houver. Esse é um parâmetro opcional. | string |
| partitionKeyTemplate | O modelo para gerar um valor de chave de partição sintética para uso com essa coleção 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 os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado. | string |
| primaryKey | A chave primária da conta do Cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| resourceGroup | O nome do grupo de recursos da conta do Cosmos DB. | string |
| secondaryKey | A chave secundária da conta do Cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| subscriptionId | O identificador de assinatura da conta do Cosmos DB. | string |
RoutingEventHubProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade do hub de eventos | 'identityBased' 'keyBased' |
| connectionString | O cadeia de conexão do ponto de extremidade do hub de eventos. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome do hub de eventos no namespace do hub de eventos | string |
| id | ID do ponto de extremidade do hub de eventos | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | string |
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 | O cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no namespace do barramento de serviço | string |
| id | ID do ponto de extremidade da fila do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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 da fila. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | string |
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 | O cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no tópico do barramento de serviço | string |
| id | ID do ponto de extremidade do tópico do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | string |
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 | O cadeia de conexão da conta de armazenamento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
| codificando | 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:// |
string |
| fileNameFormat | Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
| id | ID do ponto de extremidade do contêiner de armazenamento | string |
| 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 |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
| subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnrichmentProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointNames | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) Restrições: Comprimento mínimo = 1 |
| chave | A chave ou o nome da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
| value | O valor da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
FallbackRouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string |
| source | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'MqttBrokerMessages' 'TwinChangeEvents' (obrigatório) |
RouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| source | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'MqttBrokerMessages' 'TwinChangeEvents' (obrigatório) |
IotHubPropertiesStorageEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | StorageEndpointProperties |
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 | O cadeia de conexão para a conta de Armazenamento do Azure na qual os arquivos são carregados. | cadeia de caracteres (obrigatório) |
| containerName | O nome do contêiner raiz no qual você carrega arquivos. O contêiner não precisa existir, mas deve ser cretável usando 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 de tempo para o qual o URI de SAS gerado por Hub IoT para upload de arquivo é válido. Confira: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| ALOCADA | O número de unidades de Hub IoT provisionadas. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | O nome da SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obrigatório) |
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 Hub IOT e um simulador de borda do Ubuntu |
Este modelo cria um Hub IOT e um simulador de borda do Ubuntu da Máquina Virtual. |
| Usar o modelo do ARM para criar 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. |
| Criar um serviço de provisionamento de dispositivos Hub IoT |
Esse modelo permite que você crie um hub IoT e um Hub IoT Serviço de Provisionamento de Dispositivos e vincule os dois serviços. |
| Criar um Hub IoT e um Grupo de Consumidores de Dispositivo para Nuvem |
Esse modelo permite que você implante uma instância de Hub IoT com configurações de mensagens de dispositivo para nuvem e nuvem e um dispositivo para o grupo de consumidores de nuvem. |
| Criar Atualização de Dispositivo para Hub IoT conta, instância Hub IoT |
Esse modelo cria uma conta e uma instância e um hub com o qual 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 de 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. |
| Criar um ambiente PAYG (Pagamento Conforme o Uso) com um Hub IoT |
Este modelo permite que você implante um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT. |
Definição de recurso de modelo do ARM
O tipo de recurso IotHubs pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2022-11-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"enableFileUploadNotifications": "bool",
"encryption": {
"keySource": "string",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyIdentifier": "string"
}
]
},
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"ipVersion": "string",
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"rootCertificate": {
"enableRootCertificateV2": "bool"
},
"routing": {
"endpoints": {
"cosmosDBSqlCollections": [
{
"authenticationType": "string",
"collectionName": "string",
"databaseName": "string",
"endpointUri": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
}
}
Valores de propriedade
IotHubs
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.Devices/IotHubs' |
| apiVersion | A versão da API do recurso | '2022-11-15-preview' |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3 a 50 Caracteres válidos: Caracteres alfanuméricos e hifens. Não pode terminar com hífen. O nome do recurso deve ser exclusivo no Azure. |
| local | O local do recurso. | cadeia de caracteres (obrigatório) |
| marcas | As marcas do recurso. | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| sku | Informações de SKU do IotHub | IotHubSkuInfo (obrigatório) |
| 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 de ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| properties | Propriedades do IotHub | IotHubProperties |
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á todas as identidades do serviço. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dicionário de {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ArmUserIdentity |
ArmUserIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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 da nuvem para o dispositivo do Hub IoT. | CloudToDeviceProperties |
| comments | Comentários do Hub IoT. | string |
| deviceStreams | O dispositivo transmite as propriedades do iothub. | IotHubPropertiesDeviceStreams |
| 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, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação. | bool |
| disableModuleSAS | Se for true, todas as chaves SAS no escopo do 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 |
| criptografia | As propriedades de criptografia para o Hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave deve estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
| recursos | As funcionalidades e os recursos habilitados para o Hub IoT. | 'DeviceManagement' 'None' |
| ipFilterRules | As regras de filtro ip. | IpFilterRule[] |
| ipVersion | Essa propriedade especifica a versão de IP que o hub está utilizando no momento. | 'ipv4' 'ipv4ipv6' 'ipv6' |
| 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 do TLS abaixo da 1.2 sejam rejeitados. | string |
| 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' 'Enabled' |
| restrictOutboundNetworkAccess | Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList. | bool |
| rootCertificate | Essas informações relacionadas ao certificado raiz do repositório de propriedades | RootCertificateProperties |
| roteamento | As propriedades relacionadas ao roteamento do Hub IoT. Confira: /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 |
SharedAccessSignatureAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
CloudToDeviceProperties
| Nome | Descrição | Valor |
|---|---|---|
| defaultTtlAsIso8601 | O tempo de vida padrão para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| comentários | As propriedades da fila de comentários para mensagens da nuvem para o dispositivo. | FeedbackProperties |
| maxDeliveryCount | A contagem máxima de entrega para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
ComentáriosPropriedades
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
| Nome | Descrição | Valor |
|---|---|---|
| streamingEndpoints | Lista de pontos de extremidade de fluxos de dispositivo. | string[] |
EncryptionPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| keySource | A origem da chave. | string |
| keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Nome | Descrição | Valor |
|---|---|---|
| identidade | Propriedades de identidade gerenciada da chave KeyVault. | ManagedIdentity |
| keyIdentifier | O identificador da chave. | string |
ManagedIdentity
| Nome | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída pelo usuário. | string |
IotHubPropertiesEventHubEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | EventHubProperties |
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. Confira: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
| retentionTimeInDays | O tempo de retenção para mensagens de dispositivo para nuvem em dias. Confira: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | INT |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | 'Accept' '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) |
IotHubPropertiesMessagingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | MessagingEndpointProperties |
MessagingEndpointProperties
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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 conjunto de regras de rede | 'Allow' 'Deny' |
| ipRules | Lista de regras de IP | NetworkRuleSetIpRule[] (obrigatório) |
NetworkRuleSetIpRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | Ação de filtro IP | 'Allow' |
| 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) |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | string |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| status | O status de uma conexão de ponto de extremidade privado | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' (obrigatório) |
RootCertificateProperties
| Nome | Descrição | Valor |
|---|---|---|
| enableRootCertificateV2 | Essa propriedade, quando definida como true, o hub usará o certificado G2; enquanto é definido como false, hub usa Baltimore Cert. | bool |
RoutingProperties
| Nome | Descrição | Valor |
|---|---|---|
| pontos de extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 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. Confira: 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" são atendidas. Esse é um parâmetro opcional. Quando essa propriedade não está definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | 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. No máximo 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[] |
RoutingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| cosmosDBSqlCollections | A lista de pontos de extremidade de coleção 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 da 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[] |
RoutingCosmosDBSqlApiProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade da coleção sql do Cosmos DB | 'identityBased' 'keyBased' |
| collectionName | O nome da coleção sql 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) |
| id | Id do ponto de extremidade da coleção sql do Cosmos DB | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade da coleção cosmos DB de roteamento. | ManagedIdentity |
| name | 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | O nome da chave de partição associada a essa coleção de sql do cosmos DB, se houver uma. Esse é um parâmetro opcional. | string |
| partitionKeyTemplate | O modelo para gerar um valor de chave de partição sintética para uso com essa coleção de 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 os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado. | string |
| primaryKey | A chave primária da conta do cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| resourceGroup | O nome do grupo de recursos da conta do cosmos DB. | string |
| secondaryKey | A chave secundária da conta do cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| subscriptionId | O identificador de assinatura da conta do Cosmos DB. | string |
RoutingEventHubProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade do hub de eventos | 'identityBased' 'keyBased' |
| connectionString | O cadeia de conexão do ponto de extremidade do hub de eventos. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome do hub de eventos no namespace do hub de eventos | string |
| id | ID do ponto de extremidade do hub de eventos | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | string |
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 | O cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no namespace do barramento de serviço | string |
| id | ID do ponto de extremidade da fila do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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 da fila. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | string |
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 | O cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no tópico do barramento de serviço | string |
| id | ID do ponto de extremidade do tópico do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | string |
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 | O cadeia de conexão da conta de armazenamento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
| codificando | 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:// |
string |
| fileNameFormat | Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
| id | ID do ponto de extremidade do contêiner de armazenamento | string |
| 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 |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
| subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnrichmentProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointNames | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) Restrições: Comprimento mínimo = 1 |
| chave | A chave ou o nome da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
| value | O valor da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
FallbackRouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| name | 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. | string |
| source | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'MqttBrokerMessages' 'TwinChangeEvents' (obrigatório) |
RouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| name | 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| source | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'MqttBrokerMessages' 'TwinChangeEvents' (obrigatório) |
IotHubPropertiesStorageEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | StorageEndpointProperties |
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 | O cadeia de conexão para a conta de Armazenamento do Azure na 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 cretável usando 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 de tempo para o qual o URI sas gerado por Hub IoT para upload de arquivo é válido. Confira: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| ALOCADA | O número de unidades de Hub IoT provisionadas. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | O nome da SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obrigatório) |
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 Hub IOT e um simulador de borda do Ubuntu |
Este modelo cria um Hub IOT e um simulador de borda do Ubuntu da Máquina Virtual. |
| Usar o modelo do ARM para criar 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. |
| Criar um serviço de provisionamento de dispositivos Hub IoT |
Esse modelo permite que você crie um hub IoT e um Hub IoT Serviço de Provisionamento de Dispositivos e vincule os dois serviços. |
| Criar um Hub IoT e um Grupo de Consumidores de Dispositivo para Nuvem |
Esse modelo permite que você implante uma instância de Hub IoT com configurações de mensagens de dispositivo para nuvem e nuvem e um dispositivo para o grupo de consumidores de nuvem. |
| Criar Atualização de Dispositivo para Hub IoT conta, instância Hub IoT |
Esse modelo cria uma conta e uma instância e um hub com o qual 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 de 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. |
| Criar um ambiente PAYG (Pagamento Conforme o Uso) com um Hub IoT |
Este modelo permite que você implante um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso IotHubs pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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@2022-11-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
enableFileUploadNotifications = bool
encryption = {
keySource = "string"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyIdentifier = "string"
}
]
}
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
ipVersion = "string"
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
rootCertificate = {
enableRootCertificateV2 = bool
}
routing = {
endpoints = {
cosmosDBSqlCollections = [
{
authenticationType = "string"
collectionName = "string"
databaseName = "string"
endpointUri = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Valores de propriedade
IotHubs
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Devices/IotHubs@2022-11-15-preview" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3 a 50 Caracteres válidos: Caracteres alfanuméricos e hifens. Não pode terminar com hífen. O nome do recurso deve ser exclusivo no Azure. |
| local | O local do recurso. | cadeia de caracteres (obrigatório) |
| parent_id | Para implantar em um grupo de recursos, use a ID desse grupo de recursos. | cadeia de caracteres (obrigatório) |
| marcas | As marcas do recurso. | Dicionário de nomes e valores de marcas. |
| sku | Informações de SKU do IotHub | IotHubSkuInfo (obrigatório) |
| 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 de ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| properties | Propriedades do IotHub | IotHubProperties |
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á todas as identidades do serviço. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | Dicionário de {ArmUserIdentity} | Matriz de IDs de identidade do usuário. |
ArmIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ArmUserIdentity |
ArmUserIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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 |
| comments | Comentários do Hub IoT. | string |
| deviceStreams | O dispositivo transmite as propriedades do iothub. | IotHubPropertiesDeviceStreams |
| 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, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação. | bool |
| disableModuleSAS | Se for true, todas as chaves SAS no escopo do 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 |
| criptografia | As propriedades de criptografia para o hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave precisa estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
| recursos | Os recursos e recursos habilitados para o Hub IoT. | "DeviceManagement" "None" |
| ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
| ipVersion | Essa propriedade especifica a versão de IP que o hub está utilizando no momento. | "ipv4" "ipv4ipv6" "ipv6" |
| 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 do TLS abaixo da 1.2 sejam rejeitados. | string |
| 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 |
| rootCertificate | Essas informações relacionadas ao certificado raiz do repositório de propriedades | RootCertificateProperties |
| roteamento | As propriedades relacionadas ao roteamento do hub IoT. Confira: /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 |
SharedAccessSignatureAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
| keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
| primaryKey | A chave principal. | string |
| 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. | string |
CloudToDeviceProperties
| Nome | Descrição | Valor |
|---|---|---|
| defaultTtlAsIso8601 | O tempo de vida padrão para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| comentários | As propriedades da fila de comentários para mensagens da nuvem para o dispositivo. | FeedbackProperties |
| maxDeliveryCount | A contagem máxima de entrega para mensagens da nuvem para o dispositivo na fila do dispositivo. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Restrições: Valor mínimo = 1 Valor máximo = 100 |
FeedbackProperties
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Confira: /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. Confira: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
| Nome | Descrição | Valor |
|---|---|---|
| streamingEndpoints | Lista de pontos de extremidade de fluxos de dispositivo. | string[] |
EncryptionPropertiesDescription
| Nome | Descrição | Valor |
|---|---|---|
| keySource | A origem da chave. | string |
| keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Nome | Descrição | Valor |
|---|---|---|
| identidade | Propriedades de identidade gerenciada da chave KeyVault. | ManagedIdentity |
| keyIdentifier | O identificador da chave. | string |
ManagedIdentity
| Nome | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída pelo usuário. | string |
IotHubPropertiesEventHubEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | EventHubProperties |
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. Confira: /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. Confira: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | INT |
IpFilterRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por essa regra. | "Aceitar" "Rejeitar" (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) |
IotHubPropertiesMessagingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | MessagingEndpointProperties |
MessagingEndpointProperties
| Nome | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Confira: /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. Confira: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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 conjunto de regras de rede | "Permitir" "Negar" |
| ipRules | Lista de regras de IP | NetworkRuleSetIpRule[] (obrigatório) |
NetworkRuleSetIpRule
| Nome | Descrição | Valor |
|---|---|---|
| ação | Ação de 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) |
PrivateEndpointConnection
| Nome | Descrição | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
| Nome | Descrição | Valor |
|---|---|---|
| actionsRequired | Ações necessárias para uma conexão de ponto de extremidade privado | string |
| descrição | A descrição do estado atual de uma conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
| status | O status de uma conexão de ponto de extremidade privado | "Aprovado" "Desconectado" "Pendente" "Rejeitado" (obrigatório) |
RootCertificateProperties
| Nome | Descrição | Valor |
|---|---|---|
| enableRootCertificateV2 | Essa propriedade, quando definida como true, o hub usará o certificado G2; enquanto é definido como false, hub usa Baltimore Cert. | bool |
RoutingProperties
| Nome | Descrição | Valor |
|---|---|---|
| pontos de extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 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. Confira: 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" são atendidas. Esse é um parâmetro opcional. Quando essa propriedade não está definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | 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. No máximo 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[] |
RoutingEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| cosmosDBSqlCollections | A lista de pontos de extremidade de coleção 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 da 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[] |
RoutingCosmosDBSqlApiProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade da coleção sql do Cosmos DB | "identityBased" "keyBased" |
| collectionName | O nome da coleção sql 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) |
| id | ID do ponto de extremidade da coleção sql do Cosmos DB | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade de coleção do Cosmos DB de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | O nome da chave de partição associada a essa coleção sql do Cosmos DB, se houver. Esse é um parâmetro opcional. | string |
| partitionKeyTemplate | O modelo para gerar um valor de chave de partição sintética para uso com essa coleção 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 os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado. | string |
| primaryKey | A chave primária da conta do Cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| resourceGroup | O nome do grupo de recursos da conta do Cosmos DB. | string |
| secondaryKey | A chave secundária da conta do Cosmos DB. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| subscriptionId | O identificador de assinatura da conta do Cosmos DB. | string |
RoutingEventHubProperties
| Nome | Descrição | Valor |
|---|---|---|
| authenticationType | Método usado para autenticar no ponto de extremidade do hub de eventos | "identityBased" "keyBased" |
| connectionString | O cadeia de conexão do ponto de extremidade do hub de eventos. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome do hub de eventos no namespace do hub de eventos | string |
| id | ID do ponto de extremidade do hub de eventos | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | string |
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 | O cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no namespace do barramento de serviço | string |
| id | ID do ponto de extremidade da fila do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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 da fila. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | string |
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 | O cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| endpointUri | A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb:// | string |
| entityPath | Nome da fila no tópico do barramento de serviço | string |
| id | ID do ponto de extremidade do tópico do barramento de serviço | string |
| identidade | Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento. | ManagedIdentity |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | string |
| subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | string |
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 | O cadeia de conexão da conta de armazenamento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
| codificando | 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:// |
string |
| fileNameFormat | Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
| id | ID do ponto de extremidade do contêiner de armazenamento | string |
| 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 |
| name | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, 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. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
| subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnrichmentProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointNames | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) Restrições: Comprimento mínimo = 1 |
| chave | A chave ou o nome da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
| value | O valor da propriedade de enriquecimento. | cadeia de caracteres (obrigatório) |
FallbackRouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string |
| source | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Inválido" "MqttBrokerMessages" "TwinChangeEvents" (obrigatório) |
RouteProperties
| Nome | Descrição | Valor |
|---|---|---|
| condition | 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 | string |
| 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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | cadeia de caracteres (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ |
| source | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Inválido" "MqttBrokerMessages" "TwinChangeEvents" (obrigatório) |
IotHubPropertiesStorageEndpoints
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | StorageEndpointProperties |
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 | O cadeia de conexão para a conta de Armazenamento do Azure na qual os arquivos são carregados. | cadeia de caracteres (obrigatório) |
| containerName | O nome do contêiner raiz no qual você carrega arquivos. O contêiner não precisa existir, mas deve ser cretável usando 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 de tempo para o qual o URI de SAS gerado por Hub IoT para upload de arquivo é válido. Confira: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
| Nome | Descrição | Valor |
|---|---|---|
| ALOCADA | O número de unidades de Hub IoT provisionadas. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | O nome da SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (obrigatório) |