Веб-узлы Microsoft.Devices
Определение ресурса Bicep
Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
enableFileUploadNotifications: bool
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
routing: {
endpoints: {
cosmosDBSqlContainers: [
{
authenticationType: 'string'
containerName: 'string'
databaseName: 'string'
endpointUri: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
}
Значения свойств
IotHubs
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы. Не может заканчиваться дефисом. Имя ресурса должно быть уникальным в Azure. |
| location | Местоположение ресурса. | строка (обязательно) |
| tags | Теги ресурса. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| sku | Сведения о номере SKU IotHub | IotHubSkuInfo (обязательно) |
| etag | Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в качестве заголовка в соответствии с обычным соглашением ETag. | строка |
| удостоверение | Управляемые удостоверения для Центра Интернета вещей. | ArmIdentity |
| properties | Свойства Центра интернета вещей | IotHubProperties |
ArmIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Словарь {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | ArmUserIdentity |
ArmUserIdentity
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
IotHubProperties
| Имя | Описание | Значение |
|---|---|---|
| allowedFqdnList | Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Интернета вещей. | string[] |
| authorizationPolicies | Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей. | CloudToDeviceProperties |
| comments | Комментарии к Центру Интернета вещей. | строка |
| disableDeviceSAS | Если значение равно true, все ключи SAS для устройств (включая пограничные устройства, но за исключением модулей) нельзя использовать для проверки подлинности. | bool |
| disableLocalAuth | Если значение равно true, маркеры SAS с ключами SAS в области центра Интернета вещей нельзя использовать для проверки подлинности. | bool |
| disableModuleSAS | Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS уровня модуля. | bool |
| enableDataResidency | Если для этого свойства задано значение true, будет включена возможность размещения данных, что отключит аварийное восстановление. | bool |
| enableFileUploadNotifications | Если задано значение True, уведомления о отправке файлов включены. | bool |
| eventHubEndpoints | Свойства конечной точки, совместимой с концентратором событий. Единственным возможным ключом к этому словарю являются события. Этот ключ должен присутствовать в словаре при выполнении вызовов создания или обновления для Центра Интернета вещей. | IotHubPropertiesEventHubEndpoints |
| features | Возможности и функции, включенные в Центр Интернета вещей. | DeviceManagement "Нет" |
| IpFilterRules | Правила фильтрации IP-адресов. | IpFilterRule[] |
| messagingEndpoints | Свойства конечной точки обмена сообщениями для очереди уведомлений об отправке файлов. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. | строка |
| networkRuleSets | Свойства набора правил сети в IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Подключения к частной конечной точке, созданные на этом сайте Интернета вещей | PrivateEndpointConnection[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restrictOutboundNetworkAccess | Если значение равно true, исходящий трафик из IotHub будет ограничен только разрешенными полными доменными именами, настроенными с помощью allowedFqdnList. | bool |
| маршрутизация | Свойства, связанные с маршрутизацией Центра Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging. | Свойства маршрутизации |
| storageEndpoints | Список конечных точек службы хранилища Azure, куда можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure, которая должна иметь свой ключ в качестве $default. Если указать несколько учетных записей хранения, возникает ошибка. Если для свойства enableFileUploadNotifications не задано значение True, возникает ошибка. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Имя | Описание | Значение |
|---|---|---|
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect RegistryRead RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect ServiceConnect, DeviceConnect (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect RegistryRead RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect ServiceConnect, DeviceConnect (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
CloudToDeviceProperties
| Имя | Описание | Значение |
|---|---|---|
| defaultTtlAsIso8601 | Время жизни по умолчанию для сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| обратная связь | Свойства очереди обратной связи для сообщений из облака на устройство. | FeedbackProperties |
| maxDeliveryCount | Максимальное число доставки сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
FeedbackProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки для очереди обратной связи. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| maxDeliveryCount | Количество попыток Центра Интернета вещей доставить сообщение в очередь отзывов. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
IotHubPropertiesEventHubEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | EventHubProperties |
EventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| partitionCount | Количество секций для получения сообщений, отправляемых с устройства в облако, в конечной точке, совместимой с концентратором событий. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
| retentionTimeInDays | Время хранения сообщений, отправляемых с устройства в облако, в днях. См.: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | INT |
IpFilterRule
| Имя | Описание | Значение |
|---|---|---|
| action | Требуемое действие для запросов, зафиксированных этим правилом. | "Принять" "Отклонить" (обязательно) |
| filterName | Имя правила фильтрации IP-адресов. | строка (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | строка (обязательно) |
IotHubPropertiesMessagingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | MessagingEndpointProperties |
MessagingEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
| maxDeliveryCount | Количество попыток центра Интернета вещей доставить сообщение. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
NetworkRuleSetProperties
| Имя | Описание | Значение |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Если задано значение True, набор правил сети также применяется к BuiltIn EventHub EndPoint iotHub. | bool (обязательно) |
| defaultAction | Действие по умолчанию для набора сетевых правил | "Разрешить" "Deny" |
| ipRules | Список правил IP-адресов | NetworkRuleSetIpRule[] (обязательно) |
NetworkRuleSetIpRule
| Имя | Описание | Значение |
|---|---|---|
| action | Действие фильтра IP-адресов | "Разрешить" |
| filterName | Имя правила фильтрации IP-адресов. | string (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | string (обязательно) |
PrivateEndpointConnection
| Имя | Описание | Значение |
|---|---|---|
| properties | Свойства подключения к частной конечной точке | PrivateEndpointConnectionProperties (обязательно) |
PrivateEndpointConnectionProperties
| Имя | Описание | Значение |
|---|---|---|
| privateEndpoint | Свойство частной конечной точки подключения к частной конечной точке | PrivateEndpoint |
| privateLinkServiceConnectionState | Текущее состояние подключения к частной конечной точке | PrivateLinkServiceConnectionState (обязательно) |
PrivateEndpoint
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
PrivateLinkServiceConnectionState
| Имя | Описание | Значение |
|---|---|---|
| actionsRequired | Действия, необходимые для подключения к частной конечной точке | строка |
| description | Описание текущего состояния подключения к частной конечной точке | string (обязательно) |
| status | Состояние подключения к частной конечной точке | "Утверждено" "Отключено" "Ожидание" "Отклонено" (обязательно) |
Свойства маршрутизации
| Имя | Описание | Значение |
|---|---|---|
| конечные точки | Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек для всех типов конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка. | RoutingEndpoints |
| обогащения | Список предоставленных пользователем обогащений, которые Центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См. статью: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
| fallbackRoute | Свойства маршрута, который используется в качестве откатного маршрута при выполнении ни одного из условий, указанных в разделе "маршруты". Этот параметр является необязательным. Если это свойство отсутствует в шаблоне, резервный маршрут по умолчанию отключен. | FallbackRouteProperties |
| маршруты | Список предоставленных пользователем правил маршрутизации, которые Центр Интернета вещей использует для маршрутизации сообщений во встроенные и настраиваемые конечные точки. Для платных концентраторов разрешено не более 100 правил маршрутизации, а для бесплатных концентраторов — не более 5 правил маршрутизации. | RouteProperties[] |
RoutingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| cosmosDBSqlContainers | Список конечных точек контейнера Cosmos DB, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Список конечных точек Центров событий, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. Этот список не включает встроенную конечную точку Центров событий. | RoutingEventHubProperties[] |
| serviceBusQueues | Список конечных точек очереди служебной шины, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Список конечных точек раздела служебной шины, в которые Центр Интернета вещей направляет сообщения, на основе правил маршрутизации. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Список конечных точек контейнера хранилища, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке контейнера SQL cosmos DB | IdentityBased KeyBased |
| containerName | Имя контейнера sql cosmos DB в базе данных cosmos DB. | строка (обязательно) |
| databaseName | Имя базы данных cosmos DB в учетной записи cosmos DB. | строка (обязательно) |
| endpointUri | URL-адрес учетной записи cosmos DB. Он должен включать протокол https:// |
строка (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки контейнера cosmos DB маршрутизации. | ManagedIdentity |
| name | Имя, идентифицирующее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | строка (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Имя ключа секции, связанного с этим контейнером SQL cosmos DB, если таковой существует. Этот параметр является необязательным. | строка |
| partitionKeyTemplate | Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM} и {ГГГГ}. Любой заполнитель может быть указан не более одного раза, но компоненты порядка и без заполнителей являются произвольными. Этот параметр является обязательным, только если указано partitionKeyName. | строка |
| primaryKey | Первичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| resourceGroup | Имя группы ресурсов учетной записи cosmos DB. | строка |
| secondaryKey | Вторичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| subscriptionId | Идентификатор подписки учетной записи cosmos DB. | строка |
ManagedIdentity
| Имя | Описание | Значение |
|---|---|---|
| userAssignedIdentity | Удостоверение, назначаемое пользователем. | строка |
RoutingEventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке концентратора событий | IdentityBased KeyBased |
| connectionString | Строка подключения конечной точки концентратора событий. | строка |
| endpointUri | URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// | строка |
| entityPath | Имя концентратора событий в пространстве имен концентратора событий | строка |
| идентификатор | Идентификатор конечной точки концентратора событий | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. | ManagedIdentity |
| name | Имя, идентифицирующее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | строка (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки концентратора событий. | строка |
| subscriptionId | Идентификатор подписки конечной точки концентратора событий. | строка |
RoutingServiceBusQueueEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке очереди служебной шины | IdentityBased 'keyBased' |
| connectionString | Строка подключения конечной точки очереди служебной шины. | строка |
| endpointUri | URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в пространстве имен служебной шины | строка |
| идентификатор | Идентификатор конечной точки очереди служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с фактическим именем очереди. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки очереди служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки очереди служебной шины. | строка |
RoutingServiceBusTopicEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке раздела служебной шины | IdentityBased 'keyBased' |
| connectionString | Строка подключения конечной точки раздела служебной шины. | строка |
| endpointUri | URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в разделе служебной шины | строка |
| идентификатор | Идентификатор конечной точки раздела служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с именем фактического раздела. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки раздела служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки раздела служебной шины. | строка |
RoutingStorageContainerProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке хранилища | IdentityBased 'keyBased' |
| batchFrequencyInSeconds | Интервал времени, с которым большие двоичные объекты записываются в хранилище. Значение должно находиться в диапазоне от 60 до 720 секунд. Значение по умолчанию — 300 секунд. | INT Ограничения: Минимальное значение = 60 Максимальное значение = 720 |
| connectionString | Строка подключения учетной записи хранения. | строка |
| containerName | Имя контейнера хранилища в учетной записи хранения. | string (обязательно) |
| encoding | Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. | 'Avro' AvroDeflate "JSON" |
| endpointUri | URL-адрес конечной точки хранилища. Он должен включать протокол https:// |
строка |
| fileNameFormat | Формат имени файла для большого двоичного объекта. Формат по умолчанию : {iothub}/{partition}/{ГГГГ}/{ММ}/{ДД}/{HH}/{mm}. Все параметры являются обязательными, но их можно изменить. | строка |
| идентификатор | Идентификатор конечной точки контейнера хранилища | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища маршрутизации. | ManagedIdentity |
| maxChunkSizeInBytes | Максимальное число байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно находиться в диапазоне от 10485760 (10 МБ) до 524288000 (500 МБ). Значение по умолчанию — 314572800 (300 МБ). | INT Ограничения: Минимальное значение = 10485760 Максимальное значение = 524288000 |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов учетной записи хранения. | строка |
| subscriptionId | Идентификатор подписки учетной записи хранения. | строка |
ОбогащениеСвойства
| Имя | Описание | Значение |
|---|---|---|
| endpointNames | Список конечных точек, для которых обогащение применяется к сообщению. | string[] (обязательно) Ограничения: Минимальная длина = 1 |
| ключ | Ключ или имя свойства обогащения. | string (обязательно) |
| значение | Значение свойства обогащения. | string (обязательно) |
FallbackRouteProperties
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, по умолчанию будет установлено значение true. Сведения о грамматике см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только 1 конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания того, включен ли резервный маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальной длиной 64 символа и должно быть уникальным. | строка |
| source | Источник, к которому применяется правило маршрутизации. Например, DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" TwinChangeEvents (обязательно) |
Свойства route
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения правила маршрутизации. Если условие не указано, оно по умолчанию принимает значение true. Сведения о грамматике см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания того, включен ли маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальной длиной 64 символа и должно быть уникальным. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| source | Источник, к которому будет применяться правило маршрутизации, например DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" TwinChangeEvents (обязательно) |
IotHubPropertiesStorageEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | Свойства StorageEndpoint |
Свойства StorageEndpoint
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения. | IdentityBased 'keyBased' |
| connectionString | Строка подключения для учетной записи хранения Azure, в которую отправляются файлы. | string (обязательно) |
| containerName | Имя корневого контейнера, в который отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанного параметра connectionString. | string (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища для отправки файлов. | ManagedIdentity |
| sasTtlAsIso8601 | Период времени, в течение которого URI SAS, созданный Центр Интернета вещей для отправки файлов, действителен. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | строка |
IotHubSkuInfo
| Имя | Описание | Значение |
|---|---|---|
| Емкость | Количество подготовленных Центр Интернета вещей единиц. См. раздел /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Имя номера SKU. | 'B1' 'B2' 'B3' "F1" 'S1' 'S2' "S3" (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Создание пограничного симулятора Центра Интернета вещей и Ubuntu |
Этот шаблон создает пограничный симулятор Центра Интернета вещей и виртуальной машины Ubuntu. |
| Использование шаблона ARM для создания Центр Интернета вещей, маршрутизации и просмотра сообщений |
Используйте этот шаблон для развертывания Центр Интернета вещей и учетной записи хранения. Запустите приложение для отправки сообщений в центр, которые направляются в хранилище, а затем просмотрите результаты. |
| Создание службы подготовки устройств Центр Интернета вещей |
Этот шаблон позволяет создать Центр Интернета вещей и службу подготовки устройств Центр Интернета вещей, а также связать две службы вместе. |
| Создание Центр Интернета вещей и группы потребителей из устройства в облако |
Этот шаблон позволяет развернуть экземпляр Центр Интернета вещей с устройством в облаке и конфигурации обмена сообщениями из облака на устройство, а устройство — в облачную группу потребителей. |
| Создание обновления устройства для учетной записи Центр Интернета вещей, экземпляра Центр Интернета вещей |
Этот шаблон создает учетную запись, а также экземпляр и концентратор для связывания экземпляра. Он настраивает центр с необходимыми политиками доступа, маршрутами и группой потребителей. |
| Развертывание службы MedTech, включая Центр Интернета вещей Azure |
Служба MedTech — это одна из служб данных здравоохранения Azure, предназначенная для приема данных устройств с нескольких устройств, преобразования данных устройства в наблюдения FHIR, которые затем сохраняются в службе FHIR Data Services Azure. |
| Создание среды с оплатой по мере использования (PAYG) с Центр Интернета вещей |
Этот шаблон позволяет развернуть среду Аналитики временных рядов с оплатой по мере использования (PAYG), настроенную для использования событий из Центр Интернета вещей. |
Определение ресурса шаблона ARM
Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2023-06-30",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"enableFileUploadNotifications": "bool",
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"routing": {
"endpoints": {
"cosmosDBSqlContainers": [
{
"authenticationType": "string",
"containerName": "string",
"databaseName": "string",
"endpointUri": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
}
}
Значения свойств
IotHubs
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.Devices/IotHubs |
| версия_API | Версия API ресурсов | '2023-06-30' |
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы. Не может заканчиваться дефисом. Имя ресурса должно быть уникальным в Azure. |
| location | Местоположение ресурса. | строка (обязательно) |
| tags | Теги ресурса. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| sku | Сведения о номере SKU IotHub | IotHubSkuInfo (обязательно) |
| etag | Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в качестве заголовка в соответствии с обычным соглашением ETag. | строка |
| удостоверение | Управляемые удостоверения для Центра Интернета вещей. | ArmIdentity |
| properties | Свойства Центра интернета вещей | IotHubProperties |
ArmIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Словарь {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | ArmUserIdentity |
ArmUserIdentity
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
IotHubProperties
| Имя | Описание | Значение |
|---|---|---|
| allowedFqdnList | Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Интернета вещей. | string[] |
| authorizationPolicies | Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей. | CloudToDeviceProperties |
| comments | Комментарии к Центру Интернета вещей. | строка |
| disableDeviceSAS | Если значение равно true, все ключи SAS для устройств (включая пограничные устройства, но за исключением модулей) нельзя использовать для проверки подлинности. | bool |
| disableLocalAuth | Если значение равно true, маркеры SAS с ключами SAS в области центра Интернета вещей нельзя использовать для проверки подлинности. | bool |
| disableModuleSAS | Если значение равно true, для проверки подлинности нельзя использовать все ключи SAS на уровне модуля. | bool |
| enableDataResidency | Если для этого свойства задано значение true, будет включена возможность расположения данных, что отключит аварийное восстановление. | bool |
| enableFileUploadNotifications | Если задано значение True, уведомления о отправке файлов включены. | bool |
| eventHubEndpoints | Свойства конечной точки, совместимой с концентратором событий. Единственным возможным ключом к этому словарю являются события. Этот ключ должен присутствовать в словаре при выполнении вызовов создания или обновления для Центра Интернета вещей. | IotHubPropertiesEventHubEndpoints |
| features | Возможности и функции, включенные в Центр Интернета вещей. | DeviceManagement "Нет" |
| IpFilterRules | Правила фильтрации IP-адресов. | IpFilterRule[] |
| messagingEndpoints | Свойства конечной точки обмена сообщениями для очереди уведомлений об отправке файлов. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. | строка |
| networkRuleSets | Свойства набора правил сети в IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Подключения к частной конечной точке, созданные на этом сайте Интернета вещей | PrivateEndpointConnection[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restrictOutboundNetworkAccess | Если значение равно true, исходящий трафик из IotHub будет ограничен только разрешенными полными доменными именами, настроенными с помощью allowedFqdnList. | bool |
| маршрутизация | Свойства, связанные с маршрутизацией Центра Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging. | Свойства маршрутизации |
| storageEndpoints | Список конечных точек службы хранилища Azure, куда можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure, которая должна иметь свой ключ в качестве $default. Если указать несколько учетных записей хранения, возникает ошибка. Если для свойства enableFileUploadNotifications не задано значение True, возникает ошибка. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Имя | Описание | Значение |
|---|---|---|
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect RegistryRead RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect ServiceConnect, DeviceConnect (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect RegistryRead RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect ServiceConnect, DeviceConnect (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
Свойства CloudToDevice
| Имя | Описание | Значение |
|---|---|---|
| defaultTtlAsIso8601 | Время жизни по умолчанию для сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| обратная связь | Свойства очереди отзывов для сообщений из облака на устройство. | FeedbackProperties |
| maxDeliveryCount | Максимальное число доставок для сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
FeedbackProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки для очереди обратной связи. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| maxDeliveryCount | Количество попыток центра Интернета вещей доставить сообщение в очередь отзывов. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
IotHubPropertiesEventHubEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | EventHubProperties |
EventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| partitionCount | Количество секций для получения сообщений с устройства в облако в конечной точке, совместимой с Концентратором событий. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
| retentionTimeInDays | Время хранения сообщений с устройства в облако в днях. См. раздел :/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
IpFilterRule
| Имя | Описание | Значение |
|---|---|---|
| action | Требуемое действие для запросов, отслеживаемых этим правилом. | "Принять" "Отклонить" (обязательно) |
| filterName | Имя правила фильтрации IP-адресов. | string (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | string (обязательно) |
IotHubPropertiesMessagingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | MessagingEndpointProperties |
MessagingEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
| maxDeliveryCount | Количество попыток доставки сообщения центром Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
NetworkRuleSetProperties
| Имя | Описание | Значение |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Если задано значение True, набор правил сети также применяется к BuiltIn EventHub EndPoint iotHub. | bool (обязательно) |
| defaultAction | Действие по умолчанию для набора сетевых правил | "Разрешить" "Deny" |
| ipRules | Список правил IP-адресов | NetworkRuleSetIpRule[] (обязательно) |
NetworkRuleSetIpRule
| Имя | Описание | Значение |
|---|---|---|
| action | Действие фильтра IP-адресов | "Разрешить" |
| filterName | Имя правила фильтрации IP-адресов. | string (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | string (обязательно) |
PrivateEndpointConnection
| Имя | Описание | Значение |
|---|---|---|
| properties | Свойства подключения к частной конечной точке | PrivateEndpointConnectionProperties (обязательно) |
PrivateEndpointConnectionProperties
| Имя | Описание | Значение |
|---|---|---|
| privateEndpoint | Свойство частной конечной точки подключения к частной конечной точке | PrivateEndpoint |
| privateLinkServiceConnectionState | Текущее состояние подключения к частной конечной точке | PrivateLinkServiceConnectionState (обязательно) |
PrivateEndpoint
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
PrivateLinkServiceConnectionState
| Имя | Описание | Значение |
|---|---|---|
| actionsRequired | Действия, необходимые для подключения к частной конечной точке | строка |
| description | Описание текущего состояния подключения к частной конечной точке | string (обязательно) |
| status | Состояние подключения к частной конечной точке | "Утверждено" "Отключено" "Ожидание" "Отклонено" (обязательно) |
Свойства маршрутизации
| Имя | Описание | Значение |
|---|---|---|
| конечные точки | Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек для всех типов конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка. | RoutingEndpoints |
| обогащения | Список предоставленных пользователем обогащений, которые Центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См. статью: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
| fallbackRoute | Свойства маршрута, который используется в качестве откатного маршрута при выполнении ни одного из условий, указанных в разделе "маршруты". Этот параметр является необязательным. Если это свойство отсутствует в шаблоне, резервный маршрут по умолчанию отключен. | FallbackRouteProperties |
| маршруты | Список предоставленных пользователем правил маршрутизации, которые Центр Интернета вещей использует для маршрутизации сообщений во встроенные и настраиваемые конечные точки. Для платных концентраторов разрешено не более 100 правил маршрутизации, а для бесплатных концентраторов — не более 5 правил маршрутизации. | RouteProperties[] |
RoutingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| cosmosDBSqlContainers | Список конечных точек контейнера Cosmos DB, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Список конечных точек Центров событий, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. Этот список не включает встроенную конечную точку Центров событий. | RoutingEventHubProperties[] |
| serviceBusQueues | Список конечных точек очереди служебной шины, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Список конечных точек раздела служебной шины, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Список конечных точек контейнера хранилища, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке контейнера SQL cosmos DB | IdentityBased 'keyBased' |
| containerName | Имя контейнера sql cosmos DB в базе данных cosmos DB. | string (обязательно) |
| databaseName | Имя базы данных cosmos DB в учетной записи cosmos DB. | string (обязательно) |
| endpointUri | URL-адрес учетной записи cosmos DB. Он должен включать протокол https:// |
string (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки контейнера cosmos DB маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Имя ключа секции, связанного с этим контейнером sql cosmos DB, если он существует. Этот параметр является необязательным. | строка |
| partitionKeyTemplate | Шаблон для создания значения искусственного ключа секции для использования с этим контейнером sql Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан не более одного раза, но компоненты порядка и не заполнителя являются произвольными. Этот параметр является обязательным только в том случае, если указано имя_секции. | строка |
| primaryKey | Первичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| resourceGroup | Имя группы ресурсов учетной записи cosmos DB. | строка |
| secondaryKey | Вторичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| subscriptionId | Идентификатор подписки учетной записи cosmos DB. | строка |
ManagedIdentity
| Имя | Описание | Значение |
|---|---|---|
| userAssignedIdentity | Удостоверение, назначаемое пользователем. | строка |
RoutingEventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке концентратора событий | IdentityBased 'keyBased' |
| connectionString | Строка подключения конечной точки концентратора событий. | строка |
| endpointUri | URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// | строка |
| entityPath | Имя концентратора событий в пространстве имен концентратора событий | строка |
| идентификатор | Идентификатор конечной точки концентратора событий | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки концентратора событий. | строка |
| subscriptionId | Идентификатор подписки конечной точки концентратора событий. | строка |
RoutingServiceBusQueueEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке очереди служебной шины | IdentityBased 'keyBased' |
| connectionString | Строка подключения конечной точки очереди служебной шины. | строка |
| endpointUri | URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в пространстве имен служебной шины | строка |
| идентификатор | Идентификатор конечной точки очереди служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с фактическим именем очереди. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки очереди служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки очереди служебной шины. | строка |
RoutingServiceBusTopicEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке раздела служебной шины | IdentityBased 'keyBased' |
| connectionString | Строка подключения конечной точки раздела служебной шины. | строка |
| endpointUri | URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в разделе служебной шины | строка |
| идентификатор | Идентификатор конечной точки раздела служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не должно совпадать с именем фактического раздела. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки раздела служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки раздела служебной шины. | строка |
RoutingStorageContainerProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке хранилища | IdentityBased 'keyBased' |
| batchFrequencyInSeconds | Интервал времени, с которым большие двоичные объекты записываются в хранилище. Значение должно находиться в диапазоне от 60 до 720 секунд. Значение по умолчанию — 300 секунд. | INT Ограничения: Минимальное значение = 60 Максимальное значение = 720 |
| connectionString | Строка подключения учетной записи хранения. | строка |
| containerName | Имя контейнера хранилища в учетной записи хранения. | string (обязательно) |
| encoding | Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. | 'Avro' AvroDeflate "JSON" |
| endpointUri | URL-адрес конечной точки хранилища. Он должен включать протокол https:// |
строка |
| fileNameFormat | Формат имени файла для большого двоичного объекта. Формат по умолчанию : {iothub}/{partition}/{ГГГГ}/{ММ}/{ДД}/{HH}/{mm}. Все параметры являются обязательными, но их можно изменить. | строка |
| идентификатор | Идентификатор конечной точки контейнера хранилища | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища маршрутизации. | ManagedIdentity |
| maxChunkSizeInBytes | Максимальное число байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно находиться в диапазоне от 10485760 (10 МБ) до 524288000 (500 МБ). Значение по умолчанию — 314572800 (300 МБ). | INT Ограничения: Минимальное значение = 10485760 Максимальное значение = 524288000 |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов учетной записи хранения. | строка |
| subscriptionId | Идентификатор подписки учетной записи хранения. | строка |
ОбогащениеСвойства
| Имя | Описание | Значение |
|---|---|---|
| endpointNames | Список конечных точек, для которых обогащение применяется к сообщению. | string[] (обязательно) Ограничения: Минимальная длина = 1 |
| ключ | Ключ или имя свойства обогащения. | string (обязательно) |
| значение | Значение свойства обогащения. | string (обязательно) |
FallbackRouteProperties
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, по умолчанию будет установлено значение true. Сведения о грамматике см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только 1 конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания того, включен ли резервный маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальной длиной 64 символа и должно быть уникальным. | строка |
| source | Источник, к которому применяется правило маршрутизации. Например, DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" TwinChangeEvents (обязательно) |
Свойства route
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения правила маршрутизации. Если условие не указано, оно по умолчанию принимает значение true. Грамматику см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания, включен ли маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальная длина — 64 символа и должно быть уникальным. | строка (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| source | Источник, к которому должно применяться правило маршрутизации, например DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" TwinChangeEvents (обязательно) |
IotHubPropertiesStorageEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | StorageEndpointProperties |
StorageEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения. | IdentityBased KeyBased |
| connectionString | Строка подключения для учетной записи хранения Azure, в которую отправляются файлы. | строка (обязательно) |
| containerName | Имя корневого контейнера, в который отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанной connectionString. | строка (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища для отправки файлов. | ManagedIdentity |
| sasTtlAsIso8601 | Период времени, в течение которого URI SAS, созданный Центр Интернета вещей для отправки файла, действителен. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | строка |
IotHubSkuInfo
| Имя | Описание | Значение |
|---|---|---|
| Емкость | Количество подготовленных Центр Интернета вещей единиц. См. раздел /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Имя номера SKU. | "B1" "B2" "B3" F1 'S1' 'S2' S3 (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Создание пограничного симулятора Центра Интернета вещей и Ubuntu |
Этот шаблон создает пограничный симулятор Центра Интернета вещей и виртуальной машины Ubuntu. |
| Использование шаблона ARM для создания Центр Интернета вещей, маршрутизации и просмотра сообщений |
Используйте этот шаблон для развертывания Центр Интернета вещей и учетной записи хранения. Запустите приложение для отправки сообщений в центр, которые направляются в хранилище, а затем просмотрите результаты. |
| Создание службы подготовки устройств Центр Интернета вещей |
Этот шаблон позволяет создать Центр Интернета вещей и службу подготовки устройств Центр Интернета вещей, а также связать эти две службы. |
| Создание Центр Интернета вещей и группы потребителей из устройства в облако |
Этот шаблон позволяет развернуть экземпляр Центр Интернета вещей с устройством в облаке и из облака в конфигурации обмена сообщениями на устройстве и с устройства в группу потребителей в облаке. |
| Создание обновления устройства для учетной записи, экземпляра Центр Интернета вещей Центр Интернета вещей |
Этот шаблон создает учетную запись, экземпляр и концентратор для связывания экземпляра. Он настраивает центр с необходимыми политиками доступа, маршрутами и группой потребителей. |
| Развертывание службы MedTech, включая Центр Интернета вещей Azure |
Служба MedTech — это одна из служб данных здравоохранения Azure, предназначенная для приема данных устройств с нескольких устройств, преобразования данных устройства в наблюдения FHIR, которые затем сохраняются в службе FHIR Data Services Azure. |
| Создание среды с оплатой по мере использования (PAYG) с Центр Интернета вещей |
Этот шаблон позволяет развернуть среду Аналитики временных рядов с оплатой по мере использования (PAYG), настроенную для использования событий из Центр Интернета вещей. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2023-06-30"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
routing = {
endpoints = {
cosmosDBSqlContainers = [
{
authenticationType = "string"
containerName = "string"
databaseName = "string"
endpointUri = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Значения свойств
IotHubs
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.Devices/IotHubs@2023-06-30" |
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы. Не может заканчиваться дефисом. Имя ресурса должно быть уникальным в Azure. |
| location | Местоположение ресурса. | строка (обязательно) |
| parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| tags | Теги ресурса. | Словарь имен и значений тегов. |
| sku | Сведения о номере SKU IotHub | IotHubSkuInfo (обязательно) |
| etag | Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в качестве заголовка в соответствии с обычным соглашением ETag. | строка |
| удостоверение | Управляемые удостоверения для Центра Интернета вещей. | ArmIdentity |
| properties | Свойства Центра интернета вещей | IotHubProperties |
ArmIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. | "SystemAssigned" "SystemAssigned, UserAssigned" UserAssigned |
| identity_ids | Словарь {ArmUserIdentity} | Массив идентификаторов удостоверений пользователей. |
ArmIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | ArmUserIdentity |
ArmUserIdentity
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
IotHubProperties
| Имя | Описание | Значение |
|---|---|---|
| allowedFqdnList | Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Интернета вещей. | string[] |
| authorizationPolicies | Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей. | CloudToDeviceProperties |
| comments | Комментарии к Центру Интернета вещей. | строка |
| disableDeviceSAS | Если значение равно true, все ключи SAS для устройств (включая пограничные устройства, но за исключением модулей) нельзя использовать для проверки подлинности. | bool |
| disableLocalAuth | Если значение равно true, маркеры SAS с ключами SAS в области центра Интернета вещей нельзя использовать для проверки подлинности. | bool |
| disableModuleSAS | Если значение равно true, для проверки подлинности нельзя использовать все ключи SAS на уровне модуля. | bool |
| enableDataResidency | Если для этого свойства задано значение true, будет включена возможность расположения данных, что отключит аварийное восстановление. | bool |
| enableFileUploadNotifications | Если значение равно True, уведомления об отправке файлов включены. | bool |
| eventHubEndpoints | Свойства конечной точки, совместимой с концентратором событий. Единственными возможными ключами для этого словаря являются события. Этот ключ должен присутствовать в словаре при выполнении вызовов создания или обновления для Центра Интернета вещей. | IotHubPropertiesEventHubEndpoints |
| features | Возможности и функции, включенные в Центр Интернета вещей. | DeviceManagement "None" |
| IpFilterRules | Правила фильтрации IP-адресов. | IpFilterRule[] |
| messagingEndpoints | Свойства конечной точки обмена сообщениями для очереди уведомлений об отправке файлов. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. | строка |
| networkRuleSets | Свойства набора правил сети в IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Подключения к частной конечной точке, созданные на этом сайте Интернета вещей | PrivateEndpointConnection[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restrictOutboundNetworkAccess | Если значение равно true, исходящий трафик из IotHub будет ограничен только разрешенными полными доменными именами, настроенными с помощью allowedFqdnList. | bool |
| маршрутизация | Свойства, связанные с маршрутизацией Центра Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging. | Свойства маршрутизации |
| storageEndpoints | Список конечных точек службы хранилища Azure, куда можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure, которая должна иметь свой ключ в качестве $default. Если указать несколько учетных записей хранения, возникает ошибка. Если для свойства enableFileUploadNotifications не задано значение True, возникает ошибка. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Имя | Описание | Значение |
|---|---|---|
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect "RegistryRead" RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect "ServiceConnect, DeviceConnect" (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
| keyName | Название политики общего доступа. | string (обязательно) |
| primaryKey | Первичный ключ. | строка |
| права | Разрешения, назначенные политике общего доступа. | DeviceConnect "RegistryRead" RegistryRead, DeviceConnect RegistryRead, RegistryWrite RegistryRead, RegistryWrite, DeviceConnect RegistryRead, RegistryWrite, ServiceConnect RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect RegistryRead, ServiceConnect RegistryRead, ServiceConnect, DeviceConnect RegistryWrite RegistryWrite, DeviceConnect RegistryWrite, ServiceConnect RegistryWrite, ServiceConnect, DeviceConnect ServiceConnect "ServiceConnect, DeviceConnect" (обязательно) |
| secondaryKey | Вторичный ключ. | строка |
Свойства CloudToDevice
| Имя | Описание | Значение |
|---|---|---|
| defaultTtlAsIso8601 | Время жизни по умолчанию для сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| обратная связь | Свойства очереди отзывов для сообщений из облака на устройство. | FeedbackProperties |
| maxDeliveryCount | Максимальное число доставок для сообщений из облака на устройство в очереди устройств. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
FeedbackProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки для очереди обратной связи. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
| maxDeliveryCount | Количество попыток центра Интернета вещей доставить сообщение в очередь отзывов. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | строка |
IotHubPropertiesEventHubEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | EventHubProperties |
EventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| partitionCount | Количество секций для получения сообщений с устройства в облако в конечной точке, совместимой с Концентратором событий. См. раздел /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
| retentionTimeInDays | Время хранения сообщений с устройства в облако в днях. См. раздел :/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | INT |
IpFilterRule
| Имя | Описание | Значение |
|---|---|---|
| action | Требуемое действие для запросов, отслеживаемых этим правилом. | "Принять" "Отклонить" (обязательно) |
| filterName | Имя правила фильтрации IP-адресов. | string (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | string (обязательно) |
IotHubPropertiesMessagingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | MessagingEndpointProperties |
MessagingEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| lockDurationAsIso8601 | Длительность блокировки. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
| maxDeliveryCount | Количество попыток доставки сообщения центром Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 100 |
| ttlAsIso8601 | Период времени, в течение которого сообщение доступно для использования до истечения срока его действия в Центре Интернета вещей. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload. | строка |
NetworkRuleSetProperties
| Имя | Описание | Значение |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Если задано значение True, набор правил сети также применяется к BuiltIn EventHub EndPoint iotHub. | bool (обязательно) |
| defaultAction | Действие по умолчанию для набора сетевых правил | "Разрешить" "Запретить" |
| ipRules | Список правил IP-адресов | NetworkRuleSetIpRule[] (обязательно) |
NetworkRuleSetIpRule
| Имя | Описание | Значение |
|---|---|---|
| action | Действие фильтра IP-адресов | "Разрешить" |
| filterName | Имя правила фильтрации IP-адресов. | string (обязательно) |
| ipMask | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | string (обязательно) |
PrivateEndpointConnection
| Имя | Описание | Значение |
|---|---|---|
| properties | Свойства подключения к частной конечной точке | PrivateEndpointConnectionProperties (обязательно) |
PrivateEndpointConnectionProperties
| Имя | Описание | Значение |
|---|---|---|
| privateEndpoint | Свойство частной конечной точки подключения к частной конечной точке | PrivateEndpoint |
| privateLinkServiceConnectionState | Текущее состояние подключения к частной конечной точке | PrivateLinkServiceConnectionState (обязательно) |
PrivateEndpoint
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
PrivateLinkServiceConnectionState
| Имя | Описание | Значение |
|---|---|---|
| actionsRequired | Действия, необходимые для подключения к частной конечной точке | строка |
| description | Описание текущего состояния подключения к частной конечной точке | string (обязательно) |
| status | Состояние подключения к частной конечной точке | "Утверждено" "Отключено" "Ожидание" "Отклонено" (обязательно) |
Свойства маршрутизации
| Имя | Описание | Значение |
|---|---|---|
| конечные точки | Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек для всех типов конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка. | RoutingEndpoints |
| обогащения | Список предоставленных пользователем обогащений, которые Центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См. статью: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
| fallbackRoute | Свойства маршрута, который используется в качестве откатного маршрута при выполнении ни одного из условий, указанных в разделе "маршруты". Этот параметр является необязательным. Если это свойство отсутствует в шаблоне, резервный маршрут по умолчанию отключен. | FallbackRouteProperties |
| маршруты | Список предоставленных пользователем правил маршрутизации, которые Центр Интернета вещей использует для маршрутизации сообщений во встроенные и настраиваемые конечные точки. Для платных концентраторов разрешено не более 100 правил маршрутизации, а для бесплатных концентраторов — не более 5 правил маршрутизации. | RouteProperties[] |
RoutingEndpoints
| Имя | Описание | Значение |
|---|---|---|
| cosmosDBSqlContainers | Список конечных точек контейнера Cosmos DB, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Список конечных точек Центров событий, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. Этот список не включает встроенную конечную точку Центров событий. | RoutingEventHubProperties[] |
| serviceBusQueues | Список конечных точек очереди служебной шины, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Список конечных точек раздела служебной шины, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Список конечных точек контейнера хранилища, в которые Центр Интернета вещей направляет сообщения на основе правил маршрутизации. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке контейнера SQL cosmos DB | "identityBased" "keyBased" |
| containerName | Имя контейнера sql cosmos DB в базе данных cosmos DB. | string (обязательно) |
| databaseName | Имя базы данных cosmos DB в учетной записи cosmos DB. | string (обязательно) |
| endpointUri | URL-адрес учетной записи cosmos DB. Он должен включать протокол https:// |
string (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки контейнера cosmos DB маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Имя ключа секции, связанного с этим контейнером sql cosmos DB, если он существует. Этот параметр является необязательным. | строка |
| partitionKeyTemplate | Шаблон для создания значения искусственного ключа секции для использования с этим контейнером sql Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан не более одного раза, но компоненты порядка и не заполнителя являются произвольными. Этот параметр является обязательным только в том случае, если указано имя_секции. | строка |
| primaryKey | Первичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| resourceGroup | Имя группы ресурсов учетной записи cosmos DB. | строка |
| secondaryKey | Вторичный ключ учетной записи cosmos DB. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| subscriptionId | Идентификатор подписки учетной записи cosmos DB. | строка |
ManagedIdentity
| Имя | Описание | Значение |
|---|---|---|
| userAssignedIdentity | Удостоверение, назначаемое пользователем. | строка |
RoutingEventHubProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке концентратора событий | "identityBased" "keyBased" |
| connectionString | Строка подключения конечной точки концентратора событий. | строка |
| endpointUri | URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// | строка |
| entityPath | Имя концентратора событий в пространстве имен концентратора событий | строка |
| идентификатор | Идентификатор конечной точки концентратора событий | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. | ManagedIdentity |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки концентратора событий. | строка |
| subscriptionId | Идентификатор подписки конечной точки концентратора событий. | строка |
RoutingServiceBusQueueEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке очереди служебной шины | IdentityBased "keyBased" |
| connectionString | Строка подключения конечной точки очереди служебной шины. | строка |
| endpointUri | URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в пространстве имен служебной шины | строка |
| идентификатор | Идентификатор конечной точки очереди служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, идентифицирующее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не обязательно должно совпадать с фактическим именем очереди. | строка (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки очереди служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки очереди служебной шины. | строка |
RoutingServiceBusTopicEndpointProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке раздела служебной шины | IdentityBased "keyBased" |
| connectionString | Строка подключения конечной точки раздела служебной шины. | строка |
| endpointUri | URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// | строка |
| entityPath | Имя очереди в разделе служебной шины | строка |
| идентификатор | Идентификатор конечной точки раздела служебной шины | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. | ManagedIdentity |
| name | Имя, идентифицирующее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. Имя не обязательно должно совпадать с фактическим именем раздела. | строка (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов конечной точки раздела служебной шины. | строка |
| subscriptionId | Идентификатор подписки конечной точки раздела служебной шины. | строка |
RoutingStorageContainerProperties
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Метод, используемый для проверки подлинности в конечной точке хранилища | IdentityBased "keyBased" |
| batchFrequencyInSeconds | Интервал времени, с которым большие двоичные объекты записываются в хранилище. Значение должно находиться в диапазоне от 60 до 720 секунд. Значение по умолчанию — 300 секунд. | INT Ограничения: Минимальное значение = 60 Максимальное значение = 720 |
| connectionString | Строка подключения учетной записи хранения. | строка |
| containerName | Имя контейнера хранилища в учетной записи хранения. | строка (обязательно) |
| encoding | Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. | "Avro" AvroDeflate "JSON" |
| endpointUri | URL-адрес конечной точки хранилища. Он должен включать протокол https:// |
строка |
| fileNameFormat | Формат имени файла для большого двоичного объекта. Формат по умолчанию : {iothub}/{partition}/{ГГГГ}/{ММ}/{ДД}/{HH}/{mm}. Все параметры являются обязательными, но их можно изменить. | строка |
| идентификатор | Идентификатор конечной точки контейнера хранилища | строка |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища маршрутизации. | ManagedIdentity |
| maxChunkSizeInBytes | Максимальное число байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно находиться в диапазоне от 10485760 (10 МБ) до 524288000 (500 МБ). Значение по умолчанию — 314572800 (300 МБ). | INT Ограничения: Минимальное значение = 10485760 Максимальное значение = 524288000 |
| name | Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символа. Зарезервированы следующие имена: events, fileNotifications $default. Имена конечных точек должны быть уникальными для разных типов конечных точек. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Имя группы ресурсов учетной записи хранения. | строка |
| subscriptionId | Идентификатор подписки учетной записи хранения. | строка |
ОбогащениеСвойства
| Имя | Описание | Значение |
|---|---|---|
| endpointNames | Список конечных точек, для которых обогащение применяется к сообщению. | string[] (обязательно) Ограничения: Минимальная длина = 1 |
| ключ | Ключ или имя свойства обогащения. | string (обязательно) |
| значение | Значение свойства обогащения. | string (обязательно) |
FallbackRouteProperties
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, по умолчанию будет установлено значение true. Сведения о грамматике см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только 1 конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания того, включен ли резервный маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальной длиной 64 символа и должно быть уникальным. | строка |
| source | Источник, к которому применяется правило маршрутизации. Например, DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" "TwinChangeEvents" (обязательно) |
Свойства route
| Имя | Описание | Значение |
|---|---|---|
| condition | Условие, которое вычисляется для применения правила маршрутизации. Если условие не указано, оно по умолчанию принимает значение true. Сведения о грамматике см. в разделе /azure/iot-hub/iot-hub-devguide-query-language. | строка |
| endpointNames | Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. | string[] (обязательно) Ограничения: Минимальная длина = 1 Максимальная длина = 1 |
| isEnabled | Используется для указания того, включен ли маршрут. | bool (обязательно) |
| name | Имя маршрута. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальной длиной 64 символа и должно быть уникальным. | string (обязательно) Ограничения: Шаблон = ^[A-Za-z0-9-._]{1,64}$ |
| source | Источник, к которому будет применяться правило маршрутизации, например DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents DeviceLifecycleEvents DeviceMessages "Недопустимый" "TwinChangeEvents" (обязательно) |
IotHubPropertiesStorageEndpoints
| Имя | Описание | Значение |
|---|---|---|
| {настраиваемое свойство} | Свойства StorageEndpoint |
Свойства StorageEndpoint
| Имя | Описание | Значение |
|---|---|---|
| authenticationType | Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения. | "identityBased" "keyBased" |
| connectionString | Строка подключения для учетной записи хранения Azure, в которую отправляются файлы. | string (обязательно) |
| containerName | Имя корневого контейнера, в который отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанного параметра connectionString. | string (обязательно) |
| удостоверение | Свойства управляемого удостоверения конечной точки хранилища для отправки файлов. | ManagedIdentity |
| sasTtlAsIso8601 | Период времени, в течение которого URI SAS, созданный Центр Интернета вещей для отправки файлов, действителен. См. раздел /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | строка |
IotHubSkuInfo
| Имя | Описание | Значение |
|---|---|---|
| Емкость | Количество подготовленных Центр Интернета вещей единиц. См. раздел /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Имя номера SKU. | "B1" "B2" "B3" F1 "S1" "S2" "S3" (обязательно) |