Partilhar via

Iot Hub Resource - Update

  • Referência
Serviço:
IoT Hub
Versão da API:
2023-06-30

Atualize as etiquetas dos Hubs IoT existentes.
Atualizar etiquetas de Hub IoT existentes. para atualizar outros campos, utilize o método CreateOrUpdate

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

Identificador do grupo de recursos.
resourceName
 path True

string

Nome do hub iot a atualizar.
subscriptionId
 path True

string

O identificador da subscrição.
api-version
 query True

string

A versão da API.

Corpo do Pedido

Name Tipo Description
tags

object

Etiquetas de recursos

Respostas

Name Tipo Description
200 OK

IotHubDescription

O Hub IoT foi atualizado com êxito

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IotHubResource_Update

Pedido de amostra

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/myHub?api-version=2023-06-30

{
  "tags": {
    "foo": "bar"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {
    "foo": "bar"
  },
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definições

Name Description
AccessRights

As permissões atribuídas à política de acesso partilhado.
ArmIdentity
ArmUserIdentity
AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.
authenticationType

Método utilizado para autenticar no ponto final da fila do service bus
Capabilities

As capacidades e funcionalidades ativadas para o hub IoT.
CloudToDeviceProperties

As propriedades de mensagens de cloud para dispositivo do hub IoT.
createdByType

O tipo de identidade que criou o recurso.
DefaultAction

Ação Predefinida para Conjunto de Regras de Rede
EnrichmentProperties

As propriedades de um melhoramento que o hub IoT aplica às mensagens entregues aos pontos finais.
EventHubProperties

As propriedades do ponto final compatível com o Hub de Eventos aprovisionado utilizado pelo hub IoT.
FallbackRouteProperties

As propriedades da rota de contingência. Hub IoT utiliza estas propriedades quando encaminha mensagens para o ponto final de contingência.
FeedbackProperties

As propriedades da fila de comentários para mensagens da cloud para o dispositivo.
IotHubDescription

A descrição do hub IoT.
IotHubLocationDescription

Representação pública de uma das localizações onde um recurso é aprovisionado.
IotHubProperties

As propriedades de um hub IoT.
IotHubReplicaRoleType

A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está atualmente aprovisionado. A região secundária é a região emparelhada de recuperação após desastre (DR) do Azure e também a região onde o hub IoT pode efetuar a ativação pós-falha.
IotHubSku

O nome do SKU.
IotHubSkuInfo

Informações sobre o SKU do hub IoT.
IotHubSkuTier

O escalão de faturação do hub IoT.
IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.
IpFilterRule

As regras de filtro de IP para o hub IoT.
ManagedIdentity

As propriedades da identidade gerida.
MessagingEndpointProperties

As propriedades dos pontos finais de mensagens utilizados por este hub IoT.
NetworkRuleIPAction

Ação de Filtro ip
NetworkRuleSetIpRule

Regra de IP a aplicar como parte do Conjunto de Regras de Rede
NetworkRuleSetProperties

Propriedades do Conjunto de Regras de Rede do IotHub
PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado
PrivateEndpointConnection

A ligação de ponto final privado de um IotHub
PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado
PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado
PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado
PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos
ResourceIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.
RouteProperties

As propriedades de uma regra de encaminhamento que o hub IoT utiliza para encaminhar mensagens para pontos finais.
RoutingCosmosDBSqlApiProperties

As propriedades relacionadas com um ponto final de contentor sql do cosmos DB.
RoutingEndpoints

As propriedades relacionadas com os pontos finais personalizados aos quais o 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 hubs pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para hubs gratuitos.
RoutingEventHubProperties

As propriedades relacionadas com um ponto final do hub de eventos.
RoutingProperties

As propriedades relacionadas com o encaminhamento do hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties

As propriedades relacionadas com os tipos de ponto final da fila do service bus.
RoutingServiceBusTopicEndpointProperties

As propriedades relacionadas com os tipos de ponto final do tópico do service bus.
RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.
RoutingStorageContainerProperties

As propriedades relacionadas com um ponto final de contentor de armazenamento.
SharedAccessSignatureAuthorizationRule

As propriedades de uma política de acesso partilhado do hub IoT.
StorageEndpointProperties

As propriedades do ponto final do Armazenamento do Azure para carregamento de ficheiros.
systemData

Metadados relativos à criação e última modificação do recurso.
TagsResource

Um contentor que contém apenas as Etiquetas de um recurso, permitindo ao utilizador atualizar as etiquetas numa instância de Hub IoT.

AccessRights

As permissões atribuídas à política de acesso partilhado.

Name Tipo Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ArmIdentity

Name Tipo Description
principalId

string

Principal Id
tenantId

string

ID do Inquilino
type

ResourceIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.
userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Name Tipo Description
clientId

string

principalId

string

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.

Name Tipo Description
identityBased

string

keyBased

string

authenticationType

Método utilizado para autenticar no ponto final da fila do service bus

Name Tipo Description
identityBased

string

keyBased

string

Capabilities

As capacidades e funcionalidades ativadas para o hub IoT.

Name Tipo Description
DeviceManagement

string

None

string

CloudToDeviceProperties

As propriedades de mensagens de cloud para dispositivo do hub IoT.

Name Tipo Description
defaultTtlAsIso8601

string

A hora predefinida para as mensagens da cloud para o dispositivo na fila do dispositivo. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback

FeedbackProperties

As propriedades da fila de comentários para mensagens da cloud para o dispositivo.
maxDeliveryCount

integer

A contagem máxima de entrega para mensagens da cloud para o dispositivo na fila do dispositivo. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Ação Predefinida para Conjunto de Regras de Rede

Name Tipo Description
Allow

string

Deny

string

EnrichmentProperties

As propriedades de um melhoramento que o hub IoT aplica às mensagens entregues aos pontos finais.

Name Tipo Description
endpointNames

string[]

A lista de pontos finais para os quais o melhoramento é aplicado à mensagem.
key

string

A chave ou o nome da propriedade de melhoramento.
value

string

O valor da propriedade de melhoramento.

EventHubProperties

As propriedades do ponto final compatível com o Hub de Eventos aprovisionado utilizado pelo hub IoT.

Name Tipo Description
endpoint

string

O ponto final compatível com o Hub de Eventos.
partitionCount

integer

O número de partições para receber mensagens do dispositivo para a cloud no ponto final compatível com o Hub de Eventos. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds

string[]

Os IDs de partição no ponto final compatível com o Hub de Eventos.
path

string

O nome compatível com o Hub de Eventos.
retentionTimeInDays

integer

O tempo de retenção das mensagens do dispositivo para a cloud em dias. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

As propriedades da rota de contingência. Hub IoT utiliza estas propriedades quando encaminha mensagens para o ponto final de contingência.

Name Tipo Description
condition

string

A condição que é avaliada para aplicar a rota de contingência. Se a condição não for fornecida, será avaliada como verdadeira por predefinição. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.
isEnabled

boolean

Utilizado para especificar se a rota de contingência está ativada.
name

string

O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.
source

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada. Por exemplo, DeviceMessages

FeedbackProperties

As propriedades da fila de comentários para mensagens da cloud para o dispositivo.

Name Tipo Description
lockDurationAsIso8601

string

A duração do bloqueio da fila de comentários. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount

integer

O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601

string

O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

A descrição do hub IoT.

Name Tipo Description
etag

string

O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal.
id

string

O identificador do recurso.
identity

ArmIdentity

As identidades geridas do IotHub.
location

string

A localização do recurso.
name

string

O nome do recurso.
properties

IotHubProperties

Propriedades do IotHub
sku

IotHubSkuInfo

Informações do SKU do IotHub
systemData

systemData

Os metadados do sistema relacionados com este recurso.
tags

object

As etiquetas de recursos.
type

string

O tipo de recurso.

IotHubLocationDescription

Representação pública de uma das localizações onde um recurso é aprovisionado.

Name Tipo Description
location

string

O nome da região do Azure
role

IotHubReplicaRoleType

A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está atualmente aprovisionado. A região secundária é a região emparelhada de recuperação após desastre (DR) do Azure e também a região onde o hub IoT pode efetuar a ativação pós-falha.

IotHubProperties

As propriedades de um hub IoT.

Name Tipo Description
allowedFqdnList

string[]

Lista de FQDNs permitidos (Nome de Domínio Completamente Qualificado) para saída do Hub Iot.
authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

As políticas de acesso partilhado que pode utilizar para proteger uma ligação ao hub IoT.
cloudToDevice

CloudToDeviceProperties

As propriedades de mensagens da cloud para o dispositivo do hub IoT.
comments

string

Comentários do hub IoT.
disableDeviceSAS

boolean

Se for verdadeiro, não é possível utilizar todas as chaves SAS no âmbito de dispositivos (incluindo dispositivos Edge, mas excluindo módulos) para autenticação.
disableLocalAuth

boolean

Se for verdadeiro, os tokens de SAS com chaves SAS no âmbito do hub Iot não podem ser utilizados para autenticação.
disableModuleSAS

boolean

Se for verdadeiro, todas as chaves SAS no âmbito do módulo não podem ser utilizadas para autenticação.
enableDataResidency

boolean

Esta propriedade, quando definida como verdadeira, ativará a residência dos dados, desativando assim a recuperação após desastre.
enableFileUploadNotifications

boolean

Se for Verdadeiro, as notificações de carregamento de ficheiros estão ativadas.
eventHubEndpoints

<string,  EventHubProperties>

As propriedades do ponto final compatível com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Esta chave tem de estar presente no dicionário ao criar ou atualizar chamadas para o hub IoT.
features

Capabilities

As capacidades e funcionalidades ativadas para o hub IoT.
hostName

string

O nome do anfitrião.
ipFilterRules

IpFilterRule[]

As regras de filtro de IP.
locations

IotHubLocationDescription[]

Localização primária e secundária para o hub iot
messagingEndpoints

<string,  MessagingEndpointProperties>

As propriedades do ponto final de mensagens para a fila de notificação de carregamento de ficheiros.
minTlsVersion

string

Especifica a versão mínima do TLS a suportar para este hub. Pode ser definido como "1.2" para que os clientes que utilizam uma versão do TLS abaixo da 1.2 sejam rejeitados.
networkRuleSets

NetworkRuleSetProperties

Propriedades do Conjunto de Regras de Rede do IotHub
privateEndpointConnections

PrivateEndpointConnection[]

Ligações de ponto final privado criadas neste IotHub
provisioningState

string

O estado de aprovisionamento.
publicNetworkAccess

PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos
restrictOutboundNetworkAccess

boolean

Se for verdadeiro, a saída do IotHub será restringida apenas aos FQDNs permitidos que estão configurados através de allowedFqdnList.
routing

RoutingProperties

As propriedades relacionadas com o encaminhamento do hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state

string

O estado do hub.
storageEndpoints

<string,  StorageEndpointProperties>

A lista de pontos finais do Armazenamento do Azure onde pode carregar ficheiros. Atualmente, só pode configurar uma conta de Armazenamento do Azure e esta tem de ter a respetiva chave como $default. Especificar mais do que uma conta de armazenamento causa um erro. Não especificar um valor para esta propriedade quando a propriedade enableFileUploadNotifications estiver definida como Verdadeiro, faz com que seja gerado um erro.

IotHubReplicaRoleType

A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está atualmente aprovisionado. A região secundária é a região emparelhada de recuperação após desastre (DR) do Azure e também a região onde o hub IoT pode efetuar a ativação pós-falha.

Name Tipo Description
primary

string

secondary

string

IotHubSku

O nome do SKU.

Name Tipo Description
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

Informações sobre o SKU do hub IoT.

Name Tipo Description
capacity

integer

O número de unidades de Hub IoT aprovisionadas. Consulte: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name

IotHubSku

O nome do SKU.
tier

IotHubSkuTier

O escalão de faturação do hub IoT.

IotHubSkuTier

O escalão de faturação do hub IoT.

Name Tipo Description
Basic

string

Free

string

Standard

string

IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.

Name Tipo Description
Accept

string

Reject

string

IpFilterRule

As regras de filtro de IP para o hub IoT.

Name Tipo Description
action

IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.
filterName

string

O nome da regra de filtro ip.
ipMask

string

Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.

ManagedIdentity

As propriedades da identidade gerida.

Name Tipo Description
userAssignedIdentity

string

A identidade atribuída pelo utilizador.

MessagingEndpointProperties

As propriedades dos pontos finais de mensagens utilizados por este hub IoT.

Name Tipo Description
lockDurationAsIso8601

string

A duração do bloqueio. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount

integer

O número de vezes que o hub IoT tenta entregar uma mensagem. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601

string

O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Ação de Filtro ip

Name Tipo Description
Allow

string

NetworkRuleSetIpRule

Regra de IP a aplicar como parte do Conjunto de Regras de Rede

Name Tipo Default value Description
action

NetworkRuleIPAction

Allow

Ação de Filtro ip
filterName

string

Nome da regra de filtro ip.
ipMask

string

Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.

NetworkRuleSetProperties

Propriedades do Conjunto de Regras de Rede do IotHub

Name Tipo Default value Description
applyToBuiltInEventHubEndpoint

boolean

Se For Verdadeiro, o Conjunto de Regras de Rede também é aplicado ao BuiltIn EventHub EndPoint do IotHub
defaultAction

DefaultAction

Deny

Ação Predefinida para Conjunto de Regras de Rede
ipRules

NetworkRuleSetIpRule[]

Lista de Regras de IP

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado

Name Tipo Description
id

string

O identificador de recursos.

PrivateEndpointConnection

A ligação de ponto final privado de um IotHub

Name Tipo Description
id

string

O identificador do recurso.
name

string

O nome do recurso.
properties

PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado
type

string

O tipo de recurso.

PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado

Name Tipo Description
privateEndpoint

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado

PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado

Name Tipo Description
actionsRequired

string

Ações necessárias para uma ligação de ponto final privado
description

string

A descrição do estado atual de uma ligação de ponto final privado
status

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos

Name Tipo Description
Disabled

string

Enabled

string

ResourceIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

As propriedades de uma regra de encaminhamento que o hub IoT utiliza para encaminhar mensagens para pontos finais.

Name Tipo Description
condition

string

A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.
isEnabled

boolean

Utilizado para especificar se uma rota está ativada.
name

string

O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.
source

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.

RoutingCosmosDBSqlApiProperties

As propriedades relacionadas com um ponto final de contentor sql do cosmos DB.

Name Tipo Description
authenticationType

authenticationType

Método utilizado para autenticar no ponto final do contentor sql do cosmos DB
containerName

string

O nome do contentor sql do cosmos DB na base de dados cosmos DB.
databaseName

string

O nome da base de dados cosmos DB na conta do Cosmos DB.
endpointUri

string

O URL da conta do Cosmos DB. Tem de incluir o protocolo https://
id

string

ID do ponto final do contentor sql do cosmos DB
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.
name

string

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.
partitionKeyName

string

O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.
partitionKeyTemplate

string

O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do Cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM} e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.
primaryKey

string

A chave primária da conta do Cosmos DB.
resourceGroup

string

O nome do grupo de recursos da conta cosmos DB.
secondaryKey

string

A chave secundária da conta do Cosmos DB.
subscriptionId

string

O identificador da subscrição da conta do Cosmos DB.

RoutingEndpoints

As propriedades relacionadas com os pontos finais personalizados aos quais o 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 hubs pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para hubs gratuitos.

Name Tipo Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

A lista de pontos finais de contentor do Cosmos DB para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.
eventHubs

RoutingEventHubProperties[]

A lista de pontos finais dos Hubs de Eventos para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento. Esta lista não inclui o ponto final incorporado dos Hubs de Eventos.
serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

A lista de pontos finais de fila do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.
serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

A lista de pontos finais do tópico do Service Bus para os quais o hub IoT encaminha as mensagens, com base nas regras de encaminhamento.
storageContainers

RoutingStorageContainerProperties[]

A lista de pontos finais de contentor de armazenamento para os quais o hub IoT encaminha mensagens, com base nas regras de encaminhamento.

RoutingEventHubProperties

As propriedades relacionadas com um ponto final do hub de eventos.

Name Tipo Description
authenticationType

authenticationType

Método utilizado para autenticar no ponto final do hub de eventos
connectionString

string

A cadeia de ligação do ponto final do hub de eventos.
endpointUri

string

O URL do ponto final do hub de eventos. Tem de incluir o protocolo sb://
entityPath

string

Nome do hub de eventos no espaço de nomes do hub de eventos
id

string

ID do ponto final do hub de eventos
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final do hub de eventos de encaminhamento.
name

string

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.
resourceGroup

string

O nome do grupo de recursos do ponto final do hub de eventos.
subscriptionId

string

O identificador da subscrição do ponto final do hub de eventos.

RoutingProperties

As propriedades relacionadas com o encaminhamento do hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name Tipo Description
endpoints

RoutingEndpoints

As propriedades relacionadas com os pontos finais personalizados para os 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 hubs pagos e apenas 1 ponto final personalizado é permitido em todos os tipos de pontos finais para hubs gratuitos.
enrichments

EnrichmentProperties[]

A lista de melhoramentos fornecidos pelo utilizador que o hub IoT aplica às mensagens a entregar a pontos finais incorporados e personalizados. Veja: https://aka.ms/telemetryoneventgrid
fallbackRoute

FallbackRouteProperties

As propriedades da rota que é utilizada como uma rota de contingência quando nenhuma das condições especificadas na secção "rotas" é cumprida. Este é um parâmetro opcional. Quando esta propriedade não está presente no modelo, a rota de contingência é desativada por predefinição.
routes

RouteProperties[]

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 hubs pagos e são permitidas um máximo de 5 regras de encaminhamento para hubs gratuitos.

RoutingServiceBusQueueEndpointProperties

As propriedades relacionadas com os tipos de ponto final da fila do service bus.

Name Tipo Description
authenticationType

authenticationType

Método utilizado para autenticar no ponto final da fila do service bus
connectionString

string

A cadeia de ligação do ponto final da fila do service bus.
endpointUri

string

O URL do ponto final da fila do service bus. Tem de incluir o protocolo sb://
entityPath

string

Nome da fila no espaço de nomes do service bus
id

string

ID do ponto final da fila do service bus
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final da fila do service bus de encaminhamento.
name

string

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais. O nome não tem de ser o mesmo que o nome da fila real.
resourceGroup

string

O nome do grupo de recursos do ponto final da fila do service bus.
subscriptionId

string

O identificador da subscrição do ponto final da fila do service bus.

RoutingServiceBusTopicEndpointProperties

As propriedades relacionadas com os tipos de ponto final do tópico do service bus.

Name Tipo Description
authenticationType

authenticationType

Método utilizado para autenticar no ponto final do tópico do service bus
connectionString

string

A cadeia de ligação do ponto final do tópico do service bus.
endpointUri

string

O URL do ponto final do tópico do service bus. Tem de incluir o protocolo sb://
entityPath

string

Nome da fila no tópico do service bus
id

string

ID do ponto final do tópico do service bus
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final do tópico do barramento de serviço de encaminhamento.
name

string

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais. O nome não tem de ser o mesmo que o nome do tópico real.
resourceGroup

string

O nome do grupo de recursos do ponto final do tópico do service bus.
subscriptionId

string

O identificador da subscrição do ponto final do tópico do service bus.

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.

Name Tipo Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

As propriedades relacionadas com um ponto final de contentor de armazenamento.

Name Tipo Description
authenticationType

authenticationType

Método utilizado para autenticar no ponto final de armazenamento
batchFrequencyInSeconds

integer

Intervalo de tempo em que os blobs são escritos no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor predefinido é 300 segundos.
connectionString

string

A cadeia de ligação da conta de armazenamento.
containerName

string

O nome do contentor de armazenamento na conta de armazenamento.
encoding enum:
  • Avro
  • AvroDeflate
  • JSON

Codificação utilizada para serializar mensagens para blobs. Os valores suportados são "avro", "avrodeflate" e "JSON". O valor predefinido é "avro".
endpointUri

string

O URL do ponto final de armazenamento. Tem de incluir o protocolo https://
fileNameFormat

string

Formato de nome de ficheiro para o blob. O formato predefinido é {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados.
id

string

ID do ponto final do contentor de armazenamento
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final de armazenamento de encaminhamento.
maxChunkSizeInBytes

integer

Número máximo de bytes para cada blob escrito no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor predefinido é 314572800(300 MB).
name

string

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes e tem um comprimento máximo de 64 carateres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos em todos os tipos de pontos finais.
resourceGroup

string

O nome do grupo de recursos da conta de armazenamento.
subscriptionId

string

O identificador da subscrição da conta de armazenamento.

SharedAccessSignatureAuthorizationRule

As propriedades de uma política de acesso partilhado do hub IoT.

Name Tipo Description
keyName

string

O nome da política de acesso partilhado.
primaryKey

string

A chave primária.
rights

AccessRights

As permissões atribuídas à política de acesso partilhado.
secondaryKey

string

A chave secundária.

StorageEndpointProperties

As propriedades do ponto final do Armazenamento do Azure para carregamento de ficheiros.

Name Tipo Description
authenticationType

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar à conta de armazenamento.
connectionString

string

O cadeia de ligação para a conta de Armazenamento do Azure para a qual os ficheiros são carregados.
containerName

string

O nome do contentor de raiz onde carrega ficheiros. O contentor não precisa de existir, mas deve ser criável com a connectionString especificada.
identity

ManagedIdentity

Propriedades de identidade gerida do ponto final de armazenamento para carregamento de ficheiros.
sasTtlAsIso8601

string

O período de tempo para o qual o URI de SAS gerado pelo Hub IoT para carregamento de ficheiros é válido. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TagsResource

Um contentor que contém apenas as Etiquetas de um recurso, permitindo ao utilizador atualizar as etiquetas numa instância de Hub IoT.

Name Tipo Description
tags

object

Etiquetas de recursos