Iot Hub Resource - Create Or Update

Crie ou atualize os metadados de um hub Iot. O padrão usual para modificar uma propriedade é recuperar os metadados do hub IoT e os metadados de segurança e, em seguida, combiná-los com os valores modificados em um novo corpo para atualizar o hub IoT.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2026-11-01

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não faz distinção entre maiúsculas e minúsculas.

resourceName
path True

string

O nome do hub IoT.

subscriptionId
path True

string (uuid)

O ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Nome Obrigatório Tipo Descrição
If-Match

string

ETag do Hub IoT. Não especifique para criar um novo Hub IoT. Necessário para atualizar um Hub IoT existente.

Corpo do Pedido

Nome Obrigatório Tipo Descrição
location True

string

A geolocalização onde o recurso vive

sku True

IotHubSkuInfo

Informações sobre o SKU do IotHub

etag

string

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

identity

ArmIdentity

As identidades gerenciadas para o IotHub.

properties

IotHubProperties

Propriedades do IotHub

tags

object

Tags de recursos.

Respostas

Nome Tipo Descrição
200 OK

IotHubDescription

Operação de atualização do recurso 'IotHubDescription' bem-sucedida

201 Created

IotHubDescription

Recurso 'IotHubDescription' criar operação bem-sucedida

Cabeçalhos

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorDetails

Uma resposta de erro inesperada.

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

Nome Descrição
user_impersonation assumir a identidade da sua conta de utilizador

Exemplos

CreateOrReplace_IotHub
IotHubResource_CreateOrUpdate

CreateOrReplace_IotHub

Pedido de amostra

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2026-11-01

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "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"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Resposta da amostra

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "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",
    "deviceHostName": "iot-dps-cit-hub-1.device.azure-devices.net",
    "serviceHostName": "iot-dps-cit-hub-1.service.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": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true,
    "iotHubDetails": {
      "gatewayVersion": "V2"
    }
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "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",
    "deviceHostName": "iot-dps-cit-hub-1.device.azure-devices.net",
    "serviceHostName": "iot-dps-cit-hub-1.service.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": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true,
    "iotHubDetails": {
      "gatewayVersion": "V2"
    }
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

IotHubResource_CreateOrUpdate

Pedido de amostra

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2026-11-01

{
  "etag": "AAAAAAFD6M4=",
  "location": "centraluseuap",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "partitionCount": 2,
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "ipFilterRules": [],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Resposta da amostra

{
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "etag": "AAAAAAFD6M4=",
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "location": "centraluseuap",
  "identity": {
    "tenantId": "11111111-2222-3333-4444-555555555555",
    "type": "SystemAssigned",
    "principalId": "66666666-7777-8888-9999-aaaaaaaaaaaa"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/",
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "ipFilterRules": [
      {
        "action": "Accept",
        "filterName": "rule1",
        "ipMask": "131.117.159.53"
      },
      {
        "action": "Accept",
        "filterName": "rule2",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "provisioningState": "Succeeded",
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "id": "00000000-1111-2222-3333-0123456789ab",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "state": "Active",
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1,
    "tier": "Standard"
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  },
  "tags": {}
}
{
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "etag": "AAAAAAFD6M4=",
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "location": "centraluseuap",
  "identity": {
    "tenantId": "11111111-2222-3333-4444-555555555555",
    "type": "SystemAssigned",
    "principalId": "66666666-7777-8888-9999-aaaaaaaaaaaa"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/",
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "ipFilterRules": [
      {
        "action": "Accept",
        "filterName": "rule1",
        "ipMask": "131.117.159.53"
      },
      {
        "action": "Accept",
        "filterName": "rule2",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "provisioningState": "Succeeded",
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "id": "00000000-1111-2222-3333-0123456789ab",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "state": "Active",
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1,
    "tier": "Standard"
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  },
  "tags": {}
}

Definições

Nome Descrição
AccessRights

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

ArmIdentity
ArmUserIdentity
AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

Capabilities

Os recursos habilitados para o hub IoT.

CloudToDeviceProperties

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

createdByType

O tipo de identidade que criou o recurso.

DefaultAction

Ação padrão para o conjunto de regras de rede

DeviceRegistry

Representa propriedades relacionadas ao Registro de Dispositivo do Azure (ADR).

DeviceRegistryIdentity

A identidade usada para gerenciar o namespace ADR a partir do plano de dados.

DeviceRegistryIdentityType

O tipo da identidade.

DeviceRegistryLinkingProperties

As propriedades relacionadas com a ligação do Hub IoT ao Azure Device Registry.

DeviceRegistryLinkingState

Indica se o Hub IoT está ligado a um Azure Device Registry.

EnrichmentProperties

As propriedades de um enriquecimento que seu hub IoT aplica às mensagens entregues aos pontos de extremidade.

ErrorDetails

Detalhes do erro.

EventHubProperties

As propriedades do ponto de extremidade compatível com o Hub de Eventos provisionado usado pelo hub IoT.

EventStreamAuthenticationType

Especifica o tipo de autenticação usado para se ligar à conta do fluxo de eventos.

FallbackRouteProperties

As propriedades da rota de fallback. O Hub IoT usa essas propriedades quando roteia mensagens para o ponto de extremidade de fallback.

FallbackRouteSource

A origem à qual a rota de retenção é aplicada.

FeedbackProperties

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

GatewayVersion

A versão IoT hub Gateway.

IotHubDescription

A descrição do hub IoT.

IotHubDetails

Conjunto de propriedades adicionais de apenas leitura para o hub IoT.

IotHubLocationDescription

Representação pública de um dos locais onde um recurso é provisionado.

IotHubProperties

As propriedades de um hub IoT.

IotHubReplicaRoleType

O papel da região pode ser primário ou secundário. A região principal é onde o hub IoT está atualmente provisionado. A região secundária é a região emparelhada de recuperação de desastres (DR) do Azure e também a região para a qual o hub IoT pode fazer failover.

IotHubSku

O nome do SKU.

IotHubSkuInfo

Informações sobre o SKU do hub IoT.

IotHubSkuTier

A camada de faturamento para o hub IoT.

IpFilterActionType

A ação desejada para solicitações capturadas por esta regra.

IpFilterRule

As regras de filtro IP para o hub IoT.

ManagedIdentity

As propriedades da identidade gerenciada.

MessagingEndpointProperties

As propriedades dos pontos de extremidade de mensagens usados por esse hub IoT.

NetworkRuleIPAction

Ação de filtro IP

NetworkRuleSetIpRule

Regra IP a ser aplicada como parte do Conjunto de Regras de Rede

NetworkRuleSetProperties

Propriedades do conjunto de regras de rede do IotHub

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um IotHub

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privada

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privada

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

RouteProperties

As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade.

RoutingCosmosDBSqlApiProperties

As propriedades relacionadas a um ponto de extremidade de contêiner sql do cosmos DB.

RoutingEndpoints

As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.

RoutingEventHubProperties

As propriedades relacionadas a um ponto de extremidade do hub de eventos.

RoutingEventStreamProperties

As propriedades relacionadas com um endpoint de fluxo de eventos.

RoutingProperties

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

RoutingServiceBusQueueEndpointProperties

As propriedades relacionadas aos tipos de ponto de extremidade da fila do barramento de serviço.

RoutingServiceBusTopicEndpointProperties

As propriedades relacionadas aos tipos de ponto de extremidade de tópico do barramento de serviço.

RoutingSource

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

RoutingStorageContainerProperties

As propriedades relacionadas a um ponto de extremidade de contêiner de armazenamento.

RoutingStorageContainerPropertiesEncoding

Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.

SharedAccessSignatureAuthorizationRule

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

StorageEndpointProperties

As propriedades do ponto de extremidade do Armazenamento do Azure para carregamento de arquivos.

systemData

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

AccessRights

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

Valor Descrição
RegistryRead

RegistryRead

RegistryWrite

RegistryWrite

ServiceConnect

ServiceConnect

DeviceConnect

DeviceConnect

RegistryRead, RegistryWrite

RegistryRead, RegistryWrite

RegistryRead, ServiceConnect

RegistryRead, ServiceConnect

RegistryRead, DeviceConnect

RegistryRead, DeviceConnect

RegistryWrite, ServiceConnect

RegistryWrite, ServiceConnect

RegistryWrite, DeviceConnect

RegistryWrite, DeviceConnect

ServiceConnect, DeviceConnect

ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ArmIdentity

Nome Tipo Descrição
principalId

string

Identificação do Diretor

tenantId

string

ID do inquilino

type

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

userAssignedIdentities

<string,  ArmUserIdentity>

Dicionário de <ArmUserIdentity>

ArmUserIdentity

Nome Tipo Descrição
clientId

string

principalId

string

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

Valor Descrição
keyBased

KeyBased

identityBased

IdentidadeBaseada

Capabilities

Os recursos habilitados para o hub IoT.

Valor Descrição
None

Nenhuma

DeviceManagement

Gestão de Dispositivos

CloudToDeviceProperties

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

Nome Tipo Descrição
defaultTtlAsIso8601

string (duration)

O tempo de vida padrão para mensagens de nuvem para dispositivo na fila de dispositivos. Ver: 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 nuvem para o dispositivo.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

DefaultAction

Ação padrão para o conjunto de regras de rede

Valor Descrição
Deny

Negar

Allow

Permitir

DeviceRegistry

Representa propriedades relacionadas ao Registro de Dispositivo do Azure (ADR).

Nome Tipo Descrição
dataPlaneHostName

string

O nome do host para o ponto final do plano de dados do Azure Device Registry associado.

identity

DeviceRegistryIdentity

A identidade usada para gerenciar o namespace ADR a partir do plano de dados.

linkingProperties

DeviceRegistryLinkingProperties

As propriedades relacionadas com a ligação do Hub IoT ao Azure Device Registry.

namespaceResourceId

string (arm-id)

O identificador do namespace Azure Device Registry

namespaceUuid

string

O UUID do espaço de nomes Azure Device Registry associado.

DeviceRegistryIdentity

A identidade usada para gerenciar o namespace ADR a partir do plano de dados.

Nome Tipo Descrição
type

DeviceRegistryIdentityType

O tipo da identidade.

userAssignedIdentity

string (arm-id)

A identidade atribuída pelo utilizador se o tipo de identidade for 'UserAssigned'.

DeviceRegistryIdentityType

O tipo da identidade.

Valor Descrição
SystemAssigned

Utilize uma identidade gerida atribuída pelo sistema para gerir o namespace ADR.

UserAssigned

Use uma identidade gerida atribuída pelo utilizador para gerir o espaço de nomes ADR.

DeviceRegistryLinkingProperties

As propriedades relacionadas com a ligação do Hub IoT ao Azure Device Registry.

Nome Tipo Descrição
error

ErrorDetails

O último erro encontrado ao ligar o Hub IoT a um Registo de Dispositivos Azure.

state

DeviceRegistryLinkingState

Indica se o Hub IoT está ligado a um Azure Device Registry.

DeviceRegistryLinkingState

Indica se o Hub IoT está ligado a um Azure Device Registry.

Valor Descrição
InProgress

A ligação do Hub IoT ao Azure Device Registry está em curso.

Success

O Hub IoT está ligado com sucesso a um Azure Device Registry.

Orphaned

O Azure Device Registry ligado já não está associado ao Hub IoT.

Failed

O Hub IoT falhou em ligar-se ao Azure Device Registry.

EnrichmentProperties

As propriedades de um enriquecimento que seu hub IoT aplica às mensagens entregues aos pontos de extremidade.

Nome Tipo Descrição
endpointNames

string[]

A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem.

key

string

A chave ou o nome da propriedade de enriquecimento.

value

string

O valor da propriedade de enriquecimento.

ErrorDetails

Detalhes do erro.

Nome Tipo Descrição
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status HTTP.

message

string

A mensagem de erro.

EventHubProperties

As propriedades do ponto de extremidade compatível com o Hub de Eventos provisionado usado pelo hub IoT.

Nome Tipo Descrição
endpoint

string

O ponto de extremidade compatível com o Hub de Eventos.

partitionCount

integer (int32)

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

partitionIds

string[]

As ids de partição no ponto de extremidade compatível com o Hub de Eventos.

path

string

O nome compatível com o Hub de Eventos.

retentionTimeInDays

integer (int64)

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

EventStreamAuthenticationType

Especifica o tipo de autenticação usado para se ligar à conta do fluxo de eventos.

Valor Descrição
identityBased

Autenticação baseada em identidade

FallbackRouteProperties

As propriedades da rota de fallback. O Hub IoT usa essas propriedades quando roteia mensagens para o ponto de extremidade de fallback.

Nome Tipo Descrição
condition

string

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

endpointNames

string[]

A lista de pontos de extremidade para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, apenas 1 ponto final é permitido.

isEnabled

boolean

Usado para especificar se a rota de fallback está habilitada.

name

string

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

source

FallbackRouteSource

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

FallbackRouteSource

A origem à qual a rota de retenção é aplicada.

Valor Descrição
DeviceMessages

Mensagens dispositivo-para-nuvem enviadas pelos dispositivos.

FeedbackProperties

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

Nome Tipo Descrição
lockDurationAsIso8601

string (duration)

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

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

ttlAsIso8601

string (duration)

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

GatewayVersion

A versão IoT hub Gateway.

Valor Descrição
V1

V1

V2

V2

IotHubDescription

A descrição do hub IoT.

Nome Tipo Descrição
etag

string

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

id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ArmIdentity

As identidades gerenciadas para o IotHub.

location

string

A geolocalização onde o recurso vive

name

string

O nome do recurso

properties

IotHubProperties

Propriedades do IotHub

sku

IotHubSkuInfo

Informações sobre o SKU do IotHub

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IotHubDetails

Conjunto de propriedades adicionais de apenas leitura para o hub IoT.

Nome Tipo Descrição
gatewayVersion

GatewayVersion

A versão IoT hub Gateway.

IotHubLocationDescription

Representação pública de um dos locais onde um recurso é provisionado.

Nome Tipo Descrição
location

string

O nome da região do Azure

role

IotHubReplicaRoleType

O papel da região pode ser primário ou secundário. A região principal é onde o hub IoT está atualmente provisionado. A região secundária é a região emparelhada de recuperação de desastres (DR) do Azure e também a região para a qual o hub IoT pode fazer failover.

IotHubProperties

As propriedades de um hub IoT.

Nome Tipo Descrição
allowedFqdnList

string[]

Lista de FQDNs (Fully Qualified Domain Name) permitidos para saída do Iot Hub.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o hub IoT.

cloudToDevice

CloudToDeviceProperties

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

comments

string

Comentários do hub IoT.

deviceHostName

string

O nome do anfitrião do dispositivo. Suporta ligações seguras via TLS 1.3.

deviceRegistry

DeviceRegistry

Representa propriedades relacionadas ao Registro de Dispositivo do Azure (ADR).

disableDeviceSAS

boolean

Se verdadeiro, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos de Borda, mas excluindo módulos) não podem ser usadas para autenticação.

disableLocalAuth

boolean

Se verdadeiro, os tokens SAS com chaves SAS com escopo do hub Iot não podem ser usados para autenticação.

disableModuleSAS

boolean

Se verdadeiro, todas as chaves SAS com escopo de módulo não podem ser usadas para autenticação.

enableDataResidency

boolean

Essa propriedade, quando definida como true, habilitará a residência de dados, desativando a recuperação de desastres.

enableFileUploadNotifications

boolean

Se True, as notificações de upload de arquivo estão habilitadas.

eventHubEndpoints

<string,  EventHubProperties>

As propriedades do ponto de extremidade compatível com o Hub de Eventos. As únicas chaves possíveis para este dicionário são os eventos. Essa chave deve estar presente no dicionário ao fazer chamadas de criação ou atualização para o hub IoT.

features

Capabilities

Os recursos habilitados para o hub IoT.

hostName

string

O nome do anfitrião.

iotHubDetails

IotHubDetails

Conjunto de propriedades adicionais de apenas leitura para o hub IoT.

ipFilterRules

IpFilterRule[]

As regras de filtro IP.

locations

IotHubLocationDescription[]

Local primário e secundário para hub iot

messagingEndpoints

<string,  MessagingEndpointProperties>

As propriedades do ponto de extremidade de mensagens para a fila de notificação de carregamento de arquivo.

minTlsVersion

string

Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados.

networkRuleSets

NetworkRuleSetProperties

Propriedades do conjunto de regras de rede do IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privadas criadas neste IotHub

provisioningState

string

O estado de provisionamento.

publicNetworkAccess

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

restrictOutboundNetworkAccess

boolean

Se true, a saída do IotHub será restrita apenas aos FQDNs permitidos que são configurados via allowedFqdnList.

routing

RoutingProperties

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

serviceHostName

string

O nome do anfitrião de serviço. Suporta ligações seguras via TLS 1.3.

state

string

O estado do hub.

storageEndpoints

<string,  StorageEndpointProperties>

A lista de pontos de extremidade do Armazenamento do Azure onde você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e essa DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja lançado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications está definida como True, faz com que um erro seja lançado.

IotHubReplicaRoleType

O papel da região pode ser primário ou secundário. A região principal é onde o hub IoT está atualmente provisionado. A região secundária é a região emparelhada de recuperação de desastres (DR) do Azure e também a região para a qual o hub IoT pode fazer failover.

Valor Descrição
primary

primário

secondary

secundário

IotHubSku

O nome do SKU.

Valor Descrição
F1

F1

S1

S1

S2

S2

S3

S3

B1

B1

B2

B2

B3

B3

IotHubSkuInfo

Informações sobre o SKU do hub IoT.

Nome Tipo Descrição
capacity

integer (int64)

O número de unidades provisionadas do Hub IoT. Ver: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

O nome do SKU.

tier

IotHubSkuTier

A camada de faturamento para o hub IoT.

IotHubSkuTier

A camada de faturamento para o hub IoT.

Valor Descrição
Free

Gratuito

Standard

Standard

Basic

Básico

IpFilterActionType

A ação desejada para solicitações capturadas por esta regra.

Valor Descrição
Accept

Aceitar

Reject

Rejeitar

IpFilterRule

As regras de filtro IP para o hub IoT.

Nome Tipo Descrição
action

IpFilterActionType

A ação desejada para solicitações capturadas por esta regra.

filterName

string

O nome da regra de filtro IP.

ipMask

string

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

ManagedIdentity

As propriedades da identidade gerenciada.

Nome Tipo Descrição
userAssignedIdentity

string

A identidade atribuída ao usuário.

MessagingEndpointProperties

As propriedades dos pontos de extremidade de mensagens usados por esse hub IoT.

Nome Tipo Descrição
lockDurationAsIso8601

string (duration)

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

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

ttlAsIso8601

string (duration)

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

NetworkRuleIPAction

Ação de filtro IP

Valor Descrição
Allow

Permitir

NetworkRuleSetIpRule

Regra IP a ser aplicada como parte do Conjunto de Regras de Rede

Nome Tipo Valor predefinido Descrição
action

NetworkRuleIPAction

Allow

Ação de filtro IP

filterName

string

Nome da regra de filtro IP.

ipMask

string

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

NetworkRuleSetProperties

Propriedades do conjunto de regras de rede do IotHub

Nome Tipo Valor predefinido Descrição
applyToBuiltInEventHubEndpoint

boolean

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

defaultAction

DefaultAction

Deny

Ação padrão para o conjunto de regras de rede

ipRules

NetworkRuleSetIpRule[]

Lista de regras de PI

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada

Nome Tipo Descrição
id

string

O identificador de recurso.

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um IotHub

Nome Tipo Descrição
id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privada

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privada

Nome Tipo Descrição
privateEndpoint

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privada

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

Nome Tipo Descrição
actionsRequired

string

Ações necessárias para uma conexão de ponto de extremidade privada

description

string

A descrição do estado atual de uma conexão de ponto de extremidade privada

status

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privada

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privada

Valor Descrição
Pending

Pendente

Approved

Approved

Rejected

Rejeitado

Disconnected

Disconnected

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

Valor Descrição
Enabled

Enabled

Disabled

Disabled

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

Valor Descrição
SystemAssigned

SystemAssigned

UserAssigned

UserAssigned

SystemAssigned, UserAssigned

SystemAssigned, UserAssigned

None

Nenhuma

RouteProperties

As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade.

Nome Tipo Descrição
condition

string

A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

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

isEnabled

boolean

Usado para especificar se uma rota está habilitada.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

source

RoutingSource

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

RoutingCosmosDBSqlApiProperties

As propriedades relacionadas a um ponto de extremidade de contêiner sql do cosmos DB.

Nome Tipo Descrição
authenticationType

AuthenticationType

Método usado para autenticar no ponto de extremidade do contêiner sql do cosmos DB

containerName

string

O nome do contêiner sql do cosmos DB no banco de dados do cosmos DB.

databaseName

string

O nome do banco de dados do cosmos DB na conta do cosmos DB.

endpointUri

string (uri)

A url da conta do cosmos DB. Deve incluir o protocolo https://

id

string

Id do ponto de extremidade do contêiner sql do cosmos DB

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade de contêiner do roteamento do cosmos DB.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

partitionKeyName

string

O nome da chave de partição associada a este contêiner 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 uso com este contêiner sql do cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM} e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas os componentes de ordem e não espaço reservado são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.

primaryKey

string (password)

A chave primária da conta do cosmos DB.

resourceGroup

string

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

secondaryKey

string (password)

A chave secundária da conta do cosmos DB.

subscriptionId

string

O identificador de assinatura da conta do cosmos DB.

RoutingEndpoints

As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.

Nome Tipo Descrição
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o hub IoT roteia mensagens, com base nas regras de roteamento.

eventHubs

RoutingEventHubProperties[]

A lista de pontos de extremidade de Hubs de Eventos para os quais o hub IoT roteia mensagens, com base nas regras de roteamento. Esta lista não inclui o ponto de extremidade interno dos Hubs de Eventos.

eventStreams

RoutingEventStreamProperties[]

A lista de endpoints de fluxo de eventos para onde o hub IoT encaminha mensagens, com base nas regras de encaminhamento.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

A lista de pontos de extremidade de fila do Service Bus para os quais o hub IoT roteia as mensagens, com base nas regras de roteamento.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

A lista de pontos de extremidade de tópico do Service Bus para os quais o hub IoT roteia as mensagens, com base nas regras de roteamento.

storageContainers

RoutingStorageContainerProperties[]

A lista de pontos de extremidade de contêiner de armazenamento para os quais o hub IoT roteia mensagens, com base nas regras de roteamento.

RoutingEventHubProperties

As propriedades relacionadas a um ponto de extremidade do hub de eventos.

Nome Tipo Descrição
authenticationType

AuthenticationType

Método usado para autenticar no ponto de extremidade do hub de eventos

connectionString

string (password)

A cadeia de conexão do ponto de extremidade do hub de eventos.

endpointUri

string

A url do ponto de extremidade do hub de eventos. Deve incluir o protocolo sb://

entityPath

string

Nome do hub de eventos no namespace do hub de eventos

id

string

Id do ponto de extremidade do hub de eventos

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade do hub de eventos de roteamento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

resourceGroup

string

O nome do grupo de recursos do ponto de extremidade do hub de eventos.

subscriptionId

string

O identificador de assinatura do ponto de extremidade do hub de eventos.

RoutingEventStreamProperties

As propriedades relacionadas com um endpoint de fluxo de eventos.

Nome Tipo Descrição
authenticationType

EventStreamAuthenticationType

Método usado para autenticar contra o endpoint do fluxo de eventos

endpointUri

string

A URL do namespace do hub de eventos subjacente do endpoint do fluxo de eventos. Deve incluir o protocolo sb://

entityPath

string

Nome do hub de eventos no namespace do hub de eventos

eventStreamId

string

O GUID único do fluxo de eventos alvo sob o espaço de trabalho.

id

string

ID do endpoint do fluxo de eventos

identity

ManagedIdentity

Propriedades de identidade gerida do endpoint do fluxo de eventos de roteamento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

sourceId

string

O GUID único da fonte personalizada para o fluxo de eventos.

workspaceId

string

O GUID único do espaço de trabalho Microsoft Fabric alvo para o endpoint do fluxo de eventos.

RoutingProperties

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

Nome Tipo Descrição
endpoints

RoutingEndpoints

As propriedades relacionadas aos pontos de extremidade personalizados para os quais seu hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.

enrichments

EnrichmentProperties[]

A lista de enriquecimentos fornecidos pelo usuário que o hub IoT aplica a mensagens a serem entregues a pontos de extremidade internos e personalizados. Veja: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção 'rotas' é atendida. Este é um parâmetro opcional. Quando essa propriedade não é definida, as mensagens que não atendem a nenhuma das condições especificadas na seção 'rotas' são roteadas para o ponto de extremidade do eventhub interno.

routes

RouteProperties[]

A lista de regras de roteamento fornecidas pelo usuário que o hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. Um máximo de 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos.

RoutingServiceBusQueueEndpointProperties

As propriedades relacionadas aos tipos de ponto de extremidade da fila do barramento de serviço.

Nome Tipo Descrição
authenticationType

AuthenticationType

Método usado para autenticar no ponto de extremidade da fila do barramento de serviço

connectionString

string (password)

A cadeia de conexão do ponto de extremidade da fila do barramento de serviço.

endpointUri

string

A url do ponto de extremidade da fila do barramento de serviço. Deve incluir o protocolo sb://

entityPath

string

Nome da fila no namespace do barramento de serviço

id

string

Id do ponto de extremidade da fila do barramento de serviço

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade da fila do barramento de serviço de roteamento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome da fila real.

resourceGroup

string

O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço.

subscriptionId

string

O identificador de assinatura do ponto de extremidade da fila do barramento de serviço.

RoutingServiceBusTopicEndpointProperties

As propriedades relacionadas aos tipos de ponto de extremidade de tópico do barramento de serviço.

Nome Tipo Descrição
authenticationType

AuthenticationType

Método usado para autenticar no ponto de extremidade do tópico do barramento de serviço

connectionString

string (password)

A cadeia de conexão do ponto de extremidade do tópico do barramento de serviço.

endpointUri

string

A url do ponto de extremidade do tópico do barramento de serviço. Deve incluir o protocolo sb://

entityPath

string

Nome da fila no tópico do barramento de serviço

id

string

Id do ponto de extremidade do tópico do barramento de serviço

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade do tópico do barramento de serviço de roteamento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados hífenes e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: events, fileNotifications, $default. Os nomes de pontos finais devem ser exclusivos entre os tipos de pontos finais. O nome não precisa ser o mesmo que o nome do tópico real.

resourceGroup

string

O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço.

subscriptionId

string

O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço.

RoutingSource

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

Valor Descrição
Invalid

Inválido

DeviceMessages

DeviceMessages

TwinChangeEvents

TwinChangeEvents

DeviceLifecycleEvents

DeviceLifecycleEvents

DeviceJobLifecycleEvents

DeviceJobLifecycleEvents

DeviceConnectionStateEvents

DeviceConnectionStateEvents

RoutingStorageContainerProperties

As propriedades relacionadas a um ponto de extremidade de contêiner de armazenamento.

Nome Tipo Descrição
authenticationType

AuthenticationType

Método usado para autenticar no ponto de extremidade de armazenamento

batchFrequencyInSeconds

integer (int32)

minimum: 60
maximum: 720

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

connectionString

string (password)

A cadeia de conexão da conta de armazenamento.

containerName

string

O nome do contêiner de armazenamento na conta de armazenamento.

encoding

RoutingStorageContainerPropertiesEncoding

Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.

endpointUri

string

A url do ponto de extremidade de armazenamento. Deve incluir o protocolo https://

fileNameFormat

string

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

id

string

Id do ponto de extremidade do contêiner de armazenamento

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade de armazenamento de roteamento.

maxChunkSizeInBytes

integer (int32)

minimum: 10485760
maximum: 524288000

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

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

resourceGroup

string

O nome do grupo de recursos da conta de armazenamento.

subscriptionId

string

O identificador de assinatura da conta de armazenamento.

RoutingStorageContainerPropertiesEncoding

Codificação usada para serializar mensagens em blobs. Os valores suportados são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'.

Valor Descrição
Avro

Avro

AvroDeflate

AvroDeflate

JSON

JSON

SharedAccessSignatureAuthorizationRule

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

Nome Tipo Descrição
keyName

string

O nome da política de acesso compartilhado.

primaryKey

string

A chave primária.

rights

AccessRights

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

secondaryKey

string

A chave secundária.

StorageEndpointProperties

As propriedades do ponto de extremidade do Armazenamento do Azure para carregamento de arquivos.

Nome Tipo Descrição
authenticationType

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.

connectionString

string

A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados.

containerName

string

O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado.

identity

ManagedIdentity

Propriedades de identidade gerenciadas do ponto de extremidade de armazenamento para upload de arquivos.

sasTtlAsIso8601

string (duration)

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

systemData

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

Nome Tipo Descrição
createdAt

string (date-time)

A marca temporal da criação do recurso (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

A data e 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.