Azure Time Series Insights Event Source Iothub

This page shows how to write Terraform and Azure Resource Manager for Time Series Insights Event Source Iothub and write them securely.

azurerm_iot_time_series_insights_event_source_iothub (Terraform)

The Event Source Iothub in Time Series Insights can be configured in Terraform with the resource name azurerm_iot_time_series_insights_event_source_iothub. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) Specifies the name of the Azure IoT Time Series Insights IoTHub Event Source. Changing this forces a new resource to be created. Must be globally unique.

  • environment_id - (Required) Specifies the id of the IoT Time Series Insights Environment that the Event Source should be associated with. Changing this forces a new resource to created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • iothub_name - (Required) Specifies the name of the IotHub which will be associated with this resource.

  • consumer_group_name - (Required) Specifies the name of the IotHub Consumer Group that holds the partitions from which events will be read.

  • event_source_resource_id - (Required) Specifies the resource id where events will be coming from.

  • shared_access_key_name - (Required) Specifies the name of the Shared Access key that grants the Event Source access to the IotHub.

  • shared_access_key - (Required) Specifies the value of the Shared Access Policy key that grants the Time Series Insights service read access to the IotHub.

  • timestamp_property_name - (Optional) Specifies the value that will be used as the event source's timestamp. This value defaults to the event creation time.

  • tags - (Optional) A mapping of tags to assign to the resource.

The following attributes are exported:

  • id - The ID of the IoT Time Series Insights IoTHub Event Source.

Explanation in Terraform Registry

Manages an Azure IoT Time Series Insights IoTHub Event Source.

Microsoft.TimeSeriesInsights/environments/eventSources (Azure Resource Manager)

The environments/eventSources in Microsoft.TimeSeriesInsights can be configured in Azure Resource Manager with the resource name Microsoft.TimeSeriesInsights/environments/eventSources. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • localTimestamp optional
      • format optional - string

        An enum that represents the format of the local timestamp property that needs to be set.

      • timeZoneOffset optional
          • propertyName optional - string

            The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)

  • location required - string

    The location of the resource.

  • name required - string

    Name of the event source.

  • tags optional - string

    Key-value pairs of additional properties for the resource.

  • type required - string

Frequently asked questions

What is Azure Time Series Insights Event Source Iothub?

Azure Time Series Insights Event Source Iothub is a resource for Time Series Insights of Microsoft Azure. Settings can be wrote in Terraform.