Iot Hub Resource - Create Or Update

Служба:: IoT Hub

Версия API:: 2023-06-30

Создайте или обновите метаданные центра Iot. Обычный шаблон изменения свойства — получить метаданные центра Интернета вещей и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если некоторые свойства отсутствуют в ФОРМАТЕ JSON, обновление Центра Интернета вещей может привести к возврату этих значений по умолчанию, что может привести к неожиданному поведению.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей Центр Интернета вещей.
resourceName	path	True	string	Имя Центра Интернета вещей.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match		string	ETag Центра Интернета вещей. Не указывайте для создания нового Центра Интернета вещей. Требуется обновить существующий Центр Интернета вещей.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение ресурса.
sku	True	IotHubSkuInfo	Сведения об SKU IotHub
etag		string	Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag.
identity		ArmIdentity	Управляемые удостоверения для IotHub.
properties		IotHubProperties	Свойства IotHub
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	IotHubDescription	Это возвращается в качестве ответа на запрос опроса состояния для операции создания или обновления. Текст содержит представление ресурса, указывающее переходное состояние подготовки.
201 Created	IotHubDescription	Выполнение этой операции занимает длительное время. Операция возвращает значение 201, если проверка завершена. Ответ содержит заголовок Azure-AsyncOperation, содержащий URL-адрес состояния. Ожидается, что клиенты будут опрашивать URL-адрес состояния для состояния операции. В случае успешного выполнения операция возвращает код состояния HTTP 201 (ОК).
Other Status Codes	ErrorDetails	DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

IotHubResource_AddCosmosDbEndpoint

IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

Образец запроса

HTTP

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
  }
}

Пример ответа

Код состояния:: 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"
  }
}

Код состояния:: 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

Образец запроса

HTTP

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
  }
}

Пример ответа

Код состояния:: 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"
  }
}

Код состояния:: 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"
  }
}

Определения

Имя	Описание
AccessRights	Разрешения, назначенные политике общего доступа.
ArmIdentity
ArmUserIdentity
AuthenticationType	Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
authenticationType	Метод, используемый для проверки подлинности в конечной точке очереди служебной шины
Capabilities	Возможности и функции, включенные для Центра Интернета вещей.
CloudToDeviceProperties	Свойства обмена сообщениями центра Интернета вещей между устройствами.
createdByType	Тип удостоверения, создавшего ресурс.
DefaultAction	Действие по умолчанию для набора правил сети
EnrichmentProperties	Свойства обогащения, которое центр Интернета вещей применяет к сообщениям, доставленным конечным точкам.
ErrorDetails	Сведения об ошибке.
EventHubProperties	Свойства подготовленной конечной точки, совместимой с Концентратором событий, используемой Центром Интернета вещей.
FallbackRouteProperties	Свойства резервного маршрута. Центр Интернета вещей использует эти свойства при маршрутизации сообщений в резервную конечную точку.
FeedbackProperties	Свойства очереди отзывов для сообщений из облака на устройство.
IotHubDescription	Описание Центра Интернета вещей.
IotHubLocationDescription	Общедоступное представление одного из расположений, в которых подготовлен ресурс.
IotHubProperties	Свойства Центра Интернета вещей.
IotHubReplicaRoleType	Роль региона может быть первичной или вторичной. Основной регион — это место, в котором центр Интернета вещей в настоящее время подготовлен. Дополнительный регион — это парный регион аварийного восстановления Azure, а также регион, в котором центр Интернета вещей может выполнить отработку отказа.
IotHubSku	Имя номера SKU.
IotHubSkuInfo	Сведения о номере SKU центра Интернета вещей.
IotHubSkuTier	Уровень выставления счетов для Центра Интернета вещей.
IpFilterActionType	Требуемое действие для запросов, захваченных этим правилом.
IpFilterRule	Правила фильтрации IP-адресов для Центра Интернета вещей.
ManagedIdentity	Свойства управляемого удостоверения.
MessagingEndpointProperties	Свойства конечных точек обмена сообщениями, используемых этим центром Интернета вещей.
NetworkRuleIPAction	Действие ФИЛЬТРА IP
NetworkRuleSetIpRule	Правило IP для применения в составе набора сетевых правил
NetworkRuleSetProperties	Свойства набора правил сети IotHub
PrivateEndpoint	Свойство частной конечной точки подключения частной конечной точки
PrivateEndpointConnection	Подключение частной конечной точки iotHub
PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки
PrivateLinkServiceConnectionState	Текущее состояние подключения к частной конечной точке
PrivateLinkServiceConnectionStatus	Состояние подключения частной конечной точки
PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
RouteProperties	Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.
RoutingCosmosDBSqlApiProperties	Свойства, связанные с конечной точкой контейнера sql Cosmos DB.
RoutingEndpoints	Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка.
RoutingEventHubProperties	Свойства, связанные с конечной точкой концентратора событий.
RoutingProperties	Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Свойства, связанные с типами конечных точек очереди служебной шины.
RoutingServiceBusTopicEndpointProperties	Свойства, связанные с типами конечных точек раздела служебной шины.
RoutingSource	Источник, к которому применяется правило маршрутизации, например DeviceMessages.
RoutingStorageContainerProperties	Свойства, связанные с конечной точкой контейнера хранилища.
SharedAccessSignatureAuthorizationRule	Свойства политики общего доступа Центра Интернета вещей.
StorageEndpointProperties	Свойства конечной точки службы хранилища Azure для отправки файлов.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AccessRights

Перечисление

Разрешения, назначенные политике общего доступа.

Значение	Описание
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

Object

Имя	Тип	Описание
principalId	string	Идентификатор субъекта
tenantId	string	Идентификатор клиента
type	ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
userAssignedIdentities	<string, ArmUserIdentity>

ArmUserIdentity

Object

Имя	Тип	Описание
clientId	string
principalId	string

AuthenticationType

Перечисление

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

Значение	Описание
keyBased
identityBased

authenticationType

Перечисление

Метод, используемый для проверки подлинности в конечной точке очереди служебной шины

Значение	Описание
keyBased
identityBased

Capabilities

Перечисление

Возможности и функции, включенные для Центра Интернета вещей.

Значение	Описание
None
DeviceManagement

CloudToDeviceProperties

Object

Свойства обмена сообщениями центра Интернета вещей между устройствами.

Имя	Тип	Описание
defaultTtlAsIso8601	string (duration)	Время ожидания по умолчанию для сообщений из облака в очередь устройств. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Свойства очереди отзывов для сообщений из облака на устройство.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Максимальное количество доставки сообщений из облака в очередь устройств. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DefaultAction

Перечисление

Действие по умолчанию для набора правил сети

Значение	Описание
Deny
Allow

EnrichmentProperties

Object

Свойства обогащения, которое центр Интернета вещей применяет к сообщениям, доставленным конечным точкам.

Имя	Тип	Описание
endpointNames	string[]	Список конечных точек, для которых применяется обогащение к сообщению.
key	string	Ключ или имя свойства обогащения.
value	string	Значение свойства обогащения.

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

EventHubProperties

Object

Свойства подготовленной конечной точки, совместимой с Концентратором событий, используемой Центром Интернета вещей.

Имя	Тип	Описание
endpoint	string	Конечная точка, совместимая с Концентратором событий.
partitionCount	integer (int32)	Количество секций для получения сообщений, совместимых с устройством в облаке, в конечной точке, совместимой с Концентратором событий. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Идентификаторы секции в конечной точке, совместимой с Концентратором событий.
path	string	Имя, совместимое с Концентратором событий.
retentionTimeInDays	integer (int64)	Время хранения сообщений в облако в днях. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Object

Свойства резервного маршрута. Центр Интернета вещей использует эти свойства при маршрутизации сообщений в резервную конечную точку.

Имя	Тип	Описание
condition	string	Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, оно будет иметь значение true по умолчанию. Сведения о грамматике см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Список конечных точек, на которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешено только 1 конечная точка.
isEnabled	boolean	Используется для указания включения резервного маршрута.
name	string	Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными.
source	RoutingSource	Источник, к которому применяется правило маршрутизации. Например, DeviceMessages

FeedbackProperties

Object

Свойства очереди отзывов для сообщений из облака на устройство.

Имя	Тип	Описание
lockDurationAsIso8601	string (duration)	Длительность блокировки для очереди отзывов. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Количество попыток доставки сообщения в очередь отзывов в центре Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Object

Описание Центра Интернета вещей.

Имя	Тип	Описание
etag	string	Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag.
id	string	Идентификатор ресурса.
identity	ArmIdentity	Управляемые удостоверения для IotHub.
location	string	Расположение ресурса.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Имя ресурса.
properties	IotHubProperties	Свойства IotHub
sku	IotHubSkuInfo	Сведения об SKU IotHub
systemData	systemData	Системные метаданные, относящиеся к этому ресурсу.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

IotHubLocationDescription

Object

Общедоступное представление одного из расположений, в которых подготовлен ресурс.

Имя	Тип	Описание
location	string	Имя региона Azure
role	IotHubReplicaRoleType	Роль региона может быть первичной или вторичной. Основной регион — это место, в котором центр Интернета вещей в настоящее время подготовлен. Дополнительный регион — это парный регион аварийного восстановления Azure, а также регион, в котором центр Интернета вещей может выполнить отработку отказа.

IotHubProperties

Object

Свойства Центра Интернета вещей.

Имя	Тип	Описание
allowedFqdnList	string[]	Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Iot.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей.
cloudToDevice	CloudToDeviceProperties	Свойства обмена сообщениями центра Интернета вещей между устройствами.
comments	string	Комментарии центра Интернета вещей.
disableDeviceSAS	boolean	Если значение true, все устройства (включая пограничные устройства, кроме модулей), ограниченные ключи SAS нельзя использовать для проверки подлинности.
disableLocalAuth	boolean	Если значение true, маркеры SAS с ключами SAS с областью действия центра Iot нельзя использовать для проверки подлинности.
disableModuleSAS	boolean	Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS с областью действия модуля.
enableDataResidency	boolean	Это свойство, если задано значение true, позволит включить размещение данных, таким образом, отключив аварийное восстановление.
enableFileUploadNotifications	boolean	Если задано значение True, уведомления о отправке файлов включены.
eventHubEndpoints	<string, EventHubProperties>	Свойства конечной точки, совместимой с Концентратором событий. Единственными возможными ключами этого словаря являются события. Этот ключ должен присутствовать в словаре при создании или обновлении вызовов центра Интернета вещей.
features	Capabilities	Возможности и функции, включенные для Центра Интернета вещей.
hostName	string	Имя узла.
ipFilterRules	IpFilterRule[]	Правила фильтрации IP-адресов.
locations	IotHubLocationDescription[]	Основное и дополнительное расположение для центра iot
messagingEndpoints	<string, MessagingEndpointProperties>	Свойства конечной точки обмена сообщениями для очереди уведомлений о отправке файла.
minTlsVersion	string	Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись.
networkRuleSets	NetworkRuleSetProperties	Свойства набора правил сети IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Подключения к частной конечной точке, созданные на этом IotHub
provisioningState	string	Состояние подготовки.
publicNetworkAccess	PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
restrictOutboundNetworkAccess	boolean	Если значение true, исходящие данные из IotHub будут ограничены только разрешенными полными доменными именами, настроенными с помощью allowFqdnList.
routing	RoutingProperties	Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	string	Состояние концентратора.
storageEndpoints	<string, StorageEndpointProperties>	Список конечных точек службы хранилища Azure, где можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure и ее ключ как $default. Указание нескольких учетных записей хранения приводит к возникновению ошибки. Не указывая значение этого свойства, если для свойства enableFileUploadNotifications задано значение True, возникает ошибка.

IotHubReplicaRoleType

Перечисление

Роль региона может быть первичной или вторичной. Основной регион — это место, в котором центр Интернета вещей в настоящее время подготовлен. Дополнительный регион — это парный регион аварийного восстановления Azure, а также регион, в котором центр Интернета вещей может выполнить отработку отказа.

Значение	Описание
primary
secondary

IotHubSku

Перечисление

Имя номера SKU.

Значение	Описание
F1
S1
S2
S3
B1
B2
B3

IotHubSkuInfo

Object

Сведения о номере SKU центра Интернета вещей.

Имя	Тип	Описание
capacity	integer (int64)	Количество подготовленных единиц Центра Интернета вещей. См. https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Имя номера SKU.
tier	IotHubSkuTier	Уровень выставления счетов для Центра Интернета вещей.

IotHubSkuTier

Перечисление

Уровень выставления счетов для Центра Интернета вещей.

Значение	Описание
Free
Standard
Basic

IpFilterActionType

Перечисление

Требуемое действие для запросов, захваченных этим правилом.

Значение	Описание
Accept
Reject

IpFilterRule

Object

Правила фильтрации IP-адресов для Центра Интернета вещей.

Имя	Тип	Описание
action	IpFilterActionType	Требуемое действие для запросов, захваченных этим правилом.
filterName	string	Имя правила фильтрации IP-адресов.
ipMask	string	Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.

ManagedIdentity

Object

Свойства управляемого удостоверения.

Имя	Тип	Описание
userAssignedIdentity	string	Назначаемое пользователем удостоверение.

MessagingEndpointProperties

Object

Свойства конечных точек обмена сообщениями, используемых этим центром Интернета вещей.

Имя	Тип	Описание
lockDurationAsIso8601	string (duration)	Длительность блокировки. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Количество попыток доставки сообщения в Центре Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Перечисление

Действие ФИЛЬТРА IP

Значение	Описание
Allow

NetworkRuleSetIpRule

Object

Правило IP для применения в составе набора сетевых правил

Имя	Тип	Default value	Описание
action	NetworkRuleIPAction	Allow	Действие ФИЛЬТРА IP
filterName	string		Имя правила фильтрации IP-адресов.
ipMask	string		Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.

NetworkRuleSetProperties

Object

Свойства набора правил сети IotHub

Имя	Тип	Default value	Описание
applyToBuiltInEventHubEndpoint	boolean		Если значение true, то набор правил сети также применяется к Встроенной точке событий EventHub iotHub
defaultAction	DefaultAction	Deny	Действие по умолчанию для набора правил сети
ipRules	NetworkRuleSetIpRule[]		Список правил IP-адресов

PrivateEndpoint

Object

Свойство частной конечной точки подключения частной конечной точки

Имя	Тип	Описание
id	string	Идентификатор ресурса.

PrivateEndpointConnection

Object

Подключение частной конечной точки iotHub

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties	PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки
type	string	Тип ресурса.

PrivateEndpointConnectionProperties

Object

Свойства подключения частной конечной точки

Имя	Тип	Описание
privateEndpoint	PrivateEndpoint	Свойство частной конечной точки подключения частной конечной точки
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Текущее состояние подключения к частной конечной точке

PrivateLinkServiceConnectionState

Object

Текущее состояние подключения к частной конечной точке

Имя	Тип	Описание
actionsRequired	string	Действия, необходимые для подключения частной конечной точки
description	string	Описание текущего состояния подключения частной конечной точки
status	PrivateLinkServiceConnectionStatus	Состояние подключения частной конечной точки

PrivateLinkServiceConnectionStatus

Перечисление

Состояние подключения частной конечной точки

Значение	Описание
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Перечисление

Разрешены ли запросы из общедоступной сети

Значение	Описание
Enabled
Disabled

ResourceIdentityType

Перечисление

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.

Значение	Описание
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

RouteProperties

Object

Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.

Имя	Тип	Описание
condition	string	Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию оценивается как true. Сведения о грамматике см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка.
isEnabled	boolean	Используется для указания включения маршрута.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными.
source	RoutingSource	Источник, к которому применяется правило маршрутизации, например DeviceMessages.

RoutingCosmosDBSqlApiProperties

Object

Свойства, связанные с конечной точкой контейнера sql Cosmos DB.

Имя	Тип	Описание
authenticationType	authenticationType	Метод, используемый для проверки подлинности в конечной точке контейнера sql Cosmos DB
containerName	string	Имя контейнера sql cosmos DB в базе данных Cosmos DB.
databaseName	string	Имя базы данных Cosmos DB в учетной записи Cosmos DB.
endpointUri	string (uri)	URL-адрес учетной записи Cosmos DB. Он должен включать протокол https://
id	string	Идентификатор конечной точки контейнера sql Cosmos DB
identity	ManagedIdentity	Свойства управляемого удостоверения для конечной точки контейнера Cosmos DB.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек.
partitionKeyName	string	Имя ключа секции, связанного с этим контейнером SQL Cosmos DB, если он существует. Этот параметр является необязательным.
partitionKeyTemplate	string	Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан по крайней мере один раз, но порядок и компоненты, не являющиеся заполнителями, являются произвольными. Этот параметр требуется только в том случае, если задано имя PartitionKeyName.
primaryKey	string	Первичный ключ учетной записи Cosmos DB.
resourceGroup	string	Имя группы ресурсов учетной записи Cosmos DB.
secondaryKey	string	Вторичный ключ учетной записи Cosmos DB.
subscriptionId	string	Идентификатор подписки учетной записи Cosmos DB.

RoutingEndpoints

Object

Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка.

Имя	Тип	Описание
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Список конечных точек контейнера Cosmos DB, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации.
eventHubs	RoutingEventHubProperties[]	Список конечных точек Центров событий, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. Этот список не включает встроенную конечную точку Центров событий.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Список конечных точек очереди служебной шины, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Список конечных точек раздела служебной шины, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации.
storageContainers	RoutingStorageContainerProperties[]	Список конечных точек контейнера хранилища, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации.

RoutingEventHubProperties

Object

Свойства, связанные с конечной точкой концентратора событий.

Имя	Тип	Описание
authenticationType	authenticationType	Метод, используемый для проверки подлинности в конечной точке концентратора событий
connectionString	string	Строка подключения конечной точки концентратора событий.
endpointUri	string	URL-адрес конечной точки концентратора событий. Он должен включать протокол sb://
entityPath	string	Имя концентратора событий в пространстве имен концентратора событий
id	string	Идентификатор конечной точки концентратора событий
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек.
resourceGroup	string	Имя группы ресурсов конечной точки концентратора событий.
subscriptionId	string	Идентификатор подписки конечной точки концентратора событий.

RoutingProperties

Object

Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Имя	Тип	Описание
endpoints	RoutingEndpoints	Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка.
enrichments	EnrichmentProperties[]	Список предоставленных пользователем обогащений, которые центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См. статью: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Свойства маршрута, который используется в качестве резервного маршрута, если ни одно из условий, указанных в разделе "маршруты", не выполняется. Этот параметр является необязательным. Если это свойство отсутствует в шаблоне, резервный маршрут отключен по умолчанию.
routes	RouteProperties[]	Список правил маршрутизации, предоставляемых пользователем, которые центр Интернета вещей использует для маршрутизации сообщений в встроенные и пользовательские конечные точки. Для платных центров разрешено не более 100 правил маршрутизации, а для бесплатных центров разрешено не более 5 правил маршрутизации.

RoutingServiceBusQueueEndpointProperties

Object

Свойства, связанные с типами конечных точек очереди служебной шины.

Имя	Тип	Описание
authenticationType	authenticationType	Метод, используемый для проверки подлинности в конечной точке очереди служебной шины
connectionString	string	Строка подключения конечной точки очереди служебной шины.
endpointUri	string	URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb://
entityPath	string	Имя очереди в пространстве имен служебной шины
id	string	Идентификатор конечной точки очереди служебной шины
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем очереди.
resourceGroup	string	Имя группы ресурсов конечной точки очереди служебной шины.
subscriptionId	string	Идентификатор подписки конечной точки очереди служебной шины.

RoutingServiceBusTopicEndpointProperties

Object

Свойства, связанные с типами конечных точек раздела служебной шины.

Имя	Тип	Описание
authenticationType	authenticationType	Метод, используемый для проверки подлинности в конечной точке раздела служебной шины
connectionString	string	Строка подключения конечной точки раздела служебной шины.
endpointUri	string	URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb://
entityPath	string	Имя очереди в разделе служебной шины
id	string	Идентификатор конечной точки раздела служебной шины
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем раздела.
resourceGroup	string	Имя группы ресурсов конечной точки раздела служебной шины.
subscriptionId	string	Идентификатор подписки конечной точки раздела служебной шины.

RoutingSource

Перечисление

Источник, к которому применяется правило маршрутизации, например DeviceMessages.

Значение	Описание
Invalid
DeviceMessages
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DeviceConnectionStateEvents

RoutingStorageContainerProperties

Object

Свойства, связанные с конечной точкой контейнера хранилища.

Имя	Тип	Описание
authenticationType	authenticationType	Метод, используемый для проверки подлинности в конечной точке хранилища
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Интервал времени записи больших двоичных объектов в хранилище. Значение должно составлять от 60 до 720 секунд. Значение по умолчанию — 300 секунд.
connectionString	string	Строка подключения учетной записи хранения.
containerName	string	Имя контейнера хранилища в учетной записи хранения.
encoding	enum: Avro AvroDeflate JSON	Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro.
endpointUri	string	URL-адрес конечной точки хранилища. Он должен включать протокол https://
fileNameFormat	string	Формат имени файла для большого двоичного объекта. Формат по умолчанию — {iothub}/{partition}/{ГГГГ}/{MM}/{DD}/{HH}/{mm}. Все параметры являются обязательными, но могут быть переупорядочены.
id	string	Идентификатор конечной точки контейнера хранилища
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки хранилища маршрутизации.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Максимальное количество байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно быть между 10485760(10 МБ) и 524288000(500 МБ). Значение по умолчанию — 314572800(300 МБ).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек.
resourceGroup	string	Имя группы ресурсов учетной записи хранения.
subscriptionId	string	Идентификатор подписки учетной записи хранения.

SharedAccessSignatureAuthorizationRule

Object

Свойства политики общего доступа Центра Интернета вещей.

Имя	Тип	Описание
keyName	string	Имя политики общего доступа.
primaryKey	string	Первичный ключ.
rights	AccessRights	Разрешения, назначенные политике общего доступа.
secondaryKey	string	Вторичный ключ.

StorageEndpointProperties

Object

Свойства конечной точки службы хранилища Azure для отправки файлов.

Имя	Тип	Описание
authenticationType	AuthenticationType	Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
connectionString	string	Строка подключения для учетной записи хранения Azure, в которую отправляются файлы.
containerName	string	Имя корневого контейнера, в котором вы отправляете файлы. Контейнер не должен существовать, но должен быть настраиваемым с помощью указанного connectionString.
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки хранилища для отправки файлов.
sasTtlAsIso8601	string (duration)	Период времени, для которого допустимы URI SAS, созданный Центром Интернета вещей для отправки файлов. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Iot Hub Resource - Create Or Update

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

IotHubResource_AddCosmosDbEndpoint

Образец запроса

Пример ответа

IotHubResource_CreateOrUpdate

Образец запроса

Пример ответа

Определения

AccessRights

ArmIdentity

ArmUserIdentity

AuthenticationType

authenticationType

Capabilities

CloudToDeviceProperties

createdByType

DefaultAction

EnrichmentProperties

ErrorDetails

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubDescription

IotHubLocationDescription

IotHubProperties

IotHubReplicaRoleType

IotHubSku

IotHubSkuInfo

IotHubSkuTier

IpFilterActionType

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

NetworkRuleIPAction

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

PublicNetworkAccess

ResourceIdentityType

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingSource

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

systemData