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


Microsoft.Devices IotHubs 2025-08-01-preview

Определение ресурсов Bicep

Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Devices/IotHubs@2025-08-01-preview' = {
  scope: resourceSymbolicName or scope
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    deviceRegistry: {
      identityResourceId: 'string'
      namespaceResourceId: 'string'
    }
    deviceStreams: {
      streamingEndpoints: [
        'string'
      ]
    }
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    encryption: {
      keySource: 'string'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyIdentifier: 'string'
        }
      ]
    }
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    ipVersion: 'string'
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    rootCertificate: {
      enableRootCertificateV2: 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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.Devices/IotHubs

Имя Description Ценность
ETag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
identity Управляемые удостоверения для IotHub. АрмИдентиденция
location Расположение ресурса. строка (обязательно)
имя имя ресурса. строка (обязательно)
properties Свойства IotHub Свойства IotHubProperties
scope Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.
sku Сведения об SKU IotHub IotHubSkuInfo (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

АрмИдентиденция

Имя Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Словарь <ArmUserIdentity> ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Имя Description Ценность

Идентификация пользователя ArmUserIdentity

Имя Description Ценность

Свойства CloudToDeviceProperties

Имя Description Ценность
defaultTtlAsIso8601 Время ожидания по умолчанию для сообщений из облака в очередь устройств. См. статью /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

Реестр устройств

Имя Description Ценность
identityResourceId Удостоверение, используемое для управления пространством имен ADR из плоскости данных. струна
namespaceResourceId Идентификатор пространства имен Реестра устройств Azure, связанного с концентратором SKU 2-го поколения. струна

EncryptionPropertiesОписание

Имя Description Ценность
Источник ключа Источник ключа. струна
keyVaultProperties Свойства ключа KeyVault. KeyVaultKeyProperties[]

ОбогащениеProperties

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

EventHubProperties

Имя Description Ценность
Количество разделов Количество секций для получения сообщений, совместимых с устройством в облаке, в конечной точке, совместимой с Концентратором событий. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. инт
retentionTimeInDays Время хранения сообщений в облако в днях. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages инт

FallbackRouteProperties (Свойства резервного маршрута)

Имя Description Ценность
condition Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, оно будет иметь значение true по умолчанию. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, на которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешено только 1 конечная точка. string[] (обязательно)
isEnabled Используется для указания включения резервного маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. струна
source Источник, к которому применяется правило маршрутизации. Например, DeviceMessages DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

Обратная связьСвойства

Имя Description Ценность
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
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. струна

Свойства IotHubProperties

Имя Description Ценность
allowedFqdnList Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Iot. строка[]
authorizationPolicies Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. Правило авторизации SharedAccessSignature[]
cloudToDevice Свойства обмена сообщениями центра Интернета вещей между устройствами. Свойства CloudToDeviceProperties
comments Комментарии центра Интернета вещей. струна
deviceRegistry Представляет свойства, связанные с реестром устройств Azure (ADR). DeviceRegistry (DeviceRegistry)
deviceStreams Устройства передают свойства iothub. IotHubPropertiesDeviceStreams
disableDeviceSAS Если значение true, все устройства (включая пограничные устройства, кроме модулей), ограниченные ключи SAS нельзя использовать для проверки подлинности. bool
disableLocalAuth Если значение true, маркеры SAS с ключами SAS с областью действия центра Iot нельзя использовать для проверки подлинности. bool
disableModuleSAS Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS с областью действия модуля. bool
enableDataResidency Это свойство, если задано значение true, позволит включить размещение данных, таким образом, отключив аварийное восстановление. bool
enableFileUploadNotifications Если задано значение True, уведомления о отправке файлов включены. bool
encryption Свойства шифрования центра Интернета вещей. EncryptionPropertiesОписание
Точки входа Event Hub Свойства конечной точки, совместимой с Концентратором событий. Единственными возможными ключами этого словаря являются события. Этот ключ должен присутствовать в словаре при создании или обновлении вызовов центра Интернета вещей. IotHubPropertiesEventHubEndpoints
features Возможности и функции, включенные для Центра Интернета вещей. DeviceManagement
"Нет"
ipFilterRules Правила фильтрации IP-адресов. Правило IpFilter[]
ipVersion Это свойство указывает IP-версию, используемую концентратором в настоящее время. "ipv4"
Ipv4ipv6
Ipv6
Конечные точки messagingEndpoints Свойства конечной точки обмена сообщениями для очереди уведомлений о отправке файла. IotHubPropertiesMessagingEndpoints
minTlsVersion Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. струна
networkRuleSets Свойства набора правил сети IotHub NetworkRuleSetProperties
privateEndpointConnections Подключения к частной конечной точке, созданные на этом IotHub PrivateEndpointConnection[]
доступ к публичной сети Разрешены ли запросы из общедоступной сети 'Disabled'
"Включено"
restrictOutboundNetworkAccess Если значение true, исходящие данные из IotHub будут ограничены только разрешенными полными доменными именами, настроенными с помощью allowFqdnList. bool
Сертификат rootCertificate Это свойство хранит сведения о корневом сертификате, связанном с Свойства корневого сертификата
маршрутизация Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging МаршрутизацияProperties
storageEndpoints Список конечных точек службы хранилища Azure, где можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure и ее ключ как $default. Указание нескольких учетных записей хранения приводит к возникновению ошибки. Не указывая значение этого свойства, если для свойства enableFileUploadNotifications задано значение True, возникает ошибка. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Имя Description Ценность
streamingEndpoints Список конечных точек потоков устройств. строка[]

IotHubPropertiesEventHubEndpoints

Имя Description Ценность

IotHubPropertiesMessagingEndpoints

Имя Description Ценность

IotHubPropertiesStorageEndpoints

Имя Description Ценность

IotHubSkuInfo

Имя Description Ценность
capacity Количество подготовленных единиц Центра Интернета вещей. См. статью /azure/azure-subscription-service-limits#iot-hub-limits. инт
имя Имя номера SKU. "B1"
"B2"
"B3"
"F1"
«ПОКОЛЕНИЕ2»
«С1»
'S2'
"S3" (обязательно)

Правило IpFilterRule

Имя Description Ценность
действие Требуемое действие для запросов, захваченных этим правилом. "Принять"
"Отклонить" (обязательно)
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

KeyVaultKeyProperties

Имя Description Ценность
identity Свойства управляемого удостоверения ключа KeyVault. ManagedIdentity
keyIdentifier Идентификатор ключа. струна

Управляемая идентификация

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

Свойства конечной точки обмена сообщениями

Имя Description Ценность
lockDurationAsIso8601 Длительность блокировки. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна
maxDeliveryCount Количество попыток доставки сообщения в Центре Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 100
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна

Сетевая нормаSetIpRule (Сетевая норма)

Имя Description Ценность
действие Действие ФИЛЬТРА IP "Разрешить"
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

NetworkRuleSetProperties

Имя Description Ценность
applyToBuiltInEventHubEndpoint Если значение true, то набор правил сети также применяется к Встроенной точке событий EventHub iotHub bool (обязательно)
defaultAction Действие по умолчанию для набора правил сети "Разрешить"
"Запретить"
ipRules Список правил IP-адресов NetworkRuleSetIpRule[] (обязательно)

PrivateEndpoint

Имя Description Ценность

PrivateEndpointConnection

Имя Description Ценность
properties Свойства подключения частной конечной точки PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Description Ценность
privateEndpoint Свойство частной конечной точки подключения частной конечной точки PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateLinkServiceConnectionState

Имя Description Ценность
действияОбязательные Действия, необходимые для подключения частной конечной точки струна
описание Описание текущего состояния подключения частной конечной точки строка (обязательно)
статус Состояние подключения частной конечной точки "Утверждено"
'Disconnected'
"Ожидание"
"Отклонено" (обязательно)

Теги ресурса

Имя Description Ценность

Свойства корневого сертификата

Имя Description Ценность
enableRootCertificateV2 Это свойство при значении true концентратор будет использовать сертификат G2; хотя для него задано значение false, концентратор использует Baltimore Cert. bool

Свойства маршрута

Имя Description Ценность
condition Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию оценивается как true. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. string[] (обязательно)
isEnabled Используется для указания включения маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
source Источник, к которому применяется правило маршрутизации, например DeviceMessages. DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

RoutingCosmosDBSqlApiProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке контейнера sql Cosmos DB IdentityBased
KeyBased
containerName Имя контейнера sql cosmos DB в базе данных Cosmos DB. строка (обязательно)
databaseName Имя базы данных Cosmos DB в учетной записи Cosmos DB. строка (обязательно)
endpointUri URL-адрес учетной записи Cosmos DB. Он должен включать протокол https:// строка (обязательно)
identity Свойства управляемого удостоверения для конечной точки контейнера Cosmos DB. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
имяКлючаРаздела Имя ключа секции, связанного с этим контейнером SQL Cosmos DB, если он существует. Этот параметр является необязательным. струна
ШаблонКлючаРаздела Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан по крайней мере один раз, но порядок и компоненты, не являющиеся заполнителями, являются произвольными. Этот параметр требуется только в том случае, если задано имя PartitionKeyName. струна
первичный ключ Первичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
resourceGroup Имя группы ресурсов учетной записи Cosmos DB. струна
вторичный ключ Вторичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
subscriptionId Идентификатор подписки учетной записи Cosmos DB. струна

МаршрутизацияEndpoints

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

МаршрутизацияEventHubProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке концентратора событий IdentityBased
KeyBased
connectionString Строка подключения конечной точки концентратора событий. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// струна
entityPath Имя концентратора событий в пространстве имен концентратора событий струна
id Идентификатор конечной точки концентратора событий струна
identity Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки концентратора событий. струна
subscriptionId Идентификатор подписки конечной точки концентратора событий. струна

МаршрутизацияProperties

Имя Description Ценность
конечные точки Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка. МаршрутизацияEndpoints
обогащения Список предоставленных пользователем обогащений, которые центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См.: https://aka.ms/telemetryoneventgrid Обогащение[]
резервный каналRoute Свойства маршрута, который используется в качестве резервного маршрута, если ни одно из условий, указанных в разделе "маршруты", не выполняется. Этот параметр является необязательным. Если это свойство не задано, сообщения, которые не соответствуют каким-либо условиям, указанным в разделе "маршруты", направляются в встроенную конечную точку eventhub. FallbackRouteProperties (Свойства резервного маршрута)
routes Список правил маршрутизации, предоставляемых пользователем, которые центр Интернета вещей использует для маршрутизации сообщений в встроенные и пользовательские конечные точки. Для платных центров разрешено не более 100 правил маршрутизации, а для бесплатных центров разрешено не более 5 правил маршрутизации. Свойства маршрута[]

Свойства конечной точки RoutingServiceBusQueue

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке очереди служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки очереди служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в пространстве имен служебной шины струна
id Идентификатор конечной точки очереди служебной шины струна
identity Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем очереди. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки очереди служебной шины. струна
subscriptionId Идентификатор подписки конечной точки очереди служебной шины. струна

RoutingServiceBusTopicEndpointProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке раздела служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки раздела служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в разделе служебной шины струна
id Идентификатор конечной точки раздела служебной шины струна
identity Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем раздела. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки раздела служебной шины. струна
subscriptionId Идентификатор подписки конечной точки раздела служебной шины. струна

МаршрутизацияStorageContainerProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке хранилища IdentityBased
KeyBased
частотаПакетовВСекундах Интервал времени записи больших двоичных объектов в хранилище. Значение должно составлять от 60 до 720 секунд. Значение по умолчанию — 300 секунд. int

Ограничения целостности:
Минимальное значение = 60
Максимальное значение = 720
connectionString Строка подключения учетной записи хранения. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
containerName Имя контейнера хранилища в учетной записи хранения. строка (обязательно)
encoding Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. 'Avro'
'AvroDeflate'
JSON
endpointUri URL-адрес конечной точки хранилища. Он должен включать протокол https:// струна
fileNameFormat Формат имени файла для большого двоичного объекта. Формат по умолчанию — {iothub}/{partition}/{ГГГГ}/{MM}/{DD}/{HH}/{mm}. Все параметры являются обязательными, но могут быть переупорядочены. струна
id Идентификатор конечной точки контейнера хранилища струна
identity Свойства управляемого удостоверения конечной точки хранилища маршрутизации. ManagedIdentity
maxChunkSizeInBytes (максимальный размер блока в байтах) Максимальное количество байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно быть между 10485760(10 МБ) и 524288000(500 МБ). Значение по умолчанию — 314572800(300 МБ). int

Ограничения целостности:
Минимальное значение = 10485760
Максимальное значение = 524288000
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов учетной записи хранения. струна
subscriptionId Идентификатор подписки учетной записи хранения. струна

Правило авторизации SharedAccessSignature

Имя Description Ценность
keyName Имя политики общего доступа. строка (обязательно)
первичный ключ Первичный ключ. струна
права Разрешения, назначенные политике общего доступа. 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 (обязательно)
вторичный ключ Вторичный ключ. струна

Свойства StorageEndpoint

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

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Description
Создание Центра Интернета вещей и устройства для облачной группы потребителей Этот шаблон позволяет развернуть экземпляр Центра Интернета вещей с устройством в облаке и облаке в конфигурации обмена сообщениями устройств и устройством в облачной группе потребителей.
создание службы подготовки устройств Центра Интернета вещей Этот шаблон позволяет создать центр Интернета вещей и службу подготовки устройств Центра Интернета вещей и связать две службы.
создание учетной записи Центра Интернета вещей, экземпляра, центра Интернета вещей Этот шаблон создает учетную запись и экземпляр и концентратор для связывания экземпляра. Он настраивает концентратор с необходимыми политиками доступа, маршрутами и группой потребителей.
Развертывание службы MedTech, включая Центра Интернета вещей Azure Служба MedTech — это одна из служб azure Health Data Services, предназначенных для приема данных устройства с нескольких устройств, преобразования данных устройства в наблюдения FHIR, которые затем сохраняются в службе FHIR служб данных Azure Health.
Использование шаблона ARM для создания Центра Интернета вещей, маршрутизации и просмотра сообщений Используйте этот шаблон для развертывания Центра Интернета вещей и учетной записи хранения. Запустите приложение для отправки сообщений в концентратор, который направляется в хранилище, а затем просмотрите результаты.

Определение ресурса шаблона ARM

Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2025-08-01-preview",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "deviceRegistry": {
      "identityResourceId": "string",
      "namespaceResourceId": "string"
    },
    "deviceStreams": {
      "streamingEndpoints": [ "string" ]
    },
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyIdentifier": "string"
        }
      ]
    },
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "ipVersion": "string",
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "rootCertificate": {
      "enableRootCertificateV2": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.Devices/IotHubs

Имя Description Ценность
apiVersion Версия API «2025-08-01-превью»
ETag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
identity Управляемые удостоверения для IotHub. АрмИдентиденция
location Расположение ресурса. строка (обязательно)
имя имя ресурса. строка (обязательно)
properties Свойства IotHub Свойства IotHubProperties
sku Сведения об SKU IotHub IotHubSkuInfo (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса 'Microsoft.Devices/IotHubs'

АрмИдентиденция

Имя Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Словарь <ArmUserIdentity> ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Имя Description Ценность

Идентификация пользователя ArmUserIdentity

Имя Description Ценность

Свойства CloudToDeviceProperties

Имя Description Ценность
defaultTtlAsIso8601 Время ожидания по умолчанию для сообщений из облака в очередь устройств. См. статью /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

Реестр устройств

Имя Description Ценность
identityResourceId Удостоверение, используемое для управления пространством имен ADR из плоскости данных. струна
namespaceResourceId Идентификатор пространства имен Реестра устройств Azure, связанного с концентратором SKU 2-го поколения. струна

EncryptionPropertiesОписание

Имя Description Ценность
Источник ключа Источник ключа. струна
keyVaultProperties Свойства ключа KeyVault. KeyVaultKeyProperties[]

ОбогащениеProperties

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

EventHubProperties

Имя Description Ценность
Количество разделов Количество секций для получения сообщений, совместимых с устройством в облаке, в конечной точке, совместимой с Концентратором событий. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. инт
retentionTimeInDays Время хранения сообщений в облако в днях. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages инт

FallbackRouteProperties (Свойства резервного маршрута)

Имя Description Ценность
condition Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, оно будет иметь значение true по умолчанию. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, на которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешено только 1 конечная точка. string[] (обязательно)
isEnabled Используется для указания включения резервного маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. струна
source Источник, к которому применяется правило маршрутизации. Например, DeviceMessages DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

Обратная связьСвойства

Имя Description Ценность
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
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. струна

Свойства IotHubProperties

Имя Description Ценность
allowedFqdnList Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Iot. строка[]
authorizationPolicies Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. Правило авторизации SharedAccessSignature[]
cloudToDevice Свойства обмена сообщениями центра Интернета вещей между устройствами. Свойства CloudToDeviceProperties
comments Комментарии центра Интернета вещей. струна
deviceRegistry Представляет свойства, связанные с реестром устройств Azure (ADR). DeviceRegistry (DeviceRegistry)
deviceStreams Устройства передают свойства iothub. IotHubPropertiesDeviceStreams
disableDeviceSAS Если значение true, все устройства (включая пограничные устройства, кроме модулей), ограниченные ключи SAS нельзя использовать для проверки подлинности. bool
disableLocalAuth Если значение true, маркеры SAS с ключами SAS с областью действия центра Iot нельзя использовать для проверки подлинности. bool
disableModuleSAS Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS с областью действия модуля. bool
enableDataResidency Это свойство, если задано значение true, позволит включить размещение данных, таким образом, отключив аварийное восстановление. bool
enableFileUploadNotifications Если задано значение True, уведомления о отправке файлов включены. bool
encryption Свойства шифрования центра Интернета вещей. EncryptionPropertiesОписание
Точки входа Event Hub Свойства конечной точки, совместимой с Концентратором событий. Единственными возможными ключами этого словаря являются события. Этот ключ должен присутствовать в словаре при создании или обновлении вызовов центра Интернета вещей. IotHubPropertiesEventHubEndpoints
features Возможности и функции, включенные для Центра Интернета вещей. DeviceManagement
"Нет"
ipFilterRules Правила фильтрации IP-адресов. Правило IpFilter[]
ipVersion Это свойство указывает IP-версию, используемую концентратором в настоящее время. "ipv4"
Ipv4ipv6
Ipv6
Конечные точки messagingEndpoints Свойства конечной точки обмена сообщениями для очереди уведомлений о отправке файла. IotHubPropertiesMessagingEndpoints
minTlsVersion Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. струна
networkRuleSets Свойства набора правил сети IotHub NetworkRuleSetProperties
privateEndpointConnections Подключения к частной конечной точке, созданные на этом IotHub PrivateEndpointConnection[]
доступ к публичной сети Разрешены ли запросы из общедоступной сети 'Disabled'
"Включено"
restrictOutboundNetworkAccess Если значение true, исходящие данные из IotHub будут ограничены только разрешенными полными доменными именами, настроенными с помощью allowFqdnList. bool
Сертификат rootCertificate Это свойство хранит сведения о корневом сертификате, связанном с Свойства корневого сертификата
маршрутизация Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging МаршрутизацияProperties
storageEndpoints Список конечных точек службы хранилища Azure, где можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure и ее ключ как $default. Указание нескольких учетных записей хранения приводит к возникновению ошибки. Не указывая значение этого свойства, если для свойства enableFileUploadNotifications задано значение True, возникает ошибка. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Имя Description Ценность
streamingEndpoints Список конечных точек потоков устройств. строка[]

IotHubPropertiesEventHubEndpoints

Имя Description Ценность

IotHubPropertiesMessagingEndpoints

Имя Description Ценность

IotHubPropertiesStorageEndpoints

Имя Description Ценность

IotHubSkuInfo

Имя Description Ценность
capacity Количество подготовленных единиц Центра Интернета вещей. См. статью /azure/azure-subscription-service-limits#iot-hub-limits. инт
имя Имя номера SKU. "B1"
"B2"
"B3"
"F1"
«ПОКОЛЕНИЕ2»
«С1»
'S2'
"S3" (обязательно)

Правило IpFilterRule

Имя Description Ценность
действие Требуемое действие для запросов, захваченных этим правилом. "Принять"
"Отклонить" (обязательно)
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

KeyVaultKeyProperties

Имя Description Ценность
identity Свойства управляемого удостоверения ключа KeyVault. ManagedIdentity
keyIdentifier Идентификатор ключа. струна

Управляемая идентификация

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

Свойства конечной точки обмена сообщениями

Имя Description Ценность
lockDurationAsIso8601 Длительность блокировки. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна
maxDeliveryCount Количество попыток доставки сообщения в Центре Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 100
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна

Сетевая нормаSetIpRule (Сетевая норма)

Имя Description Ценность
действие Действие ФИЛЬТРА IP "Разрешить"
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

NetworkRuleSetProperties

Имя Description Ценность
applyToBuiltInEventHubEndpoint Если значение true, то набор правил сети также применяется к Встроенной точке событий EventHub iotHub bool (обязательно)
defaultAction Действие по умолчанию для набора правил сети "Разрешить"
"Запретить"
ipRules Список правил IP-адресов NetworkRuleSetIpRule[] (обязательно)

PrivateEndpoint

Имя Description Ценность

PrivateEndpointConnection

Имя Description Ценность
properties Свойства подключения частной конечной точки PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Description Ценность
privateEndpoint Свойство частной конечной точки подключения частной конечной точки PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateLinkServiceConnectionState

Имя Description Ценность
действияОбязательные Действия, необходимые для подключения частной конечной точки струна
описание Описание текущего состояния подключения частной конечной точки строка (обязательно)
статус Состояние подключения частной конечной точки "Утверждено"
'Disconnected'
"Ожидание"
"Отклонено" (обязательно)

Теги ресурса

Имя Description Ценность

Свойства корневого сертификата

Имя Description Ценность
enableRootCertificateV2 Это свойство при значении true концентратор будет использовать сертификат G2; хотя для него задано значение false, концентратор использует Baltimore Cert. bool

Свойства маршрута

Имя Description Ценность
condition Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию оценивается как true. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. string[] (обязательно)
isEnabled Используется для указания включения маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
source Источник, к которому применяется правило маршрутизации, например DeviceMessages. DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

RoutingCosmosDBSqlApiProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке контейнера sql Cosmos DB IdentityBased
KeyBased
containerName Имя контейнера sql cosmos DB в базе данных Cosmos DB. строка (обязательно)
databaseName Имя базы данных Cosmos DB в учетной записи Cosmos DB. строка (обязательно)
endpointUri URL-адрес учетной записи Cosmos DB. Он должен включать протокол https:// строка (обязательно)
identity Свойства управляемого удостоверения для конечной точки контейнера Cosmos DB. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
имяКлючаРаздела Имя ключа секции, связанного с этим контейнером SQL Cosmos DB, если он существует. Этот параметр является необязательным. струна
ШаблонКлючаРаздела Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан по крайней мере один раз, но порядок и компоненты, не являющиеся заполнителями, являются произвольными. Этот параметр требуется только в том случае, если задано имя PartitionKeyName. струна
первичный ключ Первичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
resourceGroup Имя группы ресурсов учетной записи Cosmos DB. струна
вторичный ключ Вторичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
subscriptionId Идентификатор подписки учетной записи Cosmos DB. струна

МаршрутизацияEndpoints

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

МаршрутизацияEventHubProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке концентратора событий IdentityBased
KeyBased
connectionString Строка подключения конечной точки концентратора событий. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// струна
entityPath Имя концентратора событий в пространстве имен концентратора событий струна
id Идентификатор конечной точки концентратора событий струна
identity Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки концентратора событий. струна
subscriptionId Идентификатор подписки конечной точки концентратора событий. струна

МаршрутизацияProperties

Имя Description Ценность
конечные точки Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка. МаршрутизацияEndpoints
обогащения Список предоставленных пользователем обогащений, которые центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См.: https://aka.ms/telemetryoneventgrid Обогащение[]
резервный каналRoute Свойства маршрута, который используется в качестве резервного маршрута, если ни одно из условий, указанных в разделе "маршруты", не выполняется. Этот параметр является необязательным. Если это свойство не задано, сообщения, которые не соответствуют каким-либо условиям, указанным в разделе "маршруты", направляются в встроенную конечную точку eventhub. FallbackRouteProperties (Свойства резервного маршрута)
routes Список правил маршрутизации, предоставляемых пользователем, которые центр Интернета вещей использует для маршрутизации сообщений в встроенные и пользовательские конечные точки. Для платных центров разрешено не более 100 правил маршрутизации, а для бесплатных центров разрешено не более 5 правил маршрутизации. Свойства маршрута[]

Свойства конечной точки RoutingServiceBusQueue

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке очереди служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки очереди служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в пространстве имен служебной шины струна
id Идентификатор конечной точки очереди служебной шины струна
identity Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем очереди. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки очереди служебной шины. струна
subscriptionId Идентификатор подписки конечной точки очереди служебной шины. струна

RoutingServiceBusTopicEndpointProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке раздела служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки раздела служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в разделе служебной шины струна
id Идентификатор конечной точки раздела служебной шины струна
identity Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем раздела. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки раздела служебной шины. струна
subscriptionId Идентификатор подписки конечной точки раздела служебной шины. струна

МаршрутизацияStorageContainerProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке хранилища IdentityBased
KeyBased
частотаПакетовВСекундах Интервал времени записи больших двоичных объектов в хранилище. Значение должно составлять от 60 до 720 секунд. Значение по умолчанию — 300 секунд. int

Ограничения целостности:
Минимальное значение = 60
Максимальное значение = 720
connectionString Строка подключения учетной записи хранения. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
containerName Имя контейнера хранилища в учетной записи хранения. строка (обязательно)
encoding Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. 'Avro'
'AvroDeflate'
JSON
endpointUri URL-адрес конечной точки хранилища. Он должен включать протокол https:// струна
fileNameFormat Формат имени файла для большого двоичного объекта. Формат по умолчанию — {iothub}/{partition}/{ГГГГ}/{MM}/{DD}/{HH}/{mm}. Все параметры являются обязательными, но могут быть переупорядочены. струна
id Идентификатор конечной точки контейнера хранилища струна
identity Свойства управляемого удостоверения конечной точки хранилища маршрутизации. ManagedIdentity
maxChunkSizeInBytes (максимальный размер блока в байтах) Максимальное количество байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно быть между 10485760(10 МБ) и 524288000(500 МБ). Значение по умолчанию — 314572800(300 МБ). int

Ограничения целостности:
Минимальное значение = 10485760
Максимальное значение = 524288000
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов учетной записи хранения. струна
subscriptionId Идентификатор подписки учетной записи хранения. струна

Правило авторизации SharedAccessSignature

Имя Description Ценность
keyName Имя политики общего доступа. строка (обязательно)
первичный ключ Первичный ключ. струна
права Разрешения, назначенные политике общего доступа. 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 (обязательно)
вторичный ключ Вторичный ключ. струна

Свойства StorageEndpoint

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

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Template Description
создать среду pay as you go (PAYG) с помощью центра Интернета вещей

Развертывание в Azure
Этот шаблон позволяет развернуть среду аналитики временных рядов с оплатой по мере использования (PAYG), настроенную для использования событий из Центра Интернета вещей.
Создание Центра Интернета вещей и устройства для облачной группы потребителей

Развертывание в Azure
Этот шаблон позволяет развернуть экземпляр Центра Интернета вещей с устройством в облаке и облаке в конфигурации обмена сообщениями устройств и устройством в облачной группе потребителей.
Создание симулятора IOT Hub и Ubuntu edge

Развертывание в Azure
Этот шаблон создает симулятор IOT Hub и Виртуальной машины Ubuntu edge.
создание службы подготовки устройств Центра Интернета вещей

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

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

Развертывание в Azure
Служба MedTech — это одна из служб azure Health Data Services, предназначенных для приема данных устройства с нескольких устройств, преобразования данных устройства в наблюдения FHIR, которые затем сохраняются в службе FHIR служб данных Azure Health.
Использование шаблона ARM для создания Центра Интернета вещей, маршрутизации и просмотра сообщений

Развертывание в Azure
Используйте этот шаблон для развертывания Центра Интернета вещей и учетной записи хранения. Запустите приложение для отправки сообщений в концентратор, который направляется в хранилище, а затем просмотрите результаты.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса IotHubs можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Devices/IotHubs, добавьте следующий terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2025-08-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      deviceRegistry = {
        identityResourceId = "string"
        namespaceResourceId = "string"
      }
      deviceStreams = {
        streamingEndpoints = [
          "string"
        ]
      }
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      encryption = {
        keySource = "string"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyIdentifier = "string"
          }
        ]
      }
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      ipVersion = "string"
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      rootCertificate = {
        enableRootCertificateV2 = 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"
    }
  }
}

Значения свойств

Microsoft.Devices/IotHubs

Имя Description Ценность
ETag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
identity Управляемые удостоверения для IotHub. АрмИдентиденция
location Расположение ресурса. строка (обязательно)
имя имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
properties Свойства IotHub Свойства IotHubProperties
sku Сведения об SKU IotHub IotHubSkuInfo (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.Devices/IotHubs@2025-08-01-preview"

АрмИдентиденция

Имя Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Словарь <ArmUserIdentity> ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Имя Description Ценность

Идентификация пользователя ArmUserIdentity

Имя Description Ценность

Свойства CloudToDeviceProperties

Имя Description Ценность
defaultTtlAsIso8601 Время ожидания по умолчанию для сообщений из облака в очередь устройств. См. статью /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

Реестр устройств

Имя Description Ценность
identityResourceId Удостоверение, используемое для управления пространством имен ADR из плоскости данных. струна
namespaceResourceId Идентификатор пространства имен Реестра устройств Azure, связанного с концентратором SKU 2-го поколения. струна

EncryptionPropertiesОписание

Имя Description Ценность
Источник ключа Источник ключа. струна
keyVaultProperties Свойства ключа KeyVault. KeyVaultKeyProperties[]

ОбогащениеProperties

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

EventHubProperties

Имя Description Ценность
Количество разделов Количество секций для получения сообщений, совместимых с устройством в облаке, в конечной точке, совместимой с Концентратором событий. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. инт
retentionTimeInDays Время хранения сообщений в облако в днях. См. статью /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages инт

FallbackRouteProperties (Свойства резервного маршрута)

Имя Description Ценность
condition Условие, которое вычисляется для применения резервного маршрута. Если условие не указано, оно будет иметь значение true по умолчанию. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, на которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешено только 1 конечная точка. string[] (обязательно)
isEnabled Используется для указания включения резервного маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. струна
source Источник, к которому применяется правило маршрутизации. Например, DeviceMessages DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

Обратная связьСвойства

Имя Description Ценность
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
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. струна

Свойства IotHubProperties

Имя Description Ценность
allowedFqdnList Список разрешенных полных доменных имен (полное доменное имя) для исходящего трафика из Центра Iot. строка[]
authorizationPolicies Политики общего доступа, которые можно использовать для защиты подключения к Центру Интернета вещей. Правило авторизации SharedAccessSignature[]
cloudToDevice Свойства обмена сообщениями центра Интернета вещей между устройствами. Свойства CloudToDeviceProperties
comments Комментарии центра Интернета вещей. струна
deviceRegistry Представляет свойства, связанные с реестром устройств Azure (ADR). DeviceRegistry (DeviceRegistry)
deviceStreams Устройства передают свойства iothub. IotHubPropertiesDeviceStreams
disableDeviceSAS Если значение true, все устройства (включая пограничные устройства, кроме модулей), ограниченные ключи SAS нельзя использовать для проверки подлинности. bool
disableLocalAuth Если значение true, маркеры SAS с ключами SAS с областью действия центра Iot нельзя использовать для проверки подлинности. bool
disableModuleSAS Если задано значение true, для проверки подлинности нельзя использовать все ключи SAS с областью действия модуля. bool
enableDataResidency Это свойство, если задано значение true, позволит включить размещение данных, таким образом, отключив аварийное восстановление. bool
enableFileUploadNotifications Если задано значение True, уведомления о отправке файлов включены. bool
encryption Свойства шифрования центра Интернета вещей. EncryptionPropertiesОписание
Точки входа Event Hub Свойства конечной точки, совместимой с Концентратором событий. Единственными возможными ключами этого словаря являются события. Этот ключ должен присутствовать в словаре при создании или обновлении вызовов центра Интернета вещей. IotHubPropertiesEventHubEndpoints
features Возможности и функции, включенные для Центра Интернета вещей. DeviceManagement
"Нет"
ipFilterRules Правила фильтрации IP-адресов. Правило IpFilter[]
ipVersion Это свойство указывает IP-версию, используемую концентратором в настоящее время. "ipv4"
Ipv4ipv6
Ipv6
Конечные точки messagingEndpoints Свойства конечной точки обмена сообщениями для очереди уведомлений о отправке файла. IotHubPropertiesMessagingEndpoints
minTlsVersion Указывает минимальную версию TLS для поддержки этого концентратора. Можно задать значение "1.2", чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись. струна
networkRuleSets Свойства набора правил сети IotHub NetworkRuleSetProperties
privateEndpointConnections Подключения к частной конечной точке, созданные на этом IotHub PrivateEndpointConnection[]
доступ к публичной сети Разрешены ли запросы из общедоступной сети 'Disabled'
"Включено"
restrictOutboundNetworkAccess Если значение true, исходящие данные из IotHub будут ограничены только разрешенными полными доменными именами, настроенными с помощью allowFqdnList. bool
Сертификат rootCertificate Это свойство хранит сведения о корневом сертификате, связанном с Свойства корневого сертификата
маршрутизация Связанные с маршрутизацией свойства Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-messaging МаршрутизацияProperties
storageEndpoints Список конечных точек службы хранилища Azure, где можно отправлять файлы. В настоящее время можно настроить только одну учетную запись хранения Azure и ее ключ как $default. Указание нескольких учетных записей хранения приводит к возникновению ошибки. Не указывая значение этого свойства, если для свойства enableFileUploadNotifications задано значение True, возникает ошибка. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Имя Description Ценность
streamingEndpoints Список конечных точек потоков устройств. строка[]

IotHubPropertiesEventHubEndpoints

Имя Description Ценность

IotHubPropertiesMessagingEndpoints

Имя Description Ценность

IotHubPropertiesStorageEndpoints

Имя Description Ценность

IotHubSkuInfo

Имя Description Ценность
capacity Количество подготовленных единиц Центра Интернета вещей. См. статью /azure/azure-subscription-service-limits#iot-hub-limits. инт
имя Имя номера SKU. "B1"
"B2"
"B3"
"F1"
«ПОКОЛЕНИЕ2»
«С1»
'S2'
"S3" (обязательно)

Правило IpFilterRule

Имя Description Ценность
действие Требуемое действие для запросов, захваченных этим правилом. "Принять"
"Отклонить" (обязательно)
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

KeyVaultKeyProperties

Имя Description Ценность
identity Свойства управляемого удостоверения ключа KeyVault. ManagedIdentity
keyIdentifier Идентификатор ключа. струна

Управляемая идентификация

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

Свойства конечной точки обмена сообщениями

Имя Description Ценность
lockDurationAsIso8601 Длительность блокировки. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна
maxDeliveryCount Количество попыток доставки сообщения в Центре Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 100
ттлАсИсо8601 Период времени, в течение которого сообщение доступно для использования до истечения срока действия Центра Интернета вещей. См. статью /azure/iot-hub/iot-hub-devguide-file-upload. струна

Сетевая нормаSetIpRule (Сетевая норма)

Имя Description Ценность
действие Действие ФИЛЬТРА IP "Разрешить"
FilterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. строка (обязательно)

NetworkRuleSetProperties

Имя Description Ценность
applyToBuiltInEventHubEndpoint Если значение true, то набор правил сети также применяется к Встроенной точке событий EventHub iotHub bool (обязательно)
defaultAction Действие по умолчанию для набора правил сети "Разрешить"
"Запретить"
ipRules Список правил IP-адресов NetworkRuleSetIpRule[] (обязательно)

PrivateEndpoint

Имя Description Ценность

PrivateEndpointConnection

Имя Description Ценность
properties Свойства подключения частной конечной точки PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Description Ценность
privateEndpoint Свойство частной конечной точки подключения частной конечной точки PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateLinkServiceConnectionState

Имя Description Ценность
действияОбязательные Действия, необходимые для подключения частной конечной точки струна
описание Описание текущего состояния подключения частной конечной точки строка (обязательно)
статус Состояние подключения частной конечной точки "Утверждено"
'Disconnected'
"Ожидание"
"Отклонено" (обязательно)

Теги ресурса

Имя Description Ценность

Свойства корневого сертификата

Имя Description Ценность
enableRootCertificateV2 Это свойство при значении true концентратор будет использовать сертификат G2; хотя для него задано значение false, концентратор использует Baltimore Cert. bool

Свойства маршрута

Имя Description Ценность
condition Условие, которое оценивается для применения правила маршрутизации. Если условие не указано, оно по умолчанию оценивается как true. Сведения о грамматике см. в статье /azure/iot-hub/iot-hub-devguide-query-language струна
endpointNames Список конечных точек, в которые направляются сообщения, удовлетворяющие условию. В настоящее время разрешена только одна конечная точка. string[] (обязательно)
isEnabled Используется для указания включения маршрута. bool (обязательно)
имя Имя маршрута. Имя может включать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы, максимальную длину 64 символов и должны быть уникальными. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
source Источник, к которому применяется правило маршрутизации, например DeviceMessages. DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
«События DigitalTwinChange»
'Invalid'
"MqttBrokerMessages"
TwinChangeEvents (обязательно)

RoutingCosmosDBSqlApiProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке контейнера sql Cosmos DB IdentityBased
KeyBased
containerName Имя контейнера sql cosmos DB в базе данных Cosmos DB. строка (обязательно)
databaseName Имя базы данных Cosmos DB в учетной записи Cosmos DB. строка (обязательно)
endpointUri URL-адрес учетной записи Cosmos DB. Он должен включать протокол https:// строка (обязательно)
identity Свойства управляемого удостоверения для конечной точки контейнера Cosmos DB. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
имяКлючаРаздела Имя ключа секции, связанного с этим контейнером SQL Cosmos DB, если он существует. Этот параметр является необязательным. струна
ШаблонКлючаРаздела Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан по крайней мере один раз, но порядок и компоненты, не являющиеся заполнителями, являются произвольными. Этот параметр требуется только в том случае, если задано имя PartitionKeyName. струна
первичный ключ Первичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
resourceGroup Имя группы ресурсов учетной записи Cosmos DB. струна
вторичный ключ Вторичный ключ учетной записи Cosmos DB. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
subscriptionId Идентификатор подписки учетной записи Cosmos DB. струна

МаршрутизацияEndpoints

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

МаршрутизацияEventHubProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке концентратора событий IdentityBased
KeyBased
connectionString Строка подключения конечной точки концентратора событий. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки концентратора событий. Он должен включать протокол sb:// струна
entityPath Имя концентратора событий в пространстве имен концентратора событий струна
id Идентификатор конечной точки концентратора событий струна
identity Свойства управляемого удостоверения конечной точки концентратора событий маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки концентратора событий. струна
subscriptionId Идентификатор подписки конечной точки концентратора событий. струна

МаршрутизацияProperties

Имя Description Ценность
конечные точки Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Допускается не более 10 пользовательских конечных точек во всех типах конечных точек для платных центров, и для всех типов конечных точек для бесплатных центров разрешено только 1 пользовательская конечная точка. МаршрутизацияEndpoints
обогащения Список предоставленных пользователем обогащений, которые центр Интернета вещей применяет к сообщениям, которые будут доставлены во встроенные и пользовательские конечные точки. См.: https://aka.ms/telemetryoneventgrid Обогащение[]
резервный каналRoute Свойства маршрута, который используется в качестве резервного маршрута, если ни одно из условий, указанных в разделе "маршруты", не выполняется. Этот параметр является необязательным. Если это свойство не задано, сообщения, которые не соответствуют каким-либо условиям, указанным в разделе "маршруты", направляются в встроенную конечную точку eventhub. FallbackRouteProperties (Свойства резервного маршрута)
routes Список правил маршрутизации, предоставляемых пользователем, которые центр Интернета вещей использует для маршрутизации сообщений в встроенные и пользовательские конечные точки. Для платных центров разрешено не более 100 правил маршрутизации, а для бесплатных центров разрешено не более 5 правил маршрутизации. Свойства маршрута[]

Свойства конечной точки RoutingServiceBusQueue

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке очереди служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки очереди служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки очереди служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в пространстве имен служебной шины струна
id Идентификатор конечной точки очереди служебной шины струна
identity Свойства управляемого удостоверения конечной точки очереди служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем очереди. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки очереди служебной шины. струна
subscriptionId Идентификатор подписки конечной точки очереди служебной шины. струна

RoutingServiceBusTopicEndpointProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке раздела служебной шины IdentityBased
KeyBased
connectionString Строка подключения конечной точки раздела служебной шины. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointUri URL-адрес конечной точки раздела служебной шины. Он должен включать протокол sb:// струна
entityPath Имя очереди в разделе служебной шины струна
id Идентификатор конечной точки раздела служебной шины струна
identity Свойства управляемого удостоверения конечной точки раздела служебной шины маршрутизации. ManagedIdentity
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. Имя не должно совпадать с фактическим именем раздела. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов конечной точки раздела служебной шины. струна
subscriptionId Идентификатор подписки конечной точки раздела служебной шины. струна

МаршрутизацияStorageContainerProperties

Имя Description Ценность
authenticationType Метод, используемый для проверки подлинности в конечной точке хранилища IdentityBased
KeyBased
частотаПакетовВСекундах Интервал времени записи больших двоичных объектов в хранилище. Значение должно составлять от 60 до 720 секунд. Значение по умолчанию — 300 секунд. int

Ограничения целостности:
Минимальное значение = 60
Максимальное значение = 720
connectionString Строка подключения учетной записи хранения. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
containerName Имя контейнера хранилища в учетной записи хранения. строка (обязательно)
encoding Кодировка, используемая для сериализации сообщений в большие двоичные объекты. Поддерживаемые значения: avro, avrodeflate и JSON. Значение по умолчанию — avro. 'Avro'
'AvroDeflate'
JSON
endpointUri URL-адрес конечной точки хранилища. Он должен включать протокол https:// струна
fileNameFormat Формат имени файла для большого двоичного объекта. Формат по умолчанию — {iothub}/{partition}/{ГГГГ}/{MM}/{DD}/{HH}/{mm}. Все параметры являются обязательными, но могут быть переупорядочены. струна
id Идентификатор конечной точки контейнера хранилища струна
identity Свойства управляемого удостоверения конечной точки хранилища маршрутизации. ManagedIdentity
maxChunkSizeInBytes (максимальный размер блока в байтах) Максимальное количество байтов для каждого большого двоичного объекта, записанного в хранилище. Значение должно быть между 10485760(10 МБ) и 524288000(500 МБ). Значение по умолчанию — 314572800(300 МБ). int

Ограничения целостности:
Минимальное значение = 10485760
Максимальное значение = 524288000
имя Имя, определяющее эту конечную точку. Имя может содержать только буквенно-цифровые символы, точки, символы подчеркивания, дефисы и имеет максимальную длину 64 символов. Следующие имена зарезервированы: события, fileNotifications, $default. Имена конечных точек должны быть уникальными для типов конечных точек. string

Ограничения целостности:
Pattern = ^[A-Za-z0-9-._]{1,64}$ (обязательно)
resourceGroup Имя группы ресурсов учетной записи хранения. струна
subscriptionId Идентификатор подписки учетной записи хранения. струна

Правило авторизации SharedAccessSignature

Имя Description Ценность
keyName Имя политики общего доступа. строка (обязательно)
первичный ключ Первичный ключ. струна
права Разрешения, назначенные политике общего доступа. 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 (обязательно)
вторичный ключ Вторичный ключ. струна

Свойства StorageEndpoint

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

Примеры использования

Примеры Terraform

Простой пример развертывания IotHub.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "IotHub" {
  type      = "Microsoft.Devices/IotHubs@2022-04-30-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      cloudToDevice = {
      }
      enableFileUploadNotifications = false
      messagingEndpoints = {
      }
      routing = {
        fallbackRoute = {
          condition = "true"
          endpointNames = [
            "events",
          ]
          isEnabled = true
          source    = "DeviceMessages"
        }
      }
      storageEndpoints = {
      }
    }
    sku = {
      capacity = 1
      name     = "S1"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}