Iot Hub Resource - Update
Обновление существующих тегов Центров Интернета вещей.
Обновление существующих тегов Центр Интернета вещей. Для обновления других полей используйте метод CreateOrUpdate
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Идентификатор группы ресурсов. |
resource
|
path | True |
string |
Имя обновляемого центра Интернета вещей. |
subscription
|
path | True |
string |
Идентификатор подписки. |
api-version
|
query | True |
string |
Версия API. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
tags |
object |
Теги ресурсов |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Центр Интернета вещей успешно обновлен |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
IotHubResource_Update
Образец запроса
Пример ответа
{
"id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {
"foo": "bar"
},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"name": "$fallback",
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
Определения
Имя | Описание |
---|---|
Access |
Разрешения, назначенные политике общего доступа. |
Arm |
|
Arm |
|
Authentication |
Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения. |
authentication |
Метод, используемый для проверки подлинности в конечной точке очереди служебной шины |
Capabilities |
Возможности и функции, включенные в Центр Интернета вещей. |
Cloud |
Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей. |
created |
Тип удостоверения, создавшего ресурс. |
Default |
Действие по умолчанию для набора правил сети |
Enrichment |
Свойства обогащения, которые центр Интернета вещей применяет к сообщениям, доставленным в конечные точки. |
Event |
Свойства подготовленной конечной точки, совместимой с концентратором событий, используемой Центром Интернета вещей. |
Fallback |
Свойства резервного маршрута. Центр Интернета вещей использует эти свойства при маршрутизации сообщений в резервную конечную точку. |
Feedback |
Свойства очереди обратной связи для сообщений из облака на устройство. |
Iot |
Описание Центра Интернета вещей. |
Iot |
Общедоступное представление одного из расположений, где подготовлен ресурс. |
Iot |
Свойства Центра Интернета вещей. |
Iot |
Роль региона может быть первичной или вторичной. Основной регион — это регион, в котором сейчас подготавливается Центр Интернета вещей. Дополнительный регион — это связанный регион аварийного восстановления Azure, а также регион, в который может выполняться отработка отказа Центра Интернета вещей. |
Iot |
Имя номера SKU. |
Iot |
Сведения о номере SKU Центра Интернета вещей. |
Iot |
Уровень выставления счетов для Центра Интернета вещей. |
Ip |
Требуемое действие для запросов, зафиксированных этим правилом. |
Ip |
Правила фильтрации IP-адресов для Центра Интернета вещей. |
Managed |
Свойства управляемого удостоверения. |
Messaging |
Свойства конечных точек обмена сообщениями, используемых этим Центром Интернета вещей. |
Network |
Действие фильтра IP-адресов |
Network |
Правило IP, применяемое в наборе сетевых правил |
Network |
Свойства набора правил сети в IotHub |
Private |
Свойство частной конечной точки подключения к частной конечной точке |
Private |
Подключение к частной конечной точке центра Интернета вещей |
Private |
Свойства подключения к частной конечной точке |
Private |
Текущее состояние подключения к частной конечной точке |
Private |
Состояние подключения к частной конечной точке |
Public |
Разрешены ли запросы из общедоступной сети |
Resource |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. |
Route |
Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки. |
Routing |
Свойства, связанные с конечной точкой контейнера SQL cosmos DB. |
Routing |
Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек во всех типах конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка. |
Routing |
Свойства, связанные с конечной точкой концентратора событий. |
Routing |
Свойства, связанные с маршрутизацией Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Свойства, связанные с типами конечных точек очереди служебной шины. |
Routing |
Свойства, связанные с типами конечных точек раздела служебной шины. |
Routing |
Источник, к которому будет применяться правило маршрутизации, например DeviceMessages. |
Routing |
Свойства, связанные с конечной точкой контейнера хранилища. |
Shared |
Свойства политики общего доступа к Центру Интернета вещей. |
Storage |
Свойства конечной точки службы хранилища Azure для отправки файлов. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
Tags |
Контейнер, содержащий только теги для ресурса, что позволяет пользователю обновлять теги в экземпляре Центр Интернета вещей. |
AccessRights
Разрешения, назначенные политике общего доступа.
Имя | Тип | Описание |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ArmIdentity
Имя | Тип | Описание |
---|---|---|
principalId |
string |
Идентификатор субъекта |
tenantId |
string |
Идентификатор клиента |
type |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Имя | Тип | Описание |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
Имя | Тип | Описание |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Метод, используемый для проверки подлинности в конечной точке очереди служебной шины
Имя | Тип | Описание |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Возможности и функции, включенные в Центр Интернета вещей.
Имя | Тип | Описание |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей.
Имя | Тип | Описание |
---|---|---|
defaultTtlAsIso8601 |
string |
Время жизни по умолчанию для сообщений из облака на устройство в очереди устройств. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
Свойства очереди обратной связи для сообщений из облака на устройство. |
|
maxDeliveryCount |
integer |
Максимальное число доставки сообщений из облака на устройство в очереди устройств. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Действие по умолчанию для набора правил сети
Имя | Тип | Описание |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Свойства обогащения, которые центр Интернета вещей применяет к сообщениям, доставленным в конечные точки.
Имя | Тип | Описание |
---|---|---|
endpointNames |
string[] |
Список конечных точек, для которых обогащение применяется к сообщению. |
key |
string |
Ключ или имя свойства обогащения. |
value |
string |
Значение свойства обогащения. |
EventHubProperties
Свойства подготовленной конечной точки, совместимой с концентратором событий, используемой Центром Интернета вещей.
Имя | Тип | Описание |
---|---|---|
endpoint |
string |
Конечная точка, совместимая с концентратором событий. |
partitionCount |
integer |
Количество секций для получения сообщений с устройства в облако в конечной точке, совместимой с Концентратором событий. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
Идентификаторы секций в конечной точке, совместимой с концентратором событий. |
path |
string |
Имя, совместимое с концентратором событий. |
retentionTimeInDays |
integer |
Время хранения сообщений с устройства в облако в днях. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
Свойства резервного маршрута. Центр Интернета вещей использует эти свойства при маршрутизации сообщений в резервную конечную точку.
Имя | Тип | Описание |
---|---|---|
condition |
string |
Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, по умолчанию будет установлено значение true. Сведения о грамматике см. в разделе: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только 1 конечная точка. |
isEnabled |
boolean |
Используется для указания того, включен ли резервный маршрут. |
name |
string |
Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальная длина — 64 символа и должно быть уникальным. |
source |
Источник, к которому будет применяться правило маршрутизации. Например, DeviceMessages |
FeedbackProperties
Свойства очереди обратной связи для сообщений из облака на устройство.
Имя | Тип | Описание |
---|---|---|
lockDurationAsIso8601 |
string |
Длительность блокировки для очереди обратной связи. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Количество попыток Центра Интернета вещей доставить сообщение в очередь отзывов. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Описание Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в виде заголовка в соответствии с обычным соглашением ETag. |
id |
string |
Идентификатор ресурса. |
identity |
Управляемые удостоверения для Центра интернета вещей. |
|
location |
string |
Местоположение ресурса. |
name |
string |
Имя ресурса. |
properties |
Свойства IotHub |
|
sku |
Сведения о номере SKU IotHub |
|
systemData |
Системные метаданные, относящиеся к этому ресурсу. |
|
tags |
object |
Теги ресурса. |
type |
string |
Тип ресурса. |
IotHubLocationDescription
Общедоступное представление одного из расположений, где подготовлен ресурс.
Имя | Тип | Описание |
---|---|---|
location |
string |
Имя региона Azure |
role |
Роль региона может быть первичной или вторичной. Основной регион — это регион, в котором сейчас подготавливается Центр Интернета вещей. Дополнительный регион — это связанный регион аварийного восстановления Azure, а также регион, в который может выполняться отработка отказа Центра Интернета вещей. |
IotHubProperties
Свойства Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
allowedFqdnList |
string[] |
Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Интернета вещей. |
authorizationPolicies |
Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. |
|
cloudToDevice |
Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей. |
|
comments |
string |
Комментарии к Центру Интернета вещей. |
disableDeviceSAS |
boolean |
Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS с областью действия устройства (включая пограничные устройства, за исключением модулей). |
disableLocalAuth |
boolean |
Если значение равно true, маркеры SAS с ключами SAS в области центра Интернета вещей нельзя использовать для проверки подлинности. |
disableModuleSAS |
boolean |
Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS уровня модуля. |
enableDataResidency |
boolean |
Если для этого свойства задано значение true, будет включена возможность размещения данных, что отключит аварийное восстановление. |
enableFileUploadNotifications |
boolean |
Если задано значение True, уведомления о отправке файлов включены. |
eventHubEndpoints |
<string,
Event |
Свойства конечной точки, совместимой с концентратором событий. Единственным возможным ключом к этому словарю являются события. Этот ключ должен присутствовать в словаре при выполнении вызовов создания или обновления для Центра Интернета вещей. |
features |
Возможности и функции, включенные в Центр Интернета вещей. |
|
hostName |
string |
Имя узла. |
ipFilterRules |
Правила фильтрации IP-адресов. |
|
locations |
Основное и дополнительное расположение для центра Интернета вещей |
|
messagingEndpoints |
<string,
Messaging |
Свойства конечной точки обмена сообщениями для очереди уведомлений об отправке файлов. |
minTlsVersion |
string |
Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. |
networkRuleSets |
Свойства набора правил сети в IotHub |
|
privateEndpointConnections |
Подключения к частной конечной точке, созданные на этом сайте Интернета вещей |
|
provisioningState |
string |
Состояние подготовки. |
publicNetworkAccess |
Разрешены ли запросы из общедоступной сети |
|
restrictOutboundNetworkAccess |
boolean |
Если значение равно true, исходящий трафик из IotHub будет ограничен только разрешенными полными доменными именами, настроенными с помощью allowedFqdnList. |
routing |
Свойства, связанные с маршрутизацией Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Состояние концентратора. |
storageEndpoints |
<string,
Storage |
Список конечных точек службы хранилища Azure, куда можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure, которая должна иметь свой ключ в качестве $default. Если указать несколько учетных записей хранения, возникает ошибка. Если для свойства enableFileUploadNotifications не задано значение True, возникает ошибка. |
IotHubReplicaRoleType
Роль региона может быть первичной или вторичной. Основной регион — это регион, в котором сейчас подготавливается Центр Интернета вещей. Дополнительный регион — это связанный регион аварийного восстановления Azure, а также регион, в который может выполняться отработка отказа Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
Имя номера SKU.
Имя | Тип | Описание |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Сведения о номере SKU Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
capacity |
integer |
Количество подготовленных Центр Интернета вещей единиц. См. https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
Имя номера SKU. |
|
tier |
Уровень выставления счетов для Центра Интернета вещей. |
IotHubSkuTier
Уровень выставления счетов для Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
Требуемое действие для запросов, зафиксированных этим правилом.
Имя | Тип | Описание |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Правила фильтрации IP-адресов для Центра Интернета вещей.
Имя | Тип | Описание |
---|---|---|
action |
Требуемое действие для запросов, отслеживаемых этим правилом. |
|
filterName |
string |
Имя правила фильтрации IP-адресов. |
ipMask |
string |
Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. |
ManagedIdentity
Свойства управляемого удостоверения.
Имя | Тип | Описание |
---|---|---|
userAssignedIdentity |
string |
Удостоверение, назначаемое пользователем. |
MessagingEndpointProperties
Свойства конечных точек обмена сообщениями, используемых этим Центром Интернета вещей.
Имя | Тип | Описание |
---|---|---|
lockDurationAsIso8601 |
string |
Длительность блокировки. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Количество попыток центра Интернета вещей доставить сообщение. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Действие фильтра IP-адресов
Имя | Тип | Описание |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Правило IP, применяемое в наборе сетевых правил
Имя | Тип | Default value | Описание |
---|---|---|---|
action | Allow |
Действие фильтра IP-адресов |
|
filterName |
string |
Имя правила фильтрации IP-адресов. |
|
ipMask |
string |
Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. |
NetworkRuleSetProperties
Свойства набора правил сети в IotHub
Имя | Тип | Default value | Описание |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Если задано значение True, набор правил сети также применяется к BuiltIn EventHub EndPoint iotHub. |
|
defaultAction | Deny |
Действие по умолчанию для набора сетевых правил |
|
ipRules |
Список правил IP-адресов |
PrivateEndpoint
Свойство частной конечной точки подключения к частной конечной точке
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
PrivateEndpointConnection
Подключение к частной конечной точке центра Интернета вещей
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
name |
string |
Имя ресурса. |
properties |
Свойства подключения к частной конечной точке |
|
type |
string |
Тип ресурса. |
PrivateEndpointConnectionProperties
Свойства подключения к частной конечной точке
Имя | Тип | Описание |
---|---|---|
privateEndpoint |
Свойство частной конечной точки подключения к частной конечной точке |
|
privateLinkServiceConnectionState |
Текущее состояние подключения к частной конечной точке |
PrivateLinkServiceConnectionState
Текущее состояние подключения к частной конечной точке
Имя | Тип | Описание |
---|---|---|
actionsRequired |
string |
Действия, необходимые для подключения к частной конечной точке |
description |
string |
Описание текущего состояния подключения к частной конечной точке |
status |
Состояние подключения к частной конечной точке |
PrivateLinkServiceConnectionStatus
Состояние подключения к частной конечной точке
Имя | Тип | Описание |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Разрешены ли запросы из общедоступной сети
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы.
Имя | Тип | Описание |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.
Имя | Тип | Описание |
---|---|---|
condition |
string |
Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию возвращает значение true. Сведения о грамматике см. в разделе: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. |
isEnabled |
boolean |
Используется для указания, включен ли маршрут. |
name |
string |
Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальная длина — 64 символа и должно быть уникальным. |
source |
Источник, к которому должно применяться правило маршрутизации, например DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Свойства, связанные с конечной точкой контейнера SQL cosmos DB.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Метод, используемый для проверки подлинности в конечной точке контейнера SQL cosmos DB |
|
containerName |
string |
Имя контейнера sql cosmos DB в базе данных cosmos DB. |
databaseName |
string |
Имя базы данных cosmos DB в учетной записи cosmos DB. |
endpointUri |
string |
URL-адрес учетной записи cosmos DB. Он должен включать протокол https:// |
id |
string |
Идентификатор конечной точки контейнера SQL cosmos DB |
identity |
Свойства управляемого удостоверения конечной точки контейнера cosmos DB маршрутизации. |
|
name |
string |
Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. |
partitionKeyName |
string |
Имя ключа секции, связанного с этим контейнером sql cosmos DB, если он существует. Этот параметр является необязательным. |
partitionKeyTemplate |
string |
Шаблон для создания значения искусственного ключа секции для использования с этим контейнером sql Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан не более одного раза, но компоненты порядка и не заполнителя являются произвольными. Этот параметр является обязательным только в том случае, если указано имя_секции. |
primaryKey |
string |
Первичный ключ учетной записи cosmos DB. |
resourceGroup |
string |
Имя группы ресурсов учетной записи cosmos DB. |
secondaryKey |
string |
Вторичный ключ учетной записи cosmos DB. |
subscriptionId |
string |
Идентификатор подписки учетной записи cosmos DB. |
RoutingEndpoints
Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек во всех типах конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка.
Имя | Тип | Описание |
---|---|---|
cosmosDBSqlContainers |
Список конечных точек контейнера Cosmos DB, в которые Центр Интернета вещей направляет сообщения, на основе правил маршрутизации. |
|
eventHubs |
Список конечных точек Центров событий, в которые Центр Интернета вещей направляет сообщения, на основе правил маршрутизации. Этот список не включает встроенную конечную точку Центров событий. |
|
serviceBusQueues |
Список конечных точек очереди служебной шины, в которые Центр Интернета вещей направляет сообщения, на основе правил маршрутизации. |
|
serviceBusTopics |
Список конечных точек раздела служебной шины, в которые Центр Интернета вещей направляет сообщения, на основе правил маршрутизации. |
|
storageContainers |
Список конечных точек контейнера хранилища, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. |
RoutingEventHubProperties
Свойства, связанные с конечной точкой концентратора событий.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Метод, используемый для проверки подлинности в конечной точке концентратора событий |
|
connectionString |
string |
Строка подключения конечной точки концентратора событий. |
endpointUri |
string |
URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// |
entityPath |
string |
Имя концентратора событий в пространстве имен концентратора событий |
id |
string |
Идентификатор конечной точки концентратора событий |
identity |
Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. |
|
name |
string |
Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. |
resourceGroup |
string |
Имя группы ресурсов конечной точки концентратора событий. |
subscriptionId |
string |
Идентификатор подписки конечной точки концентратора событий. |
RoutingProperties
Свойства, связанные с маршрутизацией Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Имя | Тип | Описание |
---|---|---|
endpoints |
Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек для всех типов конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка. |
|
enrichments |
Список предоставленных пользователем обогащений, которые Центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См. статью: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
Свойства маршрута, который используется в качестве откатного маршрута при выполнении ни одного из условий, указанных в разделе "маршруты". Этот параметр является необязательным. Если это свойство отсутствует в шаблоне, резервный маршрут по умолчанию отключен. |
|
routes |
Список предоставленных пользователем правил маршрутизации, которые Центр Интернета вещей использует для маршрутизации сообщений во встроенные и настраиваемые конечные точки. Для платных концентраторов разрешено не более 100 правил маршрутизации, а для бесплатных концентраторов — не более 5 правил маршрутизации. |
RoutingServiceBusQueueEndpointProperties
Свойства, связанные с типами конечных точек очереди служебной шины.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Метод, используемый для проверки подлинности в конечной точке очереди служебной шины |
|
connectionString |
string |
Строка подключения конечной точки очереди служебной шины. |
endpointUri |
string |
URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// |
entityPath |
string |
Имя очереди в пространстве имен служебной шины |
id |
string |
Идентификатор конечной точки очереди служебной шины |
identity |
Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. |
|
name |
string |
Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с фактическим именем очереди. |
resourceGroup |
string |
Имя группы ресурсов конечной точки очереди служебной шины. |
subscriptionId |
string |
Идентификатор подписки конечной точки очереди служебной шины. |
RoutingServiceBusTopicEndpointProperties
Свойства, связанные с типами конечных точек раздела служебной шины.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Метод, используемый для проверки подлинности в конечной точке раздела служебной шины |
|
connectionString |
string |
Строка подключения конечной точки раздела служебной шины. |
endpointUri |
string |
URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// |
entityPath |
string |
Имя очереди в разделе служебной шины |
id |
string |
Идентификатор конечной точки раздела служебной шины |
identity |
Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. |
|
name |
string |
Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с именем фактического раздела. |
resourceGroup |
string |
Имя группы ресурсов конечной точки раздела служебной шины. |
subscriptionId |
string |
Идентификатор подписки конечной точки раздела служебной шины. |
RoutingSource
Источник, к которому будет применяться правило маршрутизации, например DeviceMessages.
Имя | Тип | Описание |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
Свойства, связанные с конечной точкой контейнера хранилища.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Метод, используемый для проверки подлинности в конечной точке хранилища |
|
batchFrequencyInSeconds |
integer |
Интервал времени, с которым большие двоичные объекты записываются в хранилище. Значение должно находиться в диапазоне от 60 до 720 секунд. Значение по умолчанию — 300 секунд. |
connectionString |
string |
Строка подключения учетной записи хранения. |
containerName |
string |
Имя контейнера хранилища в учетной записи хранения. |
encoding |
enum:
|
Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. |
endpointUri |
string |
URL-адрес конечной точки хранилища. Он должен включать протокол https:// |
fileNameFormat |
string |
Формат имени файла для большого двоичного объекта. Формат по умолчанию : {iothub}/{partition}/{ГГГГ}/{ММ}/{ДД}/{HH}/{mm}. Все параметры являются обязательными, но их можно изменить. |
id |
string |
Идентификатор конечной точки контейнера хранилища |
identity |
Свойства управляемого удостоверения конечной точки хранилища маршрутизации. |
|
maxChunkSizeInBytes |
integer |
Максимальное число байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно находиться в диапазоне от 10485760 (10 МБ) до 524288000 (500 МБ). Значение по умолчанию — 314572800 (300 МБ). |
name |
string |
Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. |
resourceGroup |
string |
Имя группы ресурсов учетной записи хранения. |
subscriptionId |
string |
Идентификатор подписки учетной записи хранения. |
SharedAccessSignatureAuthorizationRule
Свойства политики общего доступа к Центру Интернета вещей.
Имя | Тип | Описание |
---|---|---|
keyName |
string |
Название политики общего доступа. |
primaryKey |
string |
Первичный ключ. |
rights |
Разрешения, назначенные политике общего доступа. |
|
secondaryKey |
string |
Вторичный ключ. |
StorageEndpointProperties
Свойства конечной точки службы хранилища Azure для отправки файлов.
Имя | Тип | Описание |
---|---|---|
authenticationType |
Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения. |
|
connectionString |
string |
Строка подключения для учетной записи хранения Azure, в которую отправляются файлы. |
containerName |
string |
Имя корневого контейнера, в который отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанной connectionString. |
identity |
Свойства управляемого удостоверения конечной точки хранилища для отправки файлов. |
|
sasTtlAsIso8601 |
string |
Период времени, в течение которого URI SAS, созданный Центр Интернета вещей для отправки файла, действителен. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое в последний раз изменял ресурс. |
lastModifiedByType |
Тип удостоверения, изменяющего ресурс в последний раз. |
TagsResource
Контейнер, содержащий только теги для ресурса, что позволяет пользователю обновлять теги в экземпляре Центр Интернета вещей.
Имя | Тип | Описание |
---|---|---|
tags |
object |
Теги ресурсов |