Microsoft.Devices IotHubs 2016-02-03
- Ú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@2016-02-03' = {
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'
}
}
operationsMonitoringProperties: {
events: {
{customized property}: 'string'
}
}
storageEndpoints: {
{customized property}: {
connectionString: 'string'
containerName: 'string'
sasTtlAsIso8601: 'string'
}
}
}
resourcegroup: 'string'
sku: {
capacity: int
name: 'string'
}
subscriptionid: '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 |
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 | Observações. | 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 chaves possíveis para este dicionário são events e operationsMonitoringEvents. Ambas as chaves precisam estar presentes 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 |
| operationsMonitoringProperties | As propriedades de monitoramento de operações para o hub IoT. As chaves possíveis para o dicionário são Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties |
| 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 (obrigatório) |
| Designação | O nome do SKU. | '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 | As propriedades de um hub IoT. | IotHubProperties |
| grupo de recursos | O nome do grupo de recursos que contém o hub IoT. Um nome de grupo de recursos identifica exclusivamente o grupo de recursos dentro da assinatura. | string (obrigatório) |
| SKU | Informações sobre o SKU do hub IoT. | IotHubSkuInfo (obrigatório) |
| ID de subscrição | O identificador de assinatura. | string (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
OperationsMonitoringProperties
| Designação | Descrição | Valor |
|---|---|---|
| Publicações | Dicionário de <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperaçõesMonitoramentoPropriedadesEventos
| Designação | Descrição | Valor |
|---|
Tags de Recursos
| Designação | Descrição | Valor |
|---|
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:
- 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": "2016-02-03",
"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"
}
},
"operationsMonitoringProperties": {
"events": {
"{customized property}": "string"
}
},
"storageEndpoints": {
"{customized property}": {
"connectionString": "string",
"containerName": "string",
"sasTtlAsIso8601": "string"
}
}
},
"resourcegroup": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"subscriptionid": "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 |
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 | Observações. | 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 chaves possíveis para este dicionário são events e operationsMonitoringEvents. Ambas as chaves precisam estar presentes 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 |
| operationsMonitoringProperties | As propriedades de monitoramento de operações para o hub IoT. As chaves possíveis para o dicionário são Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties |
| 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 (obrigatório) |
| Designação | O nome do SKU. | '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 | '2016-02-03' |
| 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 | As propriedades de um hub IoT. | IotHubProperties |
| grupo de recursos | O nome do grupo de recursos que contém o hub IoT. Um nome de grupo de recursos identifica exclusivamente o grupo de recursos dentro da assinatura. | string (obrigatório) |
| SKU | Informações sobre o SKU do hub IoT. | IotHubSkuInfo (obrigatório) |
| ID de subscrição | O identificador de assinatura. | string (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' |
OperationsMonitoringProperties
| Designação | Descrição | Valor |
|---|---|---|
| Publicações | Dicionário de <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperaçõesMonitoramentoPropriedadesEventos
| Designação | Descrição | Valor |
|---|
Tags de Recursos
| Designação | Descrição | Valor |
|---|
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
|
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@2016-02-03"
name = "string"
etag = "string"
location = "string"
resourcegroup = "string"
sku = {
capacity = int
name = "string"
}
subscriptionid = "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"
}
}
operationsMonitoringProperties = {
events = {
{customized property} = "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 |
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 | Observações. | 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 chaves possíveis para este dicionário são events e operationsMonitoringEvents. Ambas as chaves precisam estar presentes 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 |
| operationsMonitoringProperties | As propriedades de monitoramento de operações para o hub IoT. As chaves possíveis para o dicionário são Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties |
| 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 (obrigatório) |
| Designação | O nome do SKU. | '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 | As propriedades de um hub IoT. | IotHubProperties |
| grupo de recursos | O nome do grupo de recursos que contém o hub IoT. Um nome de grupo de recursos identifica exclusivamente o grupo de recursos dentro da assinatura. | string (obrigatório) |
| SKU | Informações sobre o SKU do hub IoT. | IotHubSkuInfo (obrigatório) |
| ID de subscrição | O identificador de assinatura. | string (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. |
| tipo | O tipo de recurso | "Microsoft.Devices/IotHubs@2016-02-03" |
OperationsMonitoringProperties
| Designação | Descrição | Valor |
|---|---|---|
| Publicações | Dicionário de <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperaçõesMonitoramentoPropriedadesEventos
| Designação | Descrição | Valor |
|---|
Tags de Recursos
| Designação | Descrição | Valor |
|---|
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 |