Compartilhar via

Iot Hub Resource - Create Or Update

Serviço:
IoT Hub
Versão da API:
2023-06-30

Crie ou atualize os metadados de um hub Iot. O padrão usual para modificar uma propriedade é recuperar os metadados e metadados de segurança do Hub IoT e combiná-los com os valores modificados em um novo corpo para atualizar o hub IoT. Se determinadas propriedades estiverem ausentes no JSON, a atualização do Hub IoT poderá fazer com que esses valores retornem ao padrão, o que pode levar a um comportamento inesperado.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o hub IoT.
resourceName
 path True

string

O nome do hub IoT.
subscriptionId
 path True

string

O identificador da assinatura.
api-version
 query True

string

A versão da API.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
If-Match

string

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

Corpo da solicitação

Nome Obrigatório Tipo Description
___location True

string

O local do recurso.
sku True

IotHubSkuInfo

Informações de SKU do IotHub
etag

string

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

ArmIdentity

As identidades gerenciadas do IotHub.
properties

IotHubProperties

Propriedades do IotHub
tags

object

As marcas de recurso.

Respostas

Nome Tipo Description
200 OK

IotHubDescription

Isso é retornado como uma resposta à solicitação de sondagem de status para a operação de criação ou atualização. O corpo contém a representação de recurso que indica um estado de provisionamento transitório.
201 Created

IotHubDescription

Esta é uma operação de execução longa. A operação retornará um 201 se a validação for concluída. A resposta inclui um cabeçalho Azure-AsyncOperation que contém uma URL de status. Espera-se que os clientes pesquisem a URL de status para o status da operação. Se bem-sucedida, a operação retornará o código de status HTTP de 201 (OK).
Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

IotHubResource_AddCosmosDbEndpoint
IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

Solicitação de exemplo

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

{
  "___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": [],
        "cosmosDBSqlContainers": [
          {
            "primaryKey": "<primary-key>",
            "secondaryKey": "<secondary-key>",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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",
    "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": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
Código de status:
201 
{
  "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",
    "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": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

IotHubResource_CreateOrUpdate

Solicitação de exemplo

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

{
  "___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": [],
      "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": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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",
    "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
Código de status:
201 
{
  "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",
    "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definições

Nome Description
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.
authenticationType

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

Os recursos e 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
EnrichmentProperties

As propriedades de um enriquecimento que o 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.
FallbackRouteProperties

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

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

A descrição do hub IoT.
IotHubLocationDescription

Representação pública de um dos locais em que um recurso é provisionado.
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á provisionado no momento. A região secundária é a região emparelhada com DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover.
IotHubSku

O nome da SKU.
IotHubSkuInfo

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

A camada de cobrança para o hub IoT.
IpFilterActionType

A ação desejada para solicitações capturadas por essa 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 este hub IoT.
NetworkRuleIPAction

Ação filtro IP
NetworkRuleSetIpRule

Regra DE 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 privado
PrivateEndpointConnection

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

As propriedades de uma conexão de ponto de extremidade privado
PrivateLinkServiceConnectionState

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

O status de uma conexão de ponto de extremidade privado
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 'None' removerá as identidades do serviço.
RouteProperties

As propriedades de uma regra de roteamento que o 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 o hub IoT roteia mensagens com base nas regras de roteamento. Um máximo de 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.
RoutingEventHubProperties

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

As propriedades relacionadas ao roteamento do hub IoT. Confira: 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 do 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.
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 upload de arquivo.
systemData

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

AccessRights

Enumeração

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

Valor Description
RegistryRead
RegistryWrite
ServiceConnect
DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, ServiceConnect
RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ArmIdentity

Objeto
Nome Tipo Description
principalId

string

ID da entidade de segurança
tenantId

string

ID do locatário
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 'None' removerá as identidades do serviço.
userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Objeto
Nome Tipo Description
clientId

string

principalId

string

AuthenticationType

Enumeração

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

Valor Description
keyBased
identityBased

authenticationType

Enumeração

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

Valor Description
keyBased
identityBased

Capabilities

Enumeração

Os recursos e recursos habilitados para o Hub IoT.

Valor Description
None
DeviceManagement

CloudToDeviceProperties

Objeto

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

Nome Tipo Description
defaultTtlAsIso8601

string (duration)

O tempo padrão para viver para mensagens de nuvem para 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 de nuvem para dispositivo.
maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

DefaultAction

Enumeração

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

Valor Description
Deny
Allow

EnrichmentProperties

Objeto

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

Nome Tipo Description
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

Objeto

Detalhes do erro.

Nome Tipo Description
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

Objeto

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

Nome Tipo Description
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 do dispositivo para a nuvem no ponto de extremidade compatível com o Hub de Eventos. Veja: 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 para mensagens do dispositivo para a nuvem em dias. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Objeto

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

Nome Tipo Description
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 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 atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é 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, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo.
source

RoutingSource

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

FeedbackProperties

Objeto

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

Nome Tipo Description
lockDurationAsIso8601

string (duration)

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 (int32)

minimum: 1
maximum: 100

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 (duration)

O período 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

Objeto

A descrição do hub IoT.

Nome Tipo Description
etag

string

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

string

O identificador de recurso.
identity

ArmIdentity

As identidades gerenciadas do IotHub.
___location

string

O local do recurso.
name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

O nome do recurso.
properties

IotHubProperties

Propriedades do IotHub
sku

IotHubSkuInfo

Informações de SKU do IotHub
systemData

systemData

Os metadados do sistema relacionados a esse recurso.
tags

object

As marcas de recurso.
type

string

O tipo de recurso.

IotHubLocationDescription

Objeto

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

Nome 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á provisionado no momento. A região secundária é a região emparelhada com DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover.

IotHubProperties

Objeto

As propriedades de um hub IoT.

Nome Tipo Description
allowedFqdnList

string[]

Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot.
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.
disableDeviceSAS

boolean

Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação.
disableLocalAuth

boolean

Se for true, tokens SAS com chaves SAS com escopo de hub Iot não poderão ser usados para autenticação.
disableModuleSAS

boolean

Se for true, todas as chaves SAS com escopo de módulo não poderão ser usadas para autenticação.
enableDataResidency

boolean

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

boolean

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

<string,  EventHubProperties>

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

Capabilities

Os recursos e recursos habilitados para o Hub IoT.
hostName

string

O nome do host.
ipFilterRules

IpFilterRule[]

As regras de filtro IP.
locations

IotHubLocationDescription[]

Local primário e secundário para o hub iot
messagingEndpoints

<string,  MessagingEndpointProperties>

As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload 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 da 1.2 sejam rejeitados.
networkRuleSets

NetworkRuleSetProperties

Propriedades do conjunto de regras de rede do IotHub
privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado 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 for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList.
routing

RoutingProperties

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

string

O estado do hub.
storageEndpoints

<string,  StorageEndpointProperties>

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

IotHubReplicaRoleType

Enumeração

A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está provisionado no momento. A região secundária é a região emparelhada com DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover.

Valor Description
primary
secondary

IotHubSku

Enumeração

O nome da SKU.

Valor Description
F1
S1
S2
S3
B1
B2
B3

IotHubSkuInfo

Objeto

Informações sobre a SKU do hub IoT.

Nome Tipo Description
capacity

integer (int64)

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

IotHubSku

O nome da SKU.
tier

IotHubSkuTier

A camada de cobrança para o hub IoT.

IotHubSkuTier

Enumeração

A camada de cobrança para o hub IoT.

Valor Description
Free
Standard
Basic

IpFilterActionType

Enumeração

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

Valor Description
Accept
Reject

IpFilterRule

Objeto

As regras de filtro IP para o hub IoT.

Nome Tipo Description
action

IpFilterActionType

A ação desejada para solicitações capturadas por essa 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

Objeto

As propriedades da identidade gerenciada.

Nome Tipo Description
userAssignedIdentity

string

A identidade atribuída pelo usuário.

MessagingEndpointProperties

Objeto

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

Nome Tipo Description
lockDurationAsIso8601

string (duration)

A duração do bloqueio. Veja: 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. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601

string (duration)

O período 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

Enumeração

Ação filtro IP

Valor Description
Allow

NetworkRuleSetIpRule

Objeto

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

Nome Tipo Valor padrão Description
action

NetworkRuleIPAction

Allow

Ação 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

Objeto

Propriedades do conjunto de regras de rede do IotHub

Nome Tipo Valor padrão Description
applyToBuiltInEventHubEndpoint

boolean

Se true, o conjunto de regras de rede também será aplicado ao Ponto de Extremidade do EventHub builtin do IotHub
defaultAction

DefaultAction

Deny

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

NetworkRuleSetIpRule[]

Lista de regras de IP

PrivateEndpoint

Objeto

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

Nome Tipo Description
id

string

O identificador de recurso.

PrivateEndpointConnection

Objeto

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

Nome Tipo Description
id

string

O identificador de recurso.
name

string

O nome do recurso.
properties

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado
type

string

O tipo de recurso.

PrivateEndpointConnectionProperties

Objeto

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

Nome Tipo Description
privateEndpoint

PrivateEndpoint

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionState

Objeto

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

Nome Tipo Description
actionsRequired

string

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

string

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

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

Enumeração

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

Valor Description
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Enumeração

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

Valor Description
Enabled
Disabled

ResourceIdentityType

Enumeração

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 'None' removerá as identidades do serviço.

Valor Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

RouteProperties

Objeto

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

Nome Tipo Description
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 atendem à condição são roteadas. 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, períodos, sublinhados, hifens, 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

Objeto

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

Nome Tipo Description
authenticationType

authenticationType

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

string

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

string

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

string (uri)

A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://
id

string

ID do ponto de extremidade de contêiner sql do Cosmos DB
identity

ManagedIdentity

Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB 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, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.
partitionKeyName

string

O nome da chave de partição associada a esse contêiner sql do Cosmos DB se existir. Esse é um parâmetro opcional.
partitionKeyTemplate

string

O modelo para gerar um valor de chave de partição sintética para uso com esse 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 componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será 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 do Cosmos DB.
secondaryKey

string

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

string

O identificador de assinatura da conta do Cosmos DB.

RoutingEndpoints

Objeto

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

Nome Tipo Description
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 dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos.
serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

A lista de pontos de extremidade de fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.
serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento.
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

Objeto

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

Nome Tipo Description
authenticationType

authenticationType

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

string

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. Ele 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 gerenciada 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, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.
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.

RoutingProperties

Objeto

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

Nome Tipo Description
endpoints

RoutingEndpoints

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

EnrichmentProperties[]

A lista de enriquecimentos fornecidos pelo usuário que o Hub IoT aplica às mensagens a serem entregues a pontos de extremidade internos e personalizados. Confira: 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. Esse é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão.
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

Objeto

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

Nome Tipo Description
authenticationType

authenticationType

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

string

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. Ele 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 gerenciada 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, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome da fila real.
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

Objeto

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

Nome Tipo Description
authenticationType

authenticationType

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

string

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. Ele 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 gerenciada 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, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico.
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

Enumeração

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

Valor Description
Invalid
DeviceMessages
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DeviceConnectionStateEvents

RoutingStorageContainerProperties

Objeto

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

Nome Tipo Description
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

A cadeia de conexão da conta de armazenamento.
containerName

string

O nome do contêiner de armazenamento na conta de armazenamento.
encoding enum:
  • Avro
  • AvroDeflate
  • JSON

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

string

A URL do ponto de extremidade de armazenamento. Ele deve incluir o protocolo https://
fileNameFormat

string

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

string

ID do ponto de extremidade do contêiner de armazenamento
identity

ManagedIdentity

Propriedades de identidade gerenciada 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(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB).
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, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications, $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade.
resourceGroup

string

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

string

O identificador de assinatura da conta de armazenamento.

SharedAccessSignatureAuthorizationRule

Objeto

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

Nome Tipo Description
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

Objeto

As propriedades do ponto de extremidade do Armazenamento do Azure para upload de arquivo.

Nome Tipo Description
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 da conta de Armazenamento do Azure para a qual os arquivos são carregados.
containerName

string

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

ManagedIdentity

Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para upload de arquivo.
sasTtlAsIso8601

string (duration)

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

systemData

Objeto

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

Nome Tipo Description
createdAt

string (date-time)

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 (date-time)

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.