Microsoft.Devices IotHubs 2021-03-03-pré-visualização
Definição de recurso bicep
O tipo de recurso IotHubs pode ser implantado para:
- Grupos de recursos - Ver comandos de implantação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Formato de recursos
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Devices/IotHubs@2021-03-03-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
enableFileUploadNotifications: bool
encryption: {
keySource: 'string'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyIdentifier: 'string'
}
]
}
eventHubEndpoints: {}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
routing: {
endpoints: {
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {}
}
}
Valores imobiliários
IotHubs
Nome | Descrição | Valor |
---|---|---|
name | O nome do recurso | corda (necessária) Limite de caracteres: 3-50 Caracteres válidos: Alfanuméricos e hífenes. Não pode acabar com hífen. O nome do recurso deve ser único em todo o Azure. |
localização | A localização do recurso. | corda (necessária) |
etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Tags em modelos |
sku | Informações do IotHub SKU | IotHubSkuInfo (obrigatório) |
etag | O campo Etag não é necessário. Se for fornecido no organismo de resposta, deve também ser fornecido como cabeçalho de acordo com a convenção normal de ETag. | string |
identidade | As identidades geridas para o IotHub. | ArmIdentity |
propriedades | Propriedades IotHub | IotHubProperties |
ArmIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade usada para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades do serviço. | "Nenhum" 'Sistema Assintado' 'SystemAssigned, UserAssigned' 'UtilizadorAssatado' |
nomeações para assediadas do utilizador | Dicionário de {ArmUserIdentity} | objeto |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
autorizaçõesAspolícias | As políticas de acesso partilhado que pode utilizar para garantir uma ligação ao hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens nuvem-dispositivo do hub IoT. | CloudToDeviceProperties |
comentários | IoT hub comentários. | string |
dispositivosStreams | O dispositivo transmite propriedades do iothub. | IotHubPropertiesDeviceStreams |
activarFileUploadNotifications | Se for verdade, as notificações de upload de ficheiros estão ativadas. | bool |
Encriptação | As propriedades de encriptação para o hub IoT. | EncriptaçãoPropertiesDecrição |
eventHubEndpoints | As propriedades do ponto final compatíveis com o Event Hub. As únicas chaves possíveis para este dicionário são os acontecimentos. Esta chave tem de estar presente no dicionário enquanto faz chamadas de criação ou atualização para o hub IoT. | objeto |
funcionalidades | As capacidades e funcionalidades ativadas para o hub IoT. | 'Gestagement device' "Nenhum" |
ipFilterRules | As regras do filtro IP. | IpFilterRule[] |
mensagensEndpoints | As propriedades do ponto final de mensagens para a fila de notificação de upload de ficheiros. | objeto |
minTlsVersion | Especifica a versão TLS mínima para suportar este hub. Pode ser definido como "1.2" para ter clientes que usam uma versão TLS abaixo de 1.2 para ser rejeitado. | string |
redesRuleSets | Definição de regra de rede propriedades do IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Conexões privadas de ponto final criadas neste IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | 'Deficiente' 'Habilitado' |
encaminhamento | As propriedades relacionadas com o encaminhamento do hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messaging | Propostas de encaminhamento |
storageEndpoints | A lista de pontos finais do Azure Storage onde pode fazer o upload de ficheiros. Atualmente pode configurar apenas uma conta de Armazenamento Azure e que DEVE ter a sua chave como $default. Especificar mais de uma conta de armazenamento faz com que seja lançado um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications é definida para True, faz com que um erro seja lançado. | objeto |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistroDito' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | string |
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistroDito' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | string |
CloudToDeviceProperties
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens nuvem-para-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
feedback | As propriedades da fila de comentários para mensagens nuvem-dispositivo. | FeedbackProperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens nuvem-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
Nome | Descrição | Valor |
---|---|---|
streamingEndpoints | Lista de pontos finais de streams de dispositivos. | corda[] |
EncriptaçãoPropertiesDecrição
Nome | Descrição | Valor |
---|---|---|
keySource | A fonte da chave. | string |
keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Nome | Descrição | Valor |
---|---|---|
identidade | Propriedades de identidade geridas da ChaveVault. | ManagedIdentity |
keyIdentifier | O identificador da chave. | string |
ManagedIdentity
Nome | Descrição | Valor |
---|---|---|
utilizadorAsignedIdentity | O utilizador atribuiu identidade. | string |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
action | A ação desejada para pedidos capturados por esta regra. | 'Aceitar' "Rejeitar" (obrigatório) |
nome de filtro | O nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
NetworkRuleSetProperties
Nome | Descrição | Valor |
---|---|---|
aplicarToBuiltInEventHubEndpoint | Se verdadeiro, então o conjunto de regras de rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
defaultAction | Ação predefinitiva para conjunto de regras de rede | 'Permitir' 'Negar' |
ipRules | Lista de Regras de IP | RedeRuleSetIpRule[] (obrigatório) |
RedeRuleSetIprule
Nome | Descrição | Valor |
---|---|---|
action | Ação do filtro IP | 'Permitir' |
nome de filtro | Nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (necessárias) |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade privada de ponto final de uma ligação de ponto final privado | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma ligação privada de ponto final | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrição | Valor |
---|---|---|
açõesRequired | Ações necessárias para uma ligação privada ao ponto final | string |
descrição | A descrição para o estado atual de uma ligação privada de ponto final | corda (necessária) |
status | O estado de uma ligação privada de ponto final | 'Aprovado' 'Desligado' 'Pendente' "Rejeitado" (obrigatório) |
Propostas de encaminhamento
Nome | Descrição | Valor |
---|---|---|
pontos finais | As propriedades relacionadas com os pontos finais personalizados aos quais o seu hub IoT encaminha mensagens com base nas regras de encaminhamento. Um máximo de 10 pontos finais personalizados são permitidos em todos os tipos de pontos finais para centros pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para centros gratuitos. | Pontos de encaminhamento |
enriquecimentos | A lista de enriquecimentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a serem entregues em pontos finais incorporados e personalizados. Ver: https://aka.ms/telemetryoneventgrid |
EnriquecimentoProperties[] |
fallbackRoute | As propriedades da rota que é utilizada como rota de recuo quando nenhuma das condições especificadas na secção 'rotas' são cumpridas. Este é um parâmetro opcional. Quando esta propriedade não estiver definida, as mensagens que não satisfaçam nenhuma das condições especificadas na secção 'rotas' são encaminhadas para o ponto final incorporado do eventhub. | FallbackRouteProperties |
rotas | A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. Um máximo de 100 regras de encaminhamento são permitidas para centros pagos e um máximo de 5 regras de encaminhamento são permitidas para centros gratuitos. | RouteProperties[] |
Pontos de encaminhamento
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos finais do Event Hubs para o hub IoT encaminha mensagens para, com base nas regras de encaminhamento. Esta lista não inclui o ponto final do Event Hubs incorporado. | RoutingEventHubProperties[] |
serviçoBusQueues | A lista de pontos finais da fila do Service Bus que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos finais do tópico do Service Bus aponta para o hub IoT para, com base nas regras de encaminhamento. | EncaminhingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos finais do contentor de armazenamento para que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do centro de eventos | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto final do centro de eventos. | string |
endpointUri | A url do centro de eventos ponto final. Deve incluir o protocolo sb:// | string |
entidadePath | Nome do centro do evento no espaço de nome do centro do evento | string |
ID | ID do ponto final do centro do evento | string |
identidade | Propriedades de identidade geridas do ponto final do centro do evento de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do centro de eventos. | string |
subscriptionId | O identificador de subscrição do ponto final do centro do evento. | string |
EncaminhingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final da fila do autocarro de serviço | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto de saída da fila do autocarro de serviço. | string |
endpointUri | A url do ponto final da fila do autocarro de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no espaço de nome do ônibus de serviço | string |
ID | Id do ponto final da fila do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final da fila do autocarro de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final da fila do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final da fila do autocarro de serviço. | string |
EncaminhingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do tópico do ônibus de serviço | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto final do tópico do autocarro de serviço. | string |
endpointUri | A url do ponto final do ônibus de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no tópico do ônibus de serviço | string |
ID | Id do ponto final do tópico do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final do tópico do ônibus de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final do tópico do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final do tópico do autocarro de serviço. | string |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método utilizado para autenticar contra o ponto final de armazenamento | «IdentidadeSEdiem' 'KeyBased' |
batchFrequencyInSeconds | Intervalo de tempo em que as bolhas são escritas para armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é de 300 segundos. | int |
conexãoStragem | A cadeia de ligação da conta de armazenamento. | string |
nome de contentor | O nome do recipiente de armazenamento na conta de armazenamento. | corda (necessária) |
codificação | Codificação que é usada para serializar mensagens para bolhas. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor predefinido é 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
endpointUri | A url do ponto final de armazenamento. Deve incluir o protocolo https:// |
string |
fileNameFormat | Formato de nome de ficheiro para a bolha. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
ID | Id do ponto final do recipiente de armazenamento | string |
identidade | Propriedades de identidade geridas do ponto final de armazenamento de encaminhamento. | ManagedIdentity |
maxChunkSizeInBytes | Número máximo de bytes para cada bolha escrita para armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor predefinido é 314572800(300MB). | int |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnriquecimentoProperties
Nome | Descrição | Valor |
---|---|---|
endpointNames | A lista de pontos finais para os quais o enriquecimento é aplicado à mensagem. | corda[] (necessária) |
key | A chave ou nome para a propriedade de enriquecimento. | corda (necessária) |
valor | O valor para o imóvel de enriquecimento. | corda (necessária) |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de retorno. Se a condição não for fornecida, avaliará a verdade por defeito. Para gramática, Consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada para. Atualmente apenas 1 ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se a rota de retorno está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | string |
source | A fonte a que deve ser aplicada a regra de encaminhamento. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'TwinChangeEvents' (obrigatório) |
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, avalia-se a verdade por defeito. Para a gramática, consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada. Atualmente apenas um ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se uma rota está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | corda (necessária) |
source | A fonte a que a regra de encaminhamento deve ser aplicada, como as caixas de dispositivos. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'TwinChangeEvents' (obrigatório) |
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades Hub IoT a provisionadas. Ver: /azure/azure-subscrição-serviço-limites#iot-hub-limits. | int |
name | O nome do SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obrigatório) |
Modelos de início rápido
Os seguintes modelos de arranque rápido implementam este tipo de recurso.
Modelo | Descrição |
---|---|
Crie um simulador de borda IOT Hub e Ubuntu |
Este modelo cria um simulador de borda IOT Hub e Máquina Virtual Ubuntu. |
Use o modelo ARM para criar mensagens de Hub IoT, rota e visualização |
Utilize este modelo para implementar uma Hub IoT e uma conta de armazenamento. Executar uma aplicação para enviar mensagens para o centro que são encaminhadas para o armazenamento e, em seguida, ver os resultados. |
Criar um serviço de fornecimento de dispositivos Hub IoT |
Este modelo permite-lhe criar um hub IoT e um serviço de fornecimento de dispositivos Hub IoT e ligar os dois serviços em conjunto. |
Crie um Hub IoT e um dispositivo para cloud consumer Group |
Este modelo permite-lhe implementar uma Hub IoT instância com dispositivo para cloud e cloud para configurações de mensagens de dispositivo e um dispositivo para cloud consumer group. |
Crie atualização de dispositivos para Hub IoT conta, exemplo, Hub IoT |
Este modelo cria uma conta, e um caso e um hub para ligar o caso com. Configura o centro com as necessárias polícias de acesso, rotas e grupo de consumidores. |
Crie um ambiente pay as you go (PAYG) com um Hub IoT |
Este modelo permite-lhe implementar um ambiente de Insights de Séries De Tempo Pay As You Go (PAYG) que está configurado para consumir eventos a partir de uma Hub IoT. |
Definição de recurso de modelo DE ARM
O tipo de recurso IotHubs pode ser implantado para:
- Grupos de recursos - Ver comandos de implantação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Formato de recursos
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2021-03-03-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"enableFileUploadNotifications": "bool",
"encryption": {
"keySource": "string",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyIdentifier": "string"
}
]
},
"eventHubEndpoints": {},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"routing": {
"endpoints": {
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {}
}
}
Valores imobiliários
IotHubs
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | 'Microsoft.Devices/IotHubs' |
apiVersion | A versão api de recurso | '2021-03-03-pré-visualização' |
name | O nome do recurso | corda (necessária) Limite de caracteres: 3-50 Caracteres válidos: Alfanuméricos e hífenes. Não pode acabar com hífen. O nome do recurso deve ser único em todo o Azure. |
localização | A localização do recurso. | corda (necessária) |
etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Tags em modelos |
sku | Informações do IotHub SKU | IotHubSkuInfo (obrigatório) |
etag | O campo Etag não é necessário. Se for fornecido no organismo de resposta, deve também ser fornecido como cabeçalho de acordo com a convenção normal de ETag. | string |
identidade | As identidades geridas para o IotHub. | ArmIdentity |
propriedades | Propriedades IotHub | IotHubProperties |
ArmIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade usada para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades do serviço. | "Nenhum" 'Sistema Assintado' 'SystemAssigned, UserAssigned' 'UtilizadorAssatado' |
nomeações para assediadas do utilizador | Dicionário de {ArmUserIdentity} | objeto |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
autorizaçõesAspolícias | As políticas de acesso partilhado que pode utilizar para garantir uma ligação ao hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens nuvem-dispositivo do hub IoT. | CloudToDeviceProperties |
comentários | IoT hub comentários. | string |
dispositivosStreams | O dispositivo transmite propriedades do iothub. | IotHubPropertiesDeviceStreams |
activarFileUploadNotifications | Se for verdade, as notificações de upload de ficheiros estão ativadas. | bool |
Encriptação | As propriedades de encriptação para o hub IoT. | EncriptaçãoPropertiesDecrição |
eventHubEndpoints | As propriedades do ponto final compatíveis com o Event Hub. As únicas chaves possíveis para este dicionário são os acontecimentos. Esta chave tem de estar presente no dicionário enquanto faz chamadas de criação ou atualização para o hub IoT. | objeto |
funcionalidades | As capacidades e funcionalidades ativadas para o hub IoT. | 'Gestagement device' "Nenhum" |
ipFilterRules | As regras do filtro IP. | IpFilterRule[] |
mensagensEndpoints | As propriedades do ponto final de mensagens para a fila de notificação de upload de ficheiros. | objeto |
minTlsVersion | Especifica a versão TLS mínima para suportar este hub. Pode ser definido como "1.2" para ter clientes que usam uma versão TLS abaixo de 1.2 para ser rejeitado. | string |
redesRuleSets | Definição de regra de rede propriedades do IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Conexões privadas de ponto final criadas neste IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | 'Deficiente' 'Habilitado' |
encaminhamento | As propriedades relacionadas com o encaminhamento do hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messaging | Propostas de encaminhamento |
storageEndpoints | A lista de pontos finais do Azure Storage onde pode fazer o upload de ficheiros. Atualmente pode configurar apenas uma conta de Armazenamento Azure e que DEVE ter a sua chave como $default. Especificar mais de uma conta de armazenamento faz com que seja lançado um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications é definida para True, faz com que um erro seja lançado. | objeto |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistroDito' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | string |
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistroDito' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obrigatório) |
secondaryKey | A chave secundária. | string |
CloudToDeviceProperties
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens nuvem-para-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
feedback | As propriedades da fila de comentários para mensagens nuvem-dispositivo. | FeedbackProperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens nuvem-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
Nome | Descrição | Valor |
---|---|---|
streamingEndpoints | Lista de pontos finais de streams de dispositivos. | corda[] |
EncriptaçãoPropertiesDecrição
Nome | Descrição | Valor |
---|---|---|
keySource | A fonte da chave. | string |
keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Nome | Descrição | Valor |
---|---|---|
identidade | Propriedades de identidade geridas da ChaveVault. | ManagedIdentity |
keyIdentifier | O identificador da chave. | string |
ManagedIdentity
Nome | Descrição | Valor |
---|---|---|
utilizadorAsignedIdentity | O utilizador atribuiu identidade. | string |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
action | A ação desejada para pedidos capturados por esta regra. | 'Aceitar' "Rejeitar" (obrigatório) |
nome de filtro | O nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
NetworkRuleSetProperties
Nome | Descrição | Valor |
---|---|---|
aplicarToBuiltInEventHubEndpoint | Se verdadeiro, então o conjunto de regras de rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
defaultAction | Ação predefinitiva para conjunto de regras de rede | 'Permitir' 'Negar' |
ipRules | Lista de Regras de IP | RedeRuleSetIpRule[] (obrigatório) |
RedeRuleSetIprule
Nome | Descrição | Valor |
---|---|---|
action | Ação do filtro IP | 'Permitir' |
nome de filtro | Nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (necessárias) |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade privada de ponto final de uma ligação de ponto final privado | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma ligação privada de ponto final | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrição | Valor |
---|---|---|
açõesRequired | Ações necessárias para uma ligação privada ao ponto final | string |
descrição | A descrição para o estado atual de uma ligação privada de ponto final | corda (necessária) |
status | O estado de uma ligação privada de ponto final | 'Aprovado' 'Desligado' 'Pendente' "Rejeitado" (obrigatório) |
Propostas de encaminhamento
Nome | Descrição | Valor |
---|---|---|
pontos finais | As propriedades relacionadas com os pontos finais personalizados aos quais o seu hub IoT encaminha mensagens com base nas regras de encaminhamento. Um máximo de 10 pontos finais personalizados são permitidos em todos os tipos de pontos finais para centros pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para centros gratuitos. | Pontos de encaminhamento |
enriquecimentos | A lista de enriquecimentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a serem entregues em pontos finais incorporados e personalizados. Ver: https://aka.ms/telemetryoneventgrid |
EnriquecimentoProperties[] |
fallbackRoute | As propriedades da rota que é utilizada como rota de recuo quando nenhuma das condições especificadas na secção 'rotas' são cumpridas. Este é um parâmetro opcional. Quando esta propriedade não estiver definida, as mensagens que não satisfaçam nenhuma das condições especificadas na secção 'rotas' são encaminhadas para o ponto final incorporado do eventhub. | FallbackRouteProperties |
rotas | A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. Um máximo de 100 regras de encaminhamento são permitidas para centros pagos e um máximo de 5 regras de encaminhamento são permitidas para centros gratuitos. | RouteProperties[] |
Pontos de encaminhamento
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos finais do Event Hubs para o hub IoT encaminha mensagens para, com base nas regras de encaminhamento. Esta lista não inclui o ponto final do Event Hubs incorporado. | RoutingEventHubProperties[] |
serviçoBusQueues | A lista de pontos finais da fila do Service Bus que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos finais do tópico do Service Bus aponta para o hub IoT para, com base nas regras de encaminhamento. | EncaminhingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos finais do contentor de armazenamento para que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do centro de eventos | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto final do centro de eventos. | string |
endpointUri | A url do centro de eventos ponto final. Deve incluir o protocolo sb:// | string |
entidadePath | Nome do centro do evento no espaço de nome do centro do evento | string |
ID | ID do ponto final do centro do evento | string |
identidade | Propriedades de identidade geridas do ponto final do centro do evento de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do centro de eventos. | string |
subscriptionId | O identificador de subscrição do ponto final do centro do evento. | string |
EncaminhingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final da fila do autocarro de serviço | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto de saída da fila do autocarro de serviço. | string |
endpointUri | A url do ponto final da fila do autocarro de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no espaço de nome do ônibus de serviço | string |
ID | Id do ponto final da fila do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final da fila do autocarro de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final da fila do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final da fila do autocarro de serviço. | string |
EncaminhingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do tópico do ônibus de serviço | «IdentidadeSEdiem' 'KeyBased' |
conexãoStragem | A cadeia de ligação do ponto final do tópico do autocarro de serviço. | string |
endpointUri | A url do ponto final do ônibus de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no tópico do ônibus de serviço | string |
ID | Id do ponto final do tópico do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final do tópico do ônibus de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final do tópico do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final do tópico do autocarro de serviço. | string |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método utilizado para autenticar contra o ponto final de armazenamento | «IdentidadeSEdiem' 'KeyBased' |
batchFrequencyInSeconds | Intervalo de tempo em que as bolhas são escritas para armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é de 300 segundos. | int |
conexãoStragem | A cadeia de ligação da conta de armazenamento. | string |
nome de contentor | O nome do recipiente de armazenamento na conta de armazenamento. | corda (necessária) |
codificação | Codificação que é usada para serializar mensagens para bolhas. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor predefinido é 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
endpointUri | A url do ponto final de armazenamento. Deve incluir o protocolo https:// |
string |
fileNameFormat | Formato de nome de ficheiro para a bolha. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
ID | Id do ponto final do recipiente de armazenamento | string |
identidade | Propriedades de identidade geridas do ponto final de armazenamento de encaminhamento. | ManagedIdentity |
maxChunkSizeInBytes | Número máximo de bytes para cada bolha escrita para armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor predefinido é 314572800(300MB). | int |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnriquecimentoProperties
Nome | Descrição | Valor |
---|---|---|
endpointNames | A lista de pontos finais para os quais o enriquecimento é aplicado à mensagem. | corda[] (necessária) |
key | A chave ou nome para a propriedade de enriquecimento. | corda (necessária) |
valor | O valor para o imóvel de enriquecimento. | corda (necessária) |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de retorno. Se a condição não for fornecida, avaliará a verdade por defeito. Para gramática, Consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada para. Atualmente apenas 1 ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se a rota de retorno está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | string |
source | A fonte a que deve ser aplicada a regra de encaminhamento. Por exemplo, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'TwinChangeEvents' (obrigatório) |
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, avalia-se a verdade por defeito. Para a gramática, consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada. Atualmente apenas um ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se uma rota está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | corda (necessária) |
source | A fonte a que a regra de encaminhamento deve ser aplicada, como as caixas de dispositivos. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Inválido' 'TwinChangeEvents' (obrigatório) |
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades Hub IoT a provisionadas. Ver: /azure/azure-subscrição-serviço-limites#iot-hub-limits. | int |
name | O nome do SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obrigatório) |
Modelos de início rápido
Os seguintes modelos de arranque rápido implementam este tipo de recurso.
Modelo | Descrição |
---|---|
Crie um simulador de borda IOT Hub e Ubuntu |
Este modelo cria um simulador de borda IOT Hub e Máquina Virtual Ubuntu. |
Use o modelo ARM para criar mensagens de Hub IoT, rota e visualização |
Utilize este modelo para implementar uma Hub IoT e uma conta de armazenamento. Executar uma aplicação para enviar mensagens para o centro que são encaminhadas para o armazenamento e, em seguida, ver os resultados. |
Criar um serviço de fornecimento de dispositivos Hub IoT |
Este modelo permite-lhe criar um hub IoT e um serviço de fornecimento de dispositivos Hub IoT e ligar os dois serviços em conjunto. |
Crie um Hub IoT e um dispositivo para cloud consumer Group |
Este modelo permite-lhe implementar uma Hub IoT instância com dispositivo para cloud e cloud para configurações de mensagens de dispositivo e um dispositivo para cloud consumer group. |
Crie atualização de dispositivos para Hub IoT conta, exemplo, Hub IoT |
Este modelo cria uma conta, e um caso e um hub para ligar o caso com. Configura o centro com as necessárias polícias de acesso, rotas e grupo de consumidores. |
Crie um ambiente pay as you go (PAYG) com um Hub IoT |
Este modelo permite-lhe implementar um ambiente de Insights de Séries De Tempo Pay As You Go (PAYG) que está configurado para consumir eventos a partir de uma Hub IoT. |
Definição de recursos Terraform (fornecedor AzAPI)
O tipo de recurso IotHubs pode ser implantado para:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Formato de recursos
Para criar um recurso Microsoft.Devices/IotHubs, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2021-03-03-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
enableFileUploadNotifications = bool
encryption = {
keySource = "string"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyIdentifier = "string"
}
]
}
eventHubEndpoints = {}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
routing = {
endpoints = {
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Valores imobiliários
IotHubs
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.Devices/IotHubs@2021-03-03-preview" |
name | O nome do recurso | corda (necessária) Limite de caracteres: 3-50 Caracteres válidos: Alfanuméricos e hífenes. Não pode acabar com hífen. O nome do recurso deve ser único em todo o Azure. |
localização | A localização do recurso. | corda (necessária) |
parent_id | Para implantar num grupo de recursos, utilize o ID desse grupo de recursos. | corda (necessária) |
etiquetas | As etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
sku | Informações do IotHub SKU | IotHubSkuInfo (obrigatório) |
etag | O campo Etag não é necessário. Se for fornecido no organismo de resposta, deve também ser fornecido como cabeçalho de acordo com a convenção normal de ETag. | string |
identidade | As identidades geridas para o IotHub. | ArmIdentity |
propriedades | Propriedades IotHub | IotHubProperties |
ArmIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade usada para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade implicitamente criada e um conjunto de identidades atribuídas pelo utilizador. O tipo 'Nenhum' removerá quaisquer identidades do serviço. | "Sistema Assintado" "SistemaAssigned, UserAssigned" "Utilizador Assinado" |
identity_ids | Dicionário de {ArmUserIdentity} | Conjunto de identidade de utilizador. |
IotHubProperties
Nome | Descrição | Valor |
---|---|---|
autorizaçõesAspolícias | As políticas de acesso partilhado que pode utilizar para garantir uma ligação ao hub IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | As propriedades de mensagens nuvem-dispositivo do hub IoT. | CloudToDeviceProperties |
comentários | IoT hub comentários. | string |
dispositivosStreams | O dispositivo transmite propriedades do iothub. | IotHubPropertiesDeviceStreams |
activarFileUploadNotifications | Se for verdade, as notificações de upload de ficheiros estão ativadas. | bool |
Encriptação | As propriedades de encriptação para o hub IoT. | EncriptaçãoPropertiesDecrição |
eventHubEndpoints | As propriedades do ponto final compatíveis com o Event Hub. As únicas chaves possíveis para este dicionário são os acontecimentos. Esta chave tem de estar presente no dicionário enquanto faz chamadas de criação ou atualização para o hub IoT. | objeto |
funcionalidades | As capacidades e funcionalidades ativadas para o hub IoT. | "Gestagem de Dispositivos" "Nenhum" |
ipFilterRules | As regras do filtro IP. | IpFilterRule[] |
mensagensEndpoints | As propriedades do ponto final de mensagens para a fila de notificação de upload de ficheiros. | objeto |
minTlsVersion | Especifica a versão TLS mínima para suportar este hub. Pode ser definido como "1.2" para ter clientes que usam uma versão TLS abaixo de 1.2 para ser rejeitado. | string |
redesRuleSets | Definição de regra de rede propriedades do IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Conexões privadas de ponto final criadas neste IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Se os pedidos da Rede Pública são permitidos | "Deficiente" "Habilidoso" |
encaminhamento | As propriedades relacionadas com o encaminhamento do hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messaging | Propostas de encaminhamento |
storageEndpoints | A lista de pontos finais do Azure Storage onde pode fazer o upload de ficheiros. Atualmente pode configurar apenas uma conta de Armazenamento Azure e que DEVE ter a sua chave como $default. Especificar mais de uma conta de armazenamento faz com que seja lançado um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications é definida para True, faz com que um erro seja lançado. | objeto |
SharedAccessSignatureAuthorizationRule
Nome | Descrição | Valor |
---|---|---|
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | "DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistroWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório) |
secondaryKey | A chave secundária. | string |
nome chave | O nome da política de acesso partilhado. | corda (necessária) |
primaryKey | A chave primária. | string |
direitos | As permissões atribuídas à política de acesso partilhado. | "DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistroWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obrigatório) |
secondaryKey | A chave secundária. | string |
CloudToDeviceProperties
Nome | Descrição | Valor |
---|---|---|
defaultTtlAsIso8601 | O tempo padrão para viver para mensagens nuvem-para-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
feedback | As propriedades da fila de comentários para mensagens nuvem-dispositivo. | FeedbackProperties |
maxDeliveryCount | A contagem máxima de entrega para mensagens nuvem-dispositivo na fila do dispositivo. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
FeedbackProperties
Nome | Descrição | Valor |
---|---|---|
lockDurationAsIso8601 | A duração do bloqueio para a fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
maxDeliveryCount | O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | int |
ttlAsIso8601 | O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Ver: /azure/iot-hub/iot-hub-devguide-messages#cloud-to-device-messages. | string |
IotHubPropertiesDeviceStreams
Nome | Descrição | Valor |
---|---|---|
streamingEndpoints | Lista de pontos finais de streams de dispositivos. | corda[] |
EncriptaçãoPropertiesDecrição
Nome | Descrição | Valor |
---|---|---|
keySource | A fonte da chave. | string |
keyVaultProperties | As propriedades da chave KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Nome | Descrição | Valor |
---|---|---|
identidade | Propriedades de identidade geridas da ChaveVault. | ManagedIdentity |
keyIdentifier | O identificador da chave. | string |
ManagedIdentity
Nome | Descrição | Valor |
---|---|---|
utilizadorAsignedIdentity | O utilizador atribuiu identidade. | string |
IpFilterRule
Nome | Descrição | Valor |
---|---|---|
action | A ação desejada para pedidos capturados por esta regra. | "Aceitar" "Rejeitar" (obrigatório) |
nome de filtro | O nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
NetworkRuleSetProperties
Nome | Descrição | Valor |
---|---|---|
aplicarToBuiltInEventHubEndpoint | Se verdadeiro, então o conjunto de regras de rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub | bool (obrigatório) |
defaultAction | Ação predefinitiva para conjunto de regras de rede | "Permitir" "Negar" |
ipRules | Lista de Regras de IP | RedeRuleSetIpRule[] (obrigatório) |
RedeRuleSetIprule
Nome | Descrição | Valor |
---|---|---|
action | Ação do filtro IP | "Permitir" |
nome de filtro | Nome da regra do filtro IP. | corda (necessária) |
ipMask | Um string que contém o intervalo de endereço IP na notação CIDR para a regra. | corda (necessária) |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
propriedades | As propriedades de uma ligação de ponto final privado | PrivateEndpointConnectionProperties (necessárias) |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
privateEndpoint | A propriedade privada de ponto final de uma ligação de ponto final privado | PrivateEndpoint |
privateLinkServiceConnectionState | O estado atual de uma ligação privada de ponto final | PrivateLinkServiceConnectionState (obrigatório) |
PrivateEndpoint
Este objeto não contém nenhuma propriedade para definir durante a implantação. Todas as propriedades são ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrição | Valor |
---|---|---|
açõesRequired | Ações necessárias para uma ligação privada ao ponto final | string |
descrição | A descrição para o estado atual de uma ligação privada de ponto final | corda (necessária) |
status | O estado de uma ligação privada de ponto final | "Aprovado" "Desligado" "Pendente" "Rejeitado" (obrigatório) |
Propostas de encaminhamento
Nome | Descrição | Valor |
---|---|---|
pontos finais | As propriedades relacionadas com os pontos finais personalizados aos quais o seu hub IoT encaminha mensagens com base nas regras de encaminhamento. Um máximo de 10 pontos finais personalizados são permitidos em todos os tipos de pontos finais para centros pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para centros gratuitos. | Pontos de encaminhamento |
enriquecimentos | A lista de enriquecimentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a serem entregues em pontos finais incorporados e personalizados. Ver: https://aka.ms/telemetryoneventgrid |
EnriquecimentoProperties[] |
fallbackRoute | As propriedades da rota que é utilizada como rota de recuo quando nenhuma das condições especificadas na secção 'rotas' são cumpridas. Este é um parâmetro opcional. Quando esta propriedade não estiver definida, as mensagens que não satisfaçam nenhuma das condições especificadas na secção 'rotas' são encaminhadas para o ponto final incorporado do eventhub. | FallbackRouteProperties |
rotas | A lista de regras de encaminhamento fornecidas pelo utilizador que o hub IoT utiliza para encaminhar mensagens para pontos finais incorporados e personalizados. Um máximo de 100 regras de encaminhamento são permitidas para centros pagos e um máximo de 5 regras de encaminhamento são permitidas para centros gratuitos. | RouteProperties[] |
Pontos de encaminhamento
Nome | Descrição | Valor |
---|---|---|
eventHubs | A lista de pontos finais do Event Hubs para o hub IoT encaminha mensagens para, com base nas regras de encaminhamento. Esta lista não inclui o ponto final do Event Hubs incorporado. | RoutingEventHubProperties[] |
serviçoBusQueues | A lista de pontos finais da fila do Service Bus que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingServiceBusQueueEndpointProperties[] |
serviceBusTopics | A lista de pontos finais do tópico do Service Bus aponta para o hub IoT para, com base nas regras de encaminhamento. | EncaminhingServiceBusTopicEndpointProperties[] |
storageContainers | A lista de pontos finais do contentor de armazenamento para que o hub IoT encaminha as mensagens para, com base nas regras de encaminhamento. | EncaminhingStorageContainerProperties[] |
RoutingEventHubProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do centro de eventos | "IdentidadeBased" "KeyBased" |
conexãoStragem | A cadeia de ligação do ponto final do centro de eventos. | string |
endpointUri | A url do centro de eventos ponto final. Deve incluir o protocolo sb:// | string |
entidadePath | Nome do centro do evento no espaço de nome do centro do evento | string |
ID | ID do ponto final do centro do evento | string |
identidade | Propriedades de identidade geridas do ponto final do centro do evento de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do centro de eventos. | string |
subscriptionId | O identificador de subscrição do ponto final do centro do evento. | string |
EncaminhingServiceBusQueueEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final da fila do autocarro de serviço | "IdentidadeBased" "KeyBased" |
conexãoStragem | A cadeia de ligação do ponto de saída da fila do autocarro de serviço. | string |
endpointUri | A url do ponto final da fila do autocarro de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no espaço de nome do ônibus de serviço | string |
ID | Id do ponto final da fila do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final da fila do autocarro de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final da fila do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final da fila do autocarro de serviço. | string |
EncaminhingServiceBusTopicEndpointProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método usado para autenticar contra o ponto final do tópico do ônibus de serviço | "IdentidadeBased" "KeyBased" |
conexãoStragem | A cadeia de ligação do ponto final do tópico do autocarro de serviço. | string |
endpointUri | A url do ponto final do ônibus de serviço. Deve incluir o protocolo sb:// | string |
entidadePath | Nome da fila no tópico do ônibus de serviço | string |
ID | Id do ponto final do tópico do ônibus de serviço | string |
identidade | Propriedades de identidade geridas do ponto final do tópico do ônibus de encaminhamento. | ManagedIdentity |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real. | corda (necessária) |
resourceGroup | O nome do grupo de recursos do ponto final do tópico do autocarro de serviço. | string |
subscriptionId | O identificador de subscrição do ponto final do tópico do autocarro de serviço. | string |
RoutingStorageContainerProperties
Nome | Descrição | Valor |
---|---|---|
authenticationType | Método utilizado para autenticar contra o ponto final de armazenamento | "IdentidadeBased" "KeyBased" |
batchFrequencyInSeconds | Intervalo de tempo em que as bolhas são escritas para armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é de 300 segundos. | int |
conexãoStragem | A cadeia de ligação da conta de armazenamento. | string |
nome de contentor | O nome do recipiente de armazenamento na conta de armazenamento. | corda (necessária) |
codificação | Codificação que é usada para serializar mensagens para bolhas. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor predefinido é 'avro'. | "Avro" "AvroDeflate" "JSON" |
endpointUri | A url do ponto final de armazenamento. Deve incluir o protocolo https:// |
string |
fileNameFormat | Formato de nome de ficheiro para a bolha. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. | string |
ID | Id do ponto final do recipiente de armazenamento | string |
identidade | Propriedades de identidade geridas do ponto final de armazenamento de encaminhamento. | ManagedIdentity |
maxChunkSizeInBytes | Número máximo de bytes para cada bolha escrita para armazenamento. O valor deve estar entre 10485760(10MB) e 524288000(500MB). O valor predefinido é 314572800(300MB). | int |
name | O nome que identifica este ponto final. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, arquivoNotificações, $default. Os nomes de pontos finais devem ser únicos entre os tipos de pontos finais. | corda (necessária) |
resourceGroup | O nome do grupo de recursos da conta de armazenamento. | string |
subscriptionId | O identificador de assinatura da conta de armazenamento. | string |
EnriquecimentoProperties
Nome | Descrição | Valor |
---|---|---|
endpointNames | A lista de pontos finais para os quais o enriquecimento é aplicado à mensagem. | corda[] (necessária) |
key | A chave ou nome para a propriedade de enriquecimento. | corda (necessária) |
valor | O valor para o imóvel de enriquecimento. | corda (necessária) |
FallbackRouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a rota de retorno. Se a condição não for fornecida, avaliará a verdade por defeito. Para gramática, Consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada para. Atualmente apenas 1 ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se a rota de retorno está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | string |
source | A fonte a que deve ser aplicada a regra de encaminhamento. Por exemplo, DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Inválido" "TwinChangeEvents" (obrigatório) |
RouteProperties
Nome | Descrição | Valor |
---|---|---|
condição | A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, avalia-se a verdade por defeito. Para a gramática, consulte: /azure/iot-hub/iot-hub-devguide-consulta-language | string |
endpointNames | A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhada. Atualmente apenas um ponto final é permitido. | corda[] (necessária) |
isEnabled | Usado para especificar se uma rota está ativada. | bool (obrigatório) |
name | O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 caracteres, e deve ser único. | corda (necessária) |
source | A fonte a que a regra de encaminhamento deve ser aplicada, como as caixas de dispositivos. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Inválido" "TwinChangeEvents" (obrigatório) |
IotHubSkuInfo
Nome | Descrição | Valor |
---|---|---|
capacidade | O número de unidades Hub IoT a provisionadas. Ver: /azure/azure-subscrição-serviço-limites#iot-hub-limits. | int |
name | O nome do SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (obrigatório) |