Microsoft.Devices IotHubs 2023-06-30
- Últimas
- 2023-06-30
- 2023-06-30-preview
- 2022-11-15-preview
- 2022-04-30-preview
- 2021-07-02
- 2021-07-02-preview
- 2021-07-01
- 2021-07-01-preview
- 2021-03-31
- 2021-03-03-preview
- 2021-02-01-preview
- 2020-08-31
- 2020-08-31-preview
- 2020-08-01
- 2020-07-10-preview
- 2020-06-15
- 2020-04-01
- 2020-03-01
- 2019-11-04
- 2019-07-01-preview
- 2019-03-22
- 2019-03-22-preview
- 2018-12-01-preview
- 2018-04-01
- 2018-01-22
- 2017-07-01
- 2017-01-19
- 2016-02-03
Definição de recursos do bíceps
O tipo de recurso IotHubs pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
enableFileUploadNotifications: bool
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
routing: {
endpoints: {
cosmosDBSqlContainers: [
{
authenticationType: 'string'
containerName: 'string'
databaseName: 'string'
endpointUri: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
ArmIdentity
| Designação | 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 'Nenhum' removerá todas as identidades do serviço. | 'Nenhuma' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dicionário de <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Designação | Descrição | Valor |
|---|
ArmUserIdentity
| Designação | Descrição | Valor |
|---|
CloudToDeviceProperties
| Designação | Descrição | Valor |
|---|---|---|
| padrãoTtlAsIso8601 | O tempo de vida padrão para mensagens de nuvem para dispositivo na fila de dispositivos. Consulte: /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 de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EnriquecimentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| endpointNomes | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) |
| chave | A chave ou o nome da propriedade de enriquecimento. | string (obrigatório) |
| valor | O valor da propriedade de enriquecimento. | string (obrigatório) |
EventHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| partitionCount | O número de partições para receber mensagens de dispositivo para nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retençãoTimeInDays | O tempo de retenção de mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como verdadeira por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas 1 ponto final é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string |
| fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| allowedFqdnList | Lista de FQDNs (Fully Qualified Domain Name) permitidos para saída do Iot Hub. | string[] |
| authorizationPolíticas | 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 |
| Observações | Comentários do hub IoT. | string |
| disableDeviceSAS | Se verdadeiro, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos de Borda, mas excluindo módulos) não podem ser usadas para autenticação. | Bool |
| disableLocalAuth | Se verdadeiro, os tokens SAS com chaves SAS com escopo do hub Iot não podem ser usados para autenticação. | Bool |
| disableModuleSAS | Se verdadeiro, todas as chaves SAS com escopo de módulo não podem ser usadas para autenticação. | Bool |
| enableDataResidency | Essa propriedade, quando definida como true, habilitará a residência de dados, desativando a recuperação de desastres. | Bool |
| enableFileUploadNotifications | Se True, as notificações de upload de arquivo estão habilitadas. | Bool |
| eventHubEndpoints | As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para este 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 |
| caraterísticas | Os recursos habilitados para o hub IoT. | 'Gerenciamento de dispositivos' 'Nenhuma' |
| ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
| mensagensPontos de extremidade | As propriedades do ponto de extremidade de mensagens para a fila de notificação de carregamento de arquivo. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados. | string |
| networkRuleSets | Propriedades do conjunto de regras de rede do IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
| restrictOutboundNetworkAccess | Se true, a saída do IotHub será restrita apenas aos FQDNs permitidos que são configurados via allowedFqdnList. | Bool |
| Roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure onde você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e essa DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja lançado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications está definida como True, faz com que um erro seja lançado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesMessagingEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesStorageEndpoints
| Designação | Descrição | Valor |
|---|
IotHubSkuInfo
| Designação | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades provisionadas do Hub IoT. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Designação | O nome do SKU. | «B1» «B2» 'B3' 'F1' «S1» «S2» «S3» (obrigatório) |
IpFilterRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
| filterName | O nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
Identidade gerenciada
| Designação | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída ao usuário. | string |
MessagingEndpointProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
Microsoft.Devices/IotHubs
| Designação | Descrição | Valor |
|---|---|---|
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também deve ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| Localização | A localização do recurso. | string (obrigatório) |
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Propriedades do IotHub | IotHubProperties |
| SKU | Informações sobre o SKU do IotHub | IotHubSkuInfo (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
NetworkRuleSetIpRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | Ação de filtro IP | 'Permitir' |
| filterName | Nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
NetworkRuleSetProperties
| Designação | Descrição | Valor |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
| defaultAction | Ação padrão para o conjunto de regras de rede | 'Permitir' 'Negar' |
| ipRegras | Lista de regras de PI | NetworkRuleSetIpRule[] (obrigatório) |
PrivateEndpoint
| Designação | Descrição | Valor |
|---|
PrivateEndpointConnection
| Designação | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Designação | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateLinkServiceConnectionState
| Designação | Descrição | Valor |
|---|---|---|
| açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
| Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
| Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Tags de Recursos
| Designação | Descrição | Valor |
|---|
RotaPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
| fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Designação | Descrição | Valor |
|---|---|---|
| cosmosDBSqlContainers | A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingCosmosDBSqlApiProperties[] |
| Centros de eventos | A lista de pontos de extremidade de Hubs de Eventos para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. Esta lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
| serviceBusFilas | A lista de pontos de extremidade de fila do Service Bus 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 Service Bus para os quais o hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
| armazenagemContentores | A lista de pontos de extremidade de contêiner de armazenamento para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoteamentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| parâmetros de avaliação final | As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | RoutingEndpoints |
| enriquecimento | A lista de enriquecimentos fornecidos pelo usuário que o hub IoT aplica a mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Este é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão. | FallbackRouteProperties |
| Rotas | A lista de regras de roteamento fornecidas pelo usuário que o hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Designação | Descrição | Valor |
|---|---|---|
| Nome da chave | O nome da política de acesso compartilhado. | string (obrigatório) |
| primárioChave | A chave primária. | 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) |
| secundário | A chave secundária. | string |
StorageEndpointPropriedades
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Criar um Hub IoT e um Grupo de Consumidores de Dispositivo para Nuvem | Este modelo permite implantar uma instância do Hub IoT com configurações de mensagens dispositivo para nuvem e nuvem para dispositivo e um grupo de consumidores dispositivo para nuvem. |
| Criar um Serviço de Provisionamento de Dispositivo do Hub IoT | Este modelo permite criar um hub IoT e um Serviço de Provisionamento de Dispositivo do Hub IoT e vincular os dois serviços. |
| Criar atualização de dispositivo para a conta do Hub IoT, instância, do Hub IoT | Esse modelo cria uma conta e uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, rotas e 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 Saúde do Azure projetados para ingerir dados de dispositivos de vários dispositivos, transformar os dados do dispositivo em Observações FHIR, que são então persistidas no serviço FHIR dos Serviços de Dados de Saúde do Azure. |
| Use o modelo ARM para criar o Hub IoT, rotear e exibir mensagens | Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, visualize os resultados. |
Definição de recurso de modelo ARM
O tipo de recurso IotHubs pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2023-06-30",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"enableFileUploadNotifications": "bool",
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"routing": {
"endpoints": {
"cosmosDBSqlContainers": [
{
"authenticationType": "string",
"containerName": "string",
"databaseName": "string",
"endpointUri": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
ArmIdentity
| Designação | 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 'Nenhum' removerá todas as identidades do serviço. | 'Nenhuma' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dicionário de <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Designação | Descrição | Valor |
|---|
ArmUserIdentity
| Designação | Descrição | Valor |
|---|
CloudToDeviceProperties
| Designação | Descrição | Valor |
|---|---|---|
| padrãoTtlAsIso8601 | O tempo de vida padrão para mensagens de nuvem para dispositivo na fila de dispositivos. Consulte: /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 de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EnriquecimentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| endpointNomes | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) |
| chave | A chave ou o nome da propriedade de enriquecimento. | string (obrigatório) |
| valor | O valor da propriedade de enriquecimento. | string (obrigatório) |
EventHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| partitionCount | O número de partições para receber mensagens de dispositivo para nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retençãoTimeInDays | O tempo de retenção de mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como verdadeira por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas 1 ponto final é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string |
| fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| allowedFqdnList | Lista de FQDNs (Fully Qualified Domain Name) permitidos para saída do Iot Hub. | string[] |
| authorizationPolíticas | 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 |
| Observações | Comentários do hub IoT. | string |
| disableDeviceSAS | Se verdadeiro, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos de Borda, mas excluindo módulos) não podem ser usadas para autenticação. | Bool |
| disableLocalAuth | Se verdadeiro, os tokens SAS com chaves SAS com escopo do hub Iot não podem ser usados para autenticação. | Bool |
| disableModuleSAS | Se verdadeiro, todas as chaves SAS com escopo de módulo não podem ser usadas para autenticação. | Bool |
| enableDataResidency | Essa propriedade, quando definida como true, habilitará a residência de dados, desativando a recuperação de desastres. | Bool |
| enableFileUploadNotifications | Se True, as notificações de upload de arquivo estão habilitadas. | Bool |
| eventHubEndpoints | As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para este 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 |
| caraterísticas | Os recursos habilitados para o hub IoT. | 'Gerenciamento de dispositivos' 'Nenhuma' |
| ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
| mensagensPontos de extremidade | As propriedades do ponto de extremidade de mensagens para a fila de notificação de carregamento de arquivo. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados. | string |
| networkRuleSets | Propriedades do conjunto de regras de rede do IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
| restrictOutboundNetworkAccess | Se true, a saída do IotHub será restrita apenas aos FQDNs permitidos que são configurados via allowedFqdnList. | Bool |
| Roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure onde você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e essa DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja lançado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications está definida como True, faz com que um erro seja lançado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesMessagingEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesStorageEndpoints
| Designação | Descrição | Valor |
|---|
IotHubSkuInfo
| Designação | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades provisionadas do Hub IoT. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Designação | O nome do SKU. | «B1» «B2» 'B3' 'F1' «S1» «S2» «S3» (obrigatório) |
IpFilterRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
| filterName | O nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
Identidade gerenciada
| Designação | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída ao usuário. | string |
MessagingEndpointProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
Microsoft.Devices/IotHubs
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2023-06-30' |
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também deve ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| Localização | A localização do recurso. | string (obrigatório) |
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Propriedades do IotHub | IotHubProperties |
| SKU | Informações sobre o SKU do IotHub | IotHubSkuInfo (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo | O tipo de recurso | 'Microsoft.Devices/IotHubs' |
NetworkRuleSetIpRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | Ação de filtro IP | 'Permitir' |
| filterName | Nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
NetworkRuleSetProperties
| Designação | Descrição | Valor |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
| defaultAction | Ação padrão para o conjunto de regras de rede | 'Permitir' 'Negar' |
| ipRegras | Lista de regras de PI | NetworkRuleSetIpRule[] (obrigatório) |
PrivateEndpoint
| Designação | Descrição | Valor |
|---|
PrivateEndpointConnection
| Designação | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Designação | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateLinkServiceConnectionState
| Designação | Descrição | Valor |
|---|---|---|
| açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
| Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
| Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Tags de Recursos
| Designação | Descrição | Valor |
|---|
RotaPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
| fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Designação | Descrição | Valor |
|---|---|---|
| cosmosDBSqlContainers | A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingCosmosDBSqlApiProperties[] |
| Centros de eventos | A lista de pontos de extremidade de Hubs de Eventos para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. Esta lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
| serviceBusFilas | A lista de pontos de extremidade de fila do Service Bus 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 Service Bus para os quais o hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
| armazenagemContentores | A lista de pontos de extremidade de contêiner de armazenamento para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoteamentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| parâmetros de avaliação final | As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | RoutingEndpoints |
| enriquecimento | A lista de enriquecimentos fornecidos pelo usuário que o hub IoT aplica a mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Este é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão. | FallbackRouteProperties |
| Rotas | A lista de regras de roteamento fornecidas pelo usuário que o hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Designação | Descrição | Valor |
|---|---|---|
| Nome da chave | O nome da política de acesso compartilhado. | string (obrigatório) |
| primárioChave | A chave primária. | 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) |
| secundário | A chave secundária. | string |
StorageEndpointPropriedades
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar um ambiente Pay As You Go (PAYG) com um Hub IoT
|
Este modelo permite implantar um ambiente Pay As You Go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT. |
|
Criar um Hub IoT e um Grupo de Consumidores de Dispositivo para Nuvem
|
Este modelo permite implantar uma instância do Hub IoT com configurações de mensagens dispositivo para nuvem e nuvem para dispositivo e um grupo de consumidores dispositivo para nuvem. |
|
Crie um Hub IOT e um simulador de borda do Ubuntu
|
Este modelo cria um Hub IOT e um simulador de borda Ubuntu de máquina virtual. |
|
Criar um Serviço de Provisionamento de Dispositivo do Hub IoT
|
Este modelo permite criar um hub IoT e um Serviço de Provisionamento de Dispositivo do Hub IoT e vincular os dois serviços. |
|
Criar atualização de dispositivo para a conta do Hub IoT, instância, do Hub IoT
|
Esse modelo cria uma conta e uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, rotas e 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 Saúde do Azure projetados para ingerir dados de dispositivos de vários dispositivos, transformar os dados do dispositivo em Observações FHIR, que são então persistidas no serviço FHIR dos Serviços de Dados de Saúde do Azure. |
|
Use o modelo ARM para criar o Hub IoT, rotear e exibir mensagens
|
Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, visualize os resultados. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso IotHubs pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2023-06-30"
name = "string"
etag = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
routing = {
endpoints = {
cosmosDBSqlContainers = [
{
authenticationType = "string"
containerName = "string"
databaseName = "string"
endpointUri = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
})
}
Valores de propriedade
ArmIdentity
| Designação | 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 'Nenhum' removerá todas as identidades do serviço. | 'Nenhuma' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dicionário de <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Designação | Descrição | Valor |
|---|
ArmUserIdentity
| Designação | Descrição | Valor |
|---|
CloudToDeviceProperties
| Designação | Descrição | Valor |
|---|---|---|
| padrãoTtlAsIso8601 | O tempo de vida padrão para mensagens de nuvem para dispositivo na fila de dispositivos. Consulte: /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 de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EnriquecimentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| endpointNomes | A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. | string[] (obrigatório) |
| chave | A chave ou o nome da propriedade de enriquecimento. | string (obrigatório) |
| valor | O valor da propriedade de enriquecimento. | string (obrigatório) |
EventHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| partitionCount | O número de partições para receber mensagens de dispositivo para nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retençãoTimeInDays | O tempo de retenção de mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como verdadeira por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas 1 ponto final é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string |
| fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubProperties
| Designação | Descrição | Valor |
|---|---|---|
| allowedFqdnList | Lista de FQDNs (Fully Qualified Domain Name) permitidos para saída do Iot Hub. | string[] |
| authorizationPolíticas | 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 |
| Observações | Comentários do hub IoT. | string |
| disableDeviceSAS | Se verdadeiro, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos de Borda, mas excluindo módulos) não podem ser usadas para autenticação. | Bool |
| disableLocalAuth | Se verdadeiro, os tokens SAS com chaves SAS com escopo do hub Iot não podem ser usados para autenticação. | Bool |
| disableModuleSAS | Se verdadeiro, todas as chaves SAS com escopo de módulo não podem ser usadas para autenticação. | Bool |
| enableDataResidency | Essa propriedade, quando definida como true, habilitará a residência de dados, desativando a recuperação de desastres. | Bool |
| enableFileUploadNotifications | Se True, as notificações de upload de arquivo estão habilitadas. | Bool |
| eventHubEndpoints | As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para este 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 |
| caraterísticas | Os recursos habilitados para o hub IoT. | 'Gerenciamento de dispositivos' 'Nenhuma' |
| ipFilterRules | As regras de filtro IP. | IpFilterRule[] |
| mensagensPontos de extremidade | As propriedades do ponto de extremidade de mensagens para a fila de notificação de carregamento de arquivo. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados. | string |
| networkRuleSets | Propriedades do conjunto de regras de rede do IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Conexões de ponto de extremidade privadas criadas neste IotHub | PrivateEndpointConnection [] |
| publicNetworkAccess | Se as solicitações da Rede Pública são permitidas | 'Desativado' 'Habilitado' |
| restrictOutboundNetworkAccess | Se true, a saída do IotHub será restrita apenas aos FQDNs permitidos que são configurados via allowedFqdnList. | Bool |
| Roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure onde você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e essa DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja lançado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications está definida como True, faz com que um erro seja lançado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesMessagingEndpoints
| Designação | Descrição | Valor |
|---|
IotHubPropertiesStorageEndpoints
| Designação | Descrição | Valor |
|---|
IotHubSkuInfo
| Designação | Descrição | Valor |
|---|---|---|
| capacidade | O número de unidades provisionadas do Hub IoT. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Designação | O nome do SKU. | «B1» «B2» 'B3' 'F1' «S1» «S2» «S3» (obrigatório) |
IpFilterRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | A ação desejada para solicitações capturadas por esta regra. | 'Aceitar' «Rejeitar» (obrigatório) |
| filterName | O nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
Identidade gerenciada
| Designação | Descrição | Valor |
|---|---|---|
| userAssignedIdentity | A identidade atribuída ao usuário. | string |
MessagingEndpointProperties
| Designação | Descrição | Valor |
|---|---|---|
| lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
| maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Restrições: Valor mínimo = 1 Valor máximo = 100 |
| ttlAsIso8601 | O período de tempo durante o qual uma mensagem está disponível para consumo antes de expirar pelo hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
Microsoft.Devices/IotHubs
| Designação | Descrição | Valor |
|---|---|---|
| etag | O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também deve ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | string |
| identidade | As identidades gerenciadas para o IotHub. | ArmIdentity |
| Localização | A localização do recurso. | string (obrigatório) |
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Propriedades do IotHub | IotHubProperties |
| SKU | Informações sobre o SKU do IotHub | IotHubSkuInfo (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. |
| tipo | O tipo de recurso | "Microsoft.Devices/IotHubs@2023-06-30" |
NetworkRuleSetIpRule
| Designação | Descrição | Valor |
|---|---|---|
| ação | Ação de filtro IP | 'Permitir' |
| filterName | Nome da regra de filtro IP. | string (obrigatório) |
| ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | string (obrigatório) |
NetworkRuleSetProperties
| Designação | Descrição | Valor |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
| defaultAction | Ação padrão para o conjunto de regras de rede | 'Permitir' 'Negar' |
| ipRegras | Lista de regras de PI | NetworkRuleSetIpRule[] (obrigatório) |
PrivateEndpoint
| Designação | Descrição | Valor |
|---|
PrivateEndpointConnection
| Designação | Descrição | Valor |
|---|---|---|
| propriedades | As propriedades de uma conexão de ponto de extremidade privada | PrivateEndpointConnectionProperties (obrigatório) |
PrivateEndpointConnectionProperties
| Designação | Descrição | Valor |
|---|---|---|
| privateEndpoint | A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada | PrivateEndpoint |
| privateLinkServiceConnectionState | O estado atual de uma conexão de ponto de extremidade privado | PrivateLinkServiceConnectionState (obrigatório) |
PrivateLinkServiceConnectionState
| Designação | Descrição | Valor |
|---|---|---|
| açõesObrigatório | Ações necessárias para uma conexão de ponto de extremidade privada | string |
| Descrição | A descrição do estado atual de uma conexão de ponto de extremidade privada | string (obrigatório) |
| Situação | O status de uma conexão de ponto de extremidade privada | 'Aprovado' 'Desconectado' 'Pendente' «Rejeitado» (obrigatório) |
Tags de Recursos
| Designação | Descrição | Valor |
|---|
RotaPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | string |
| endpointNomes | A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
| isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
| Designação | O nome da rota. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | string Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
| fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'MensagensDispositivo' 'Inválido' 'TwinChangeEvents' (obrigatório) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Designação | Descrição | Valor |
|---|---|---|
| cosmosDBSqlContainers | A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingCosmosDBSqlApiProperties[] |
| Centros de eventos | A lista de pontos de extremidade de Hubs de Eventos para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. Esta lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
| serviceBusFilas | A lista de pontos de extremidade de fila do Service Bus 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 Service Bus para os quais o hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
| armazenagemContentores | A lista de pontos de extremidade de contêiner de armazenamento para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoteamentoPropriedades
| Designação | Descrição | Valor |
|---|---|---|
| parâmetros de avaliação final | As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | RoutingEndpoints |
| enriquecimento | A lista de enriquecimentos fornecidos pelo usuário que o hub IoT aplica a mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Este é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão. | FallbackRouteProperties |
| Rotas | A lista de regras de roteamento fornecidas pelo usuário que o hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Designação | Descrição | Valor |
|---|---|---|
| Nome da chave | O nome da política de acesso compartilhado. | string (obrigatório) |
| primárioChave | A chave primária. | 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) |
| secundário | A chave secundária. | string |