Skip Navigation

Create an Environment with an Event Hub Event Source

Last updated: 12/1/2017

This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.

This Azure Resource Manager template was created by a member of the community and not by Microsoft. Each Resource Manager template is licensed to you under a license agreement by its owner, not Microsoft. Microsoft is not responsible for Resource Manager templates provided and licensed by community members and does not screen for security, compatibility, or performance. Community Resource Manager templates are not supported under any Microsoft support program or service, and are made available AS IS without warranty of any kind.

Parameters

Parameter Name Description
eventHubNamespaceName The namespace of the source event hub.
eventHubName The name of the source event hub.
consumerGroupName The name of the consumer group that the Time Series Insights service will use to read the data from the event hub. NOTE: To avoid resource contention, this consumer group must be dedicated to the Time Series Insights service and not shared with other readers.
existingEventHubResourceId An optional resource id of an existing Event Hub that will be connected to the Time Series Insights environment through the event source. NOTE: The user deploying the template must have privliges to perform the listkeys operation on the Event Hub. If no value is passed, a new event hub will be created by the template.
environmentName Name of the environment. The name cannot include: '<', '>', '%', '&', ':', '\', '?', '/' and any control characters. All other characters are allowed.
environmentDisplayName An optional friendly name to show in tooling or user interfaces instead of the environment name.
environmentSkuName The name of the sku. For more information, see https://azure.microsoft.com/pricing/details/time-series-insights/
environmentSkuCapacity The unit capacity of the Sku. For more information, see https://azure.microsoft.com/pricing/details/time-series-insights/
environmentDataRetentionTime The minimum timespan the environment’s events will be available for query. The value must be specified in the ISO 8601 format, e.g. "P30D" for a retention policy of 30 days.
eventSourceName Name of the event source child resource. The name cannot include: '<', '>', '%', '&', ':', '\', '?', '/' and any control characters. All other characters are allowed.
eventSourceDisplayName An optional friendly name to show in tooling or user interfaces instead of the event source name.
eventSourceTimestampPropertyName 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.
eventSourceKeyName The name of the shared access key that the Time Series Insights service will use to connect to the event hub.
accessPolicyReaderObjectIds A list of object ids of the users or applications in AAD that should have Reader access to the environment. The service principal objectId can be obtained by calling the Get-AzureRMADUser or the Get-AzureRMADServicePrincipal cmdlets. Creating an access policy for AAD groups is not yet supported.
accessPolicyContributorObjectIds A list of object ids of the users or applications in AAD that should have Contributor access to the environment. The service principal objectId can be obtained by calling the Get-AzureRMADUser or the Get-AzureRMADServicePrincipal cmdlets. Creating an access policy for AAD groups is not yet supported.
location Location for all resources.

Use the template

PowerShell

New-AzureRmResourceGroupDeployment -Name <deployment-name> -ResourceGroupName <resource-group-name> -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/201-timeseriesinsights-environment-with-eventhub/azuredeploy.json
Install and configure Azure PowerShell

Command line

azure config mode arm
azure group deployment create <my-resource-group> <my-deployment-name> --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/201-timeseriesinsights-environment-with-eventhub/azuredeploy.json
Install and Configure the Azure Cross-Platform Command-Line Interface