Partilhar via

Microsoft.Devices IotHubs 2019-03-22

  • Artigo

Definição de recursos do bíceps

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

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@2019-03-22' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    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'
      }
    }
    routing: {
      endpoints: {
        eventHubs: [
          {
            connectionString: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            connectionString: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            connectionString: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            fileNameFormat: 'string'
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: '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}: {
        connectionString: 'string'
        containerName: 'string'
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

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

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 '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
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
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
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)

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

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. 'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'MensagensDispositivo'
'Inválido'
'TwinChangeEvents' (obrigatório)

RoutingEndpoints

Designação Descrição Valor
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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do hub de eventos. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

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
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 é 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 do eventhub interno. 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
batchFrequencyInSeconds Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos. Int

Restrições:
Valor mínimo = 60
Valor máximo = 720
connectionString A cadeia de conexão da conta de armazenamento. string (obrigatório)
containerName O nome do contêiner de armazenamento na conta de armazenamento. string (obrigatório)
codificação Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'. 'Avro'
'AvroDeflate'
'JSON'
fileNameFormat Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. string
maxChunkSizeInBytes Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor padrão é 314572800(300MB). Int

Restrições:
Valor mínimo = 10485760
Valor máximo = 524288000
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] O nome do grupo de recursos da conta de armazenamento. string
subscriptionId O identificador de assinatura da conta de armazenamento. string

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

Designação Descrição Valor
connectionString A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados. string (obrigatório)
containerName O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado. string (obrigatório)
sasTtlAsIso8601 O período de tempo durante o qual o URI SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. string

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:

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": "2019-03-22",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "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"
      }
    },
    "routing": {
      "endpoints": {
        "eventHubs": [
          {
            "connectionString": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "connectionString": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "connectionString": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "fileNameFormat": "string",
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "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}": {
        "connectionString": "string",
        "containerName": "string",
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

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

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 '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
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
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
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)

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 '2019-03-22'
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
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'

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. 'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'MensagensDispositivo'
'Inválido'
'TwinChangeEvents' (obrigatório)

RoutingEndpoints

Designação Descrição Valor
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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do hub de eventos. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

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
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 é 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 do eventhub interno. 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
batchFrequencyInSeconds Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos. Int

Restrições:
Valor mínimo = 60
Valor máximo = 720
connectionString A cadeia de conexão da conta de armazenamento. string (obrigatório)
containerName O nome do contêiner de armazenamento na conta de armazenamento. string (obrigatório)
codificação Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'. 'Avro'
'AvroDeflate'
'JSON'
fileNameFormat Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. string
maxChunkSizeInBytes Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor padrão é 314572800(300MB). Int

Restrições:
Valor mínimo = 10485760
Valor máximo = 524288000
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] O nome do grupo de recursos da conta de armazenamento. string
subscriptionId O identificador de assinatura da conta de armazenamento. string

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

Designação Descrição Valor
connectionString A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados. string (obrigatório)
containerName O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado. string (obrigatório)
sasTtlAsIso8601 O período de tempo durante o qual o URI SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. string

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

Implantar no Azure 		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

Implantar no Azure 		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

Implantar no Azure 		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

Implantar no Azure 		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

Implantar no Azure 		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

Implantar no 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

Implantar no Azure 		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@2019-03-22"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      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"
        }
      }
      routing = {
        endpoints = {
          eventHubs = [
            {
              connectionString = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              connectionString = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              connectionString = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              fileNameFormat = "string"
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "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} = {
          connectionString = "string"
          containerName = "string"
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
}

Valores de propriedade

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

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 '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
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
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
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)

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
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@2019-03-22"

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. 'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'MensagensDispositivo'
'Inválido'
'TwinChangeEvents' (obrigatório)

RoutingEndpoints

Designação Descrição Valor
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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do hub de eventos. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

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
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 é 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 do eventhub interno. 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
connectionString A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. string (obrigatório)
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] 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

Designação Descrição Valor
batchFrequencyInSeconds Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos. Int

Restrições:
Valor mínimo = 60
Valor máximo = 720
connectionString A cadeia de conexão da conta de armazenamento. string (obrigatório)
containerName O nome do contêiner de armazenamento na conta de armazenamento. string (obrigatório)
codificação Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'. 'Avro'
'AvroDeflate'
'JSON'
fileNameFormat Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. string
maxChunkSizeInBytes Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor padrão é 314572800(300MB). Int

Restrições:
Valor mínimo = 10485760
Valor máximo = 524288000
Designação O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. string

Restrições:
Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório)
resourceGroup [en] O nome do grupo de recursos da conta de armazenamento. string
subscriptionId O identificador de assinatura da conta de armazenamento. string

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

Designação Descrição Valor
connectionString A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados. string (obrigatório)
containerName O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado. string (obrigatório)
sasTtlAsIso8601 O período de tempo durante o qual o URI SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. string