Microsoft.Devices IotHubs 2016-02-03

Bicep resource definition

The IotHubs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Devices/IotHubs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Devices/IotHubs@2016-02-03' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    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'
      }
    }
    operationsMonitoringProperties: {
      events: {
        {customized property}: 'string'
      }
    }
    storageEndpoints: {
      {customized property}: {
        connectionString: 'string'
        containerName: 'string'
        sasTtlAsIso8601: 'string'
      }
    }
  }
  resourcegroup: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

Property values

CloudToDeviceProperties

EventHubProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs

OperationsMonitoringProperties

OperationsMonitoringPropertiesEvents

ResourceTags

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

The IotHubs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Devices/IotHubs resource, add the following JSON to your template.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2016-02-03",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "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"
      }
    },
    "operationsMonitoringProperties": {
      "events": {
        "{customized property}": "string"
      }
    },
    "storageEndpoints": {
      "{customized property}": {
        "connectionString": "string",
        "containerName": "string",
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "resourcegroup": "string",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

Property values

CloudToDeviceProperties

EventHubProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs

OperationsMonitoringProperties

OperationsMonitoringPropertiesEvents

ResourceTags

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Pay As You Go (PAYG) Environment with an IoT Hub	This template enables you to deploy a Pay As You Go (PAYG) Time Series Insights environment that is configured to consume events from an IoT Hub.
Create an IoT Hub and a Device to Cloud Consumer Group	This template enables you to deploy an IoT Hub instance with device to cloud and cloud to device messaging configurations and a device to cloud consumer group.
Create an IOT Hub and Ubuntu edge simulator	This template creates an IOT Hub and Virtual Machine Ubuntu edge simulator.
Create an IoT Hub Device Provisioning Service	This template enables you to create an IoT hub and an IoT Hub Device Provisioning Service, and link the two services together.
Create Device Update for IoT Hub account, instance, IoT Hub	This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.
Deploy the MedTech service including an Azure IoT Hub	The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.
Use ARM template to create IoT Hub, route and view messages	Use this template to deploy an IoT Hub and a storage account. Run an app to send messages to the hub that are routed to storage, then view the results.

Terraform (AzAPI provider) resource definition

The IotHubs resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Devices/IotHubs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2016-02-03"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      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"
        }
      }
      operationsMonitoringProperties = {
        events = {
          {customized property} = "string"
        }
      }
      storageEndpoints = {
        {customized property} = {
          connectionString = "string"
          containerName = "string"
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
  resourcegroup = "string"
  sku = {
    capacity = int
    name = "string"
  }
  subscriptionid = "string"
  tags = {
    {customized property} = "string"
  }
}

Property values

CloudToDeviceProperties

EventHubProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs

OperationsMonitoringProperties

OperationsMonitoringPropertiesEvents

ResourceTags

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties