Microsoft.Devices IotHubs 2021-07-01

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.Devices/IotHubs@2021-07-01' = {
  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'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        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'
  }
}

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

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

ОбогащениеProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

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

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

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

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

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

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Примеры краткого руководства

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

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2021-07-01",
  "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",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "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"
  }
}

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

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

ОбогащениеProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

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

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

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

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

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

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

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

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

Шаблон	Описание
создать среду pay as you go (PAYG) с помощью центра Интернета вещей развертывание	Этот шаблон позволяет развернуть среду аналитики временных рядов с оплатой по мере использования (PAYG), настроенную для использования событий из Центра Интернета вещей.
Создание Центра Интернета вещей и устройства для облачной группы потребителей развертывание	Этот шаблон позволяет развернуть экземпляр Центра Интернета вещей с устройством в облаке и облаке в конфигурации обмена сообщениями устройств и устройством в облачной группе потребителей.
Создание симулятора IOT Hub и Ubuntu edge развертывание	Этот шаблон создает симулятор IOT Hub и Виртуальной машины Ubuntu edge.
создание службы подготовки устройств Центра Интернета вещей развертывание	Этот шаблон позволяет создать центр Интернета вещей и службу подготовки устройств Центра Интернета вещей и связать две службы.
создание учетной записи Центра Интернета вещей, экземпляра, центра Интернета вещей развертывание	Этот шаблон создает учетную запись и экземпляр и концентратор для связывания экземпляра. Он настраивает концентратор с необходимыми политиками доступа, маршрутами и группой потребителей.
Развертывание службы MedTech, включая Центра Интернета вещей Azure развертывание	Служба MedTech — это одна из служб azure Health Data Services, предназначенных для приема данных устройства с нескольких устройств, преобразования данных устройства в наблюдения FHIR, которые затем сохраняются в службе FHIR служб данных Azure Health.
Использование шаблона ARM для создания Центра Интернета вещей, маршрутизации и просмотра сообщений развертывание	Используйте этот шаблон для развертывания Центра Интернета вещей и учетной записи хранения. Запустите приложение для отправки сообщений в концентратор, который направляется в хранилище, а затем просмотрите результаты.

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

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

• групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2021-07-01"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  body = jsonencode({
    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"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          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"
  }
}

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

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

ОбогащениеProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

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

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

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

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

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

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties