Microsoft.TimeSeriesInsights environments/eventSources 2018-08-15-preview

• Latest
• 2021-06-30-preview
• 2021-03-31-preview
• 2020-05-15
• 2018-08-15-preview
• 2017-11-15
• 2017-02-28-preview

Bicep resource definition

The environments/eventSources 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.TimeSeriesInsights/environments/eventSources resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview' = {
  localTimestamp: {
    format: 'string'
    timeZoneOffset: {
      propertyName: 'string'
    }
  }
  location: 'string'
  name: 'string'
  tags: {
    {customized property}: 'string'
  }
  kind: 'string'
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}

Microsoft.TimeSeriesInsights/environments/eventSources objects

Set the kind property to specify the type of object.

For Microsoft.EventHub, use:

{
  kind: 'Microsoft.EventHub'
  properties: {
    consumerGroupName: 'string'
    eventHubName: 'string'
    eventSourceResourceId: 'string'
    keyName: 'string'
    serviceBusNamespace: 'string'
    sharedAccessKey: 'string'
    timestampPropertyName: 'string'
  }
}

For Microsoft.IoTHub, use:

{
  kind: 'Microsoft.IoTHub'
  properties: {
    consumerGroupName: 'string'
    eventSourceResourceId: 'string'
    iotHubName: 'string'
    keyName: 'string'
    sharedAccessKey: 'string'
    timestampPropertyName: 'string'
  }
}

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.EventHub' (required)
properties	Properties of the EventHub event source that are required on create or update requests.	EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties (required)

EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the event hub's consumer group that holds the partitions from which events will be read.	string (required)
eventHubName	The name of the event hub.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
keyName	The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.	string (required)
serviceBusNamespace	The name of the service bus that contains the event hub.	string (required)
sharedAccessKey	The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.IoTHub' (required)
properties	Properties of the IoTHub event source that are required on create or update requests.	IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties (required)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the iot hub's consumer group that holds the partitions from which events will be read.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
iotHubName	The name of the iot hub.	string (required)
keyName	The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.	string (required)
sharedAccessKey	The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

LocalTimestamp

Name	Description	Value
format	An enum that represents the format of the local timestamp property that needs to be set.	'Embedded'
timeZoneOffset	An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	Description	Value
propertyName	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)	string

Microsoft.TimeSeriesInsights/environments/eventSources

Name	Description	Value
kind	Set to 'Microsoft.EventHub' for type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource. Set to 'Microsoft.IoTHub' for type IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource.	'Microsoft.EventHub' 'Microsoft.IoTHub' (required)
localTimestamp	An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.	LocalTimestamp
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: environments
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ARM template resource definition

The environments/eventSources 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.TimeSeriesInsights/environments/eventSources resource, add the following JSON to your template.

{
  "localTimestamp": {
    "format": "string",
    "timeZoneOffset": {
      "propertyName": "string"
    }
  },
  "location": "string",
  "name": "string",
  "tags": {
    "{customized property}": "string"
  },
  "kind": "string"
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}

Microsoft.TimeSeriesInsights/environments/eventSources objects

Set the kind property to specify the type of object.

For Microsoft.EventHub, use:

{
  "kind": "Microsoft.EventHub",
  "properties": {
    "consumerGroupName": "string",
    "eventHubName": "string",
    "eventSourceResourceId": "string",
    "keyName": "string",
    "serviceBusNamespace": "string",
    "sharedAccessKey": "string",
    "timestampPropertyName": "string"
  }
}

For Microsoft.IoTHub, use:

{
  "kind": "Microsoft.IoTHub",
  "properties": {
    "consumerGroupName": "string",
    "eventSourceResourceId": "string",
    "iotHubName": "string",
    "keyName": "string",
    "sharedAccessKey": "string",
    "timestampPropertyName": "string"
  }
}

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.EventHub' (required)
properties	Properties of the EventHub event source that are required on create or update requests.	EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties (required)

EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the event hub's consumer group that holds the partitions from which events will be read.	string (required)
eventHubName	The name of the event hub.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
keyName	The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.	string (required)
serviceBusNamespace	The name of the service bus that contains the event hub.	string (required)
sharedAccessKey	The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.IoTHub' (required)
properties	Properties of the IoTHub event source that are required on create or update requests.	IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties (required)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the iot hub's consumer group that holds the partitions from which events will be read.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
iotHubName	The name of the iot hub.	string (required)
keyName	The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.	string (required)
sharedAccessKey	The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

LocalTimestamp

Name	Description	Value
format	An enum that represents the format of the local timestamp property that needs to be set.	'Embedded'
timeZoneOffset	An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	Description	Value
propertyName	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)	string

Microsoft.TimeSeriesInsights/environments/eventSources

Name	Description	Value
apiVersion	The api version	'2018-08-15-preview'
kind	Set to 'Microsoft.EventHub' for type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource. Set to 'Microsoft.IoTHub' for type IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource.	'Microsoft.EventHub' 'Microsoft.IoTHub' (required)
localTimestamp	An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.	LocalTimestamp
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.TimeSeriesInsights/environments/eventSources'

Terraform (AzAPI provider) resource definition

The environments/eventSources 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.TimeSeriesInsights/environments/eventSources resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  localTimestamp = {
    format = "string"
    timeZoneOffset = {
      propertyName = "string"
    }
  }
  location = "string"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  kind = "string"
  // For remaining properties, see Microsoft.TimeSeriesInsights/environments/eventSources objects
}

Microsoft.TimeSeriesInsights/environments/eventSources objects

Set the kind property to specify the type of object.

For Microsoft.EventHub, use:

{
  kind = "Microsoft.EventHub"
  properties = {
    consumerGroupName = "string"
    eventHubName = "string"
    eventSourceResourceId = "string"
    keyName = "string"
    serviceBusNamespace = "string"
    sharedAccessKey = "string"
    timestampPropertyName = "string"
  }
}

For Microsoft.IoTHub, use:

{
  kind = "Microsoft.IoTHub"
  properties = {
    consumerGroupName = "string"
    eventSourceResourceId = "string"
    iotHubName = "string"
    keyName = "string"
    sharedAccessKey = "string"
    timestampPropertyName = "string"
  }
}

Property values

CreateOrUpdateTrackedResourcePropertiesTags

Name	Description	Value

EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.EventHub' (required)
properties	Properties of the EventHub event source that are required on create or update requests.	EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties (required)

EventHubEventSourceCreationPropertiesOrEventHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the event hub's consumer group that holds the partitions from which events will be read.	string (required)
eventHubName	The name of the event hub.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
keyName	The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.	string (required)
serviceBusNamespace	The name of the service bus that contains the event hub.	string (required)
sharedAccessKey	The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource

Name	Description	Value
kind	The kind of the event source.	'Microsoft.IoTHub' (required)
properties	Properties of the IoTHub event source that are required on create or update requests.	IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties (required)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSourceResourceProperties

Name	Description	Value
consumerGroupName	The name of the iot hub's consumer group that holds the partitions from which events will be read.	string (required)
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.	string (required)
iotHubName	The name of the iot hub.	string (required)
keyName	The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.	string (required)
sharedAccessKey	The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.	string (required)
timestampPropertyName	The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.	string

LocalTimestamp

Name	Description	Value
format	An enum that represents the format of the local timestamp property that needs to be set.	'Embedded'
timeZoneOffset	An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	Description	Value
propertyName	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)	string

Microsoft.TimeSeriesInsights/environments/eventSources

Name	Description	Value
kind	Set to 'Microsoft.EventHub' for type EventHubEventSourceCreateOrUpdateParametersOrEventHubEventSourceResource. Set to 'Microsoft.IoTHub' for type IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEventSourceResource.	'Microsoft.EventHub' 'Microsoft.IoTHub' (required)
localTimestamp	An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.	LocalTimestamp
location	The location of the resource.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: environments
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview"