Microsoft.Devices IotHubs 2017-07-01
- última
- 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 recurso do Bicep
O tipo de recurso IotHubs pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.Devices/IotHubs@2017-07-01' = {
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'
}
}
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
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: '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
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
realimentação | As propriedades da fila de comentários para mensagens de nuvem para dispositivo. | feedbackproperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EventHubProperties
Nome | Descrição | Valor |
---|---|---|
partitionCount | O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | O tempo de retenção para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
authorizationPolicies | As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens de nuvem para dispositivo do Hub IoT. | CloudToDeviceProperties |
Comentários | Comentários do Hub IoT. | corda |
enableFileUploadNotifications | Se True, as notificações de upload de arquivo serão habilitadas. | Bool |
eventHubEndpoints | As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As chaves possíveis para esse dicionário são eventos e operationsMonitoringEvents. Ambas as chaves precisam estar presentes no dicionário ao criar ou atualizar chamadas para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
Características | Os recursos e recursos habilitados para o Hub IoT. | 'DeviceManagement' 'None' |
ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
messagingEndpoints | As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo. | IotHubPropertiesMessagingEndpoints |
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, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods. | OperationsMonitoringProperties |
roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesMessagingEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesStorageEndpoints
Nome | Descrição | Valor |
---|
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades provisionadas do Hub IoT. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | int (obrigatório) |
nome | O nome da SKU. | 'F1' 'S1' 'S2' 'S3' (obrigatório) |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
MessagingEndpointProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
Nome | Descrição | Valor |
---|---|---|
etag | O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | corda |
localização | O local do recurso. | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | cadeia de caracteres (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. | cadeia de caracteres (obrigatório) |
Sku | Informações sobre a SKU do hub IoT. | IotHubSkuInfo (obrigatório) |
subscriptionid | O identificador da assinatura. | cadeia de caracteres (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
OperationsMonitoringProperties
Nome | Descrição | Valor |
---|---|---|
Eventos | Dicionário de <> OperationMonitoringLevel | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Nome | Descrição | Valor |
---|
ResourceTags
Nome | Descrição | Valor |
---|
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
nome | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
RoutingEndpoints
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
serviceBusQueues | A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do hub de eventos. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | corda |
RoutingProperties
Nome | Descrição | Valor |
---|---|---|
Extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | |
fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | fallbackRouteProperties |
Rotas | A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties [] |
RoutingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | corda |
RoutingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | corda |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
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. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
codificação | Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro' e 'avroDeflate'. O valor padrão é 'avro'. | corda |
fileNameFormat | Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | corda |
maxChunkSizeInBytes | Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB). | int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000 |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | corda |
subscriptionId | O identificador de assinatura da conta de armazenamento. | corda |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
primaryKey | A chave primária. | corda |
direitos | As permissões atribuídas à política de acesso compartilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | corda |
StorageEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado. | cadeia de caracteres (obrigatório) |
sasTtlAsIso8601 | O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | corda |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
criar um Hub IoT e um grupo de consumidores de dispositivo para nuvem | Esse modelo permite implantar uma instância do Hub IoT com dispositivo para nuvem e nuvem para configurações de mensagens de dispositivo e um dispositivo para o grupo de consumidores de nuvem. |
criar um serviço de provisionamento de dispositivos do Hub IoT | Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos. |
Criar Atualização de Dispositivo para a conta do Hub IoT, instância, Hub IoT | Esse modelo cria uma conta, uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, as rotas e o grupo de consumidores necessários. |
implantar o serviço MedTech, incluindo um Hub IoT do Azure | O serviço MedTech é um dos Serviços de Dados de Integridade do Azure projetados para ingerir dados do dispositivo de vários dispositivos, transformar os dados do dispositivo em observações FHIR, que são então persistentes no serviço FHIR dos Serviços de Dados de Integridade do Azure. |
usar o modelo do ARM para criar o Hub IoT, rotear e exibir mensagens | Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, exiba os resultados. |
Definição de recurso de modelo do ARM
O tipo de recurso IotHubs pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o JSON a seguir ao seu modelo.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2017-07-01",
"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"
}
},
"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",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "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
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
realimentação | As propriedades da fila de comentários para mensagens de nuvem para dispositivo. | feedbackproperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EventHubProperties
Nome | Descrição | Valor |
---|---|---|
partitionCount | O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | O tempo de retenção para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
authorizationPolicies | As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens de nuvem para dispositivo do Hub IoT. | CloudToDeviceProperties |
Comentários | Comentários do Hub IoT. | corda |
enableFileUploadNotifications | Se True, as notificações de upload de arquivo serão habilitadas. | Bool |
eventHubEndpoints | As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As chaves possíveis para esse dicionário são eventos e operationsMonitoringEvents. Ambas as chaves precisam estar presentes no dicionário ao criar ou atualizar chamadas para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
Características | Os recursos e recursos habilitados para o Hub IoT. | 'DeviceManagement' 'None' |
ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
messagingEndpoints | As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo. | IotHubPropertiesMessagingEndpoints |
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, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods. | OperationsMonitoringProperties |
roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesMessagingEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesStorageEndpoints
Nome | Descrição | Valor |
---|
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades provisionadas do Hub IoT. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | int (obrigatório) |
nome | O nome da SKU. | 'F1' 'S1' 'S2' 'S3' (obrigatório) |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
MessagingEndpointProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
Nome | Descrição | Valor |
---|---|---|
apiVersion | A versão da API | '2017-07-01' |
etag | O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal. | corda |
localização | O local do recurso. | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | cadeia de caracteres (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. | cadeia de caracteres (obrigatório) |
Sku | Informações sobre a SKU do hub IoT. | IotHubSkuInfo (obrigatório) |
subscriptionid | O identificador da assinatura. | cadeia de caracteres (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
tipo | O tipo de recurso | 'Microsoft.Devices/IotHubs' |
OperationsMonitoringProperties
Nome | Descrição | Valor |
---|---|---|
Eventos | Dicionário de <> OperationMonitoringLevel | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Nome | Descrição | Valor |
---|
ResourceTags
Nome | Descrição | Valor |
---|
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
nome | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
RoutingEndpoints
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
serviceBusQueues | A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do hub de eventos. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | corda |
RoutingProperties
Nome | Descrição | Valor |
---|---|---|
Extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | |
fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | fallbackRouteProperties |
Rotas | A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties [] |
RoutingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | corda |
RoutingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | corda |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
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. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
codificação | Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro' e 'avroDeflate'. O valor padrão é 'avro'. | corda |
fileNameFormat | Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | corda |
maxChunkSizeInBytes | Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB). | int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000 |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | corda |
subscriptionId | O identificador de assinatura da conta de armazenamento. | corda |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
primaryKey | A chave primária. | corda |
direitos | As permissões atribuídas à política de acesso compartilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | corda |
StorageEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado. | cadeia de caracteres (obrigatório) |
sasTtlAsIso8601 | O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | corda |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
criar um ambiente pay as you go (PAYG) com um Hub IoT |
Esse modelo permite implantar um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT. |
criar um Hub IoT e um grupo de consumidores de dispositivo para nuvem |
Esse modelo permite implantar uma instância do Hub IoT com dispositivo para nuvem e nuvem para configurações de mensagens de dispositivo e um dispositivo para o grupo de consumidores de nuvem. |
Criar um Hub IOT e um simulador de borda do Ubuntu |
Esse modelo cria um simulador de borda do Ubuntu do Hub IOT e da Máquina Virtual. |
criar um serviço de provisionamento de dispositivos do Hub IoT |
Esse modelo permite que você crie um hub IoT e um Serviço de Provisionamento de Dispositivos do Hub IoT e vincule os dois serviços juntos. |
Criar Atualização de Dispositivo para a conta do Hub IoT, instância, Hub IoT |
Esse modelo cria uma conta, uma instância e um hub para vincular a instância. Ele configura o hub com as políticas de acesso, as rotas e o grupo de consumidores necessários. |
implantar o serviço MedTech, incluindo um Hub IoT do Azure |
O serviço MedTech é um dos Serviços de Dados de Integridade do Azure projetados para ingerir dados do dispositivo de vários dispositivos, transformar os dados do dispositivo em observações FHIR, que são então persistentes no serviço FHIR dos Serviços de Dados de Integridade do Azure. |
usar o modelo do ARM para criar o Hub IoT, rotear e exibir mensagens |
Use este modelo para implantar um Hub IoT e uma conta de armazenamento. Execute um aplicativo para enviar mensagens para o hub que são roteadas para o armazenamento e, em seguida, exiba os resultados. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso IotHubs pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Devices/IotHubs, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2017-07-01"
name = "string"
etag = "string"
location = "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"
}
}
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
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "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
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
realimentação | As propriedades da fila de comentários para mensagens de nuvem para dispositivo. | feedbackproperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens de nuvem para dispositivo na fila do dispositivo. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
EventHubProperties
Nome | Descrição | Valor |
---|---|---|
partitionCount | O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade compatível com o Hub de Eventos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | O tempo de retenção para mensagens do dispositivo para a nuvem em dias. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se a rota de fallback está habilitada. | bool (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio da fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
authorizationPolicies | As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens de nuvem para dispositivo do Hub IoT. | CloudToDeviceProperties |
Comentários | Comentários do Hub IoT. | corda |
enableFileUploadNotifications | Se True, as notificações de upload de arquivo serão habilitadas. | Bool |
eventHubEndpoints | As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As chaves possíveis para esse dicionário são eventos e operationsMonitoringEvents. Ambas as chaves precisam estar presentes no dicionário ao criar ou atualizar chamadas para o Hub IoT. | IotHubPropertiesEventHubEndpoints |
Características | Os recursos e recursos habilitados para o Hub IoT. | 'DeviceManagement' 'None' |
ipFilterRules | As regras de filtro IP. | IpFilterRule [] |
messagingEndpoints | As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo. | IotHubPropertiesMessagingEndpoints |
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, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods. | OperationsMonitoringProperties |
roteamento | As propriedades relacionadas ao roteamento do hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
storageEndpoints | A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que deve ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesMessagingEndpoints
Nome | Descrição | Valor |
---|
IotHubPropertiesStorageEndpoints
Nome | Descrição | Valor |
---|
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades provisionadas do Hub IoT. Confira: /azure/azure-subscription-service-limits#iot-hub-limits. | int (obrigatório) |
nome | O nome da SKU. | 'F1' 'S1' 'S2' 'S3' (obrigatório) |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
ação | A ação desejada para solicitações capturadas por essa regra. | 'Aceitar' 'Reject' (obrigatório) |
filterName | O nome da regra de filtro IP. | cadeia de caracteres (obrigatório) |
ipMask | Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. | cadeia de caracteres (obrigatório) |
MessagingEndpointProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
maxDeliveryCount | O número de vezes que o Hub IoT tenta entregar uma mensagem. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | int Restrições: Valor mínimo = 1 Valor máximo = 100 |
ttlAsIso8601 | O período para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
OperationsMonitoringProperties
Nome | Descrição | Valor |
---|---|---|
Eventos | Dicionário de <> OperationMonitoringLevel | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Nome | Descrição | Valor |
---|
ResourceTags
Nome | Descrição | Valor |
---|
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: /azure/iot-hub/iot-hub-devguide-query-language | corda |
endpointNames | A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido. | string[] (obrigatório) |
isEnabled | Usado para especificar se uma rota está habilitada. | bool (obrigatório) |
nome | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
fonte | A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. | 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'TwinChangeEvents' (obrigatório) |
RoutingEndpoints
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos. | RoutingEventHubProperties[] |
serviceBusQueues | A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do hub de eventos. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do hub de eventos. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do hub de eventos. | corda |
RoutingProperties
Nome | Descrição | Valor |
---|---|---|
Extremidade | As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. | |
fallbackRoute | As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Esse é um parâmetro opcional. Quando essa propriedade não está definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade interno do eventhub. | fallbackRouteProperties |
Rotas | A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. | RouteProperties [] |
RoutingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade da fila do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. | corda |
RoutingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. | cadeia de caracteres (obrigatório) |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. | corda |
subscriptionId | O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. | corda |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
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. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner de armazenamento na conta de armazenamento. | cadeia de caracteres (obrigatório) |
codificação | Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro' e 'avroDeflate'. O valor padrão é 'avro'. | corda |
fileNameFormat | Formato do nome do arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | corda |
maxChunkSizeInBytes | Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB). | int Restrições: Valor mínimo = 10485760 Valor máximo = 524288000 |
nome | O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, operationsMonitoringEvents, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. | corda Restrições: Padrão = ^[A-Za-z0-9-._]{1,64}$ (obrigatório) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | corda |
subscriptionId | O identificador de assinatura da conta de armazenamento. | corda |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
keyName | O nome da política de acesso compartilhado. | cadeia de caracteres (obrigatório) |
primaryKey | A chave primária. | corda |
direitos | As permissões atribuídas à política de acesso compartilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | corda |
StorageEndpointProperties
Nome | Descrição | Valor |
---|---|---|
connectionString | A cadeia de conexão da conta de Armazenamento do Azure para a qual os arquivos são carregados. | cadeia de caracteres (obrigatório) |
containerName | O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser creatável usando o connectionString especificado. | cadeia de caracteres (obrigatório) |
sasTtlAsIso8601 | O período para o qual o URI sas gerado pelo Hub IoT para upload de arquivo é válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | corda |