Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. timeseriesinsights
  5. EventHubEventSource
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.timeseriesinsights.EventHubEventSource

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

An event source that receives its data from an Azure EventHub.

Uses Azure REST API version 2020-05-15. In version 2.x of the Azure Native provider, it used API version 2020-05-15.

Example Usage

CreateEventHubEventSource

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var eventHubEventSource = new AzureNative.TimeSeriesInsights.EventHubEventSource("eventHubEventSource", new()
    {
        ConsumerGroupName = "cgn",
        EnvironmentName = "env1",
        EventHubName = "ehn",
        EventSourceName = "es1",
        EventSourceResourceId = "somePathInArm",
        KeyName = "managementKey",
        Kind = "Microsoft.EventHub",
        Location = "West US",
        ResourceGroupName = "rg1",
        ServiceBusNamespace = "sbn",
        SharedAccessKey = "someSecretvalue",
        TimestampPropertyName = "someTimestampProperty",
        Type = AzureNative.TimeSeriesInsights.IngressStartAtType.EarliestAvailable,
    });

});
Copy
package main

import (
	timeseriesinsights "github.com/pulumi/pulumi-azure-native-sdk/timeseriesinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timeseriesinsights.NewEventHubEventSource(ctx, "eventHubEventSource", &timeseriesinsights.EventHubEventSourceArgs{
			ConsumerGroupName:     pulumi.String("cgn"),
			EnvironmentName:       pulumi.String("env1"),
			EventHubName:          pulumi.String("ehn"),
			EventSourceName:       pulumi.String("es1"),
			EventSourceResourceId: pulumi.String("somePathInArm"),
			KeyName:               pulumi.String("managementKey"),
			Kind:                  pulumi.String("Microsoft.EventHub"),
			Location:              pulumi.String("West US"),
			ResourceGroupName:     pulumi.String("rg1"),
			ServiceBusNamespace:   pulumi.String("sbn"),
			SharedAccessKey:       pulumi.String("someSecretvalue"),
			TimestampPropertyName: pulumi.String("someTimestampProperty"),
			Type:                  pulumi.String(timeseriesinsights.IngressStartAtTypeEarliestAvailable),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.timeseriesinsights.EventHubEventSource;
import com.pulumi.azurenative.timeseriesinsights.EventHubEventSourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var eventHubEventSource = new EventHubEventSource("eventHubEventSource", EventHubEventSourceArgs.builder()
            .consumerGroupName("cgn")
            .environmentName("env1")
            .eventHubName("ehn")
            .eventSourceName("es1")
            .eventSourceResourceId("somePathInArm")
            .keyName("managementKey")
            .kind("Microsoft.EventHub")
            .location("West US")
            .resourceGroupName("rg1")
            .serviceBusNamespace("sbn")
            .sharedAccessKey("someSecretvalue")
            .timestampPropertyName("someTimestampProperty")
            .type("EarliestAvailable")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const eventHubEventSource = new azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSource", {
    consumerGroupName: "cgn",
    environmentName: "env1",
    eventHubName: "ehn",
    eventSourceName: "es1",
    eventSourceResourceId: "somePathInArm",
    keyName: "managementKey",
    kind: "Microsoft.EventHub",
    location: "West US",
    resourceGroupName: "rg1",
    serviceBusNamespace: "sbn",
    sharedAccessKey: "someSecretvalue",
    timestampPropertyName: "someTimestampProperty",
    type: azure_native.timeseriesinsights.IngressStartAtType.EarliestAvailable,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

event_hub_event_source = azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSource",
    consumer_group_name="cgn",
    environment_name="env1",
    event_hub_name="ehn",
    event_source_name="es1",
    event_source_resource_id="somePathInArm",
    key_name="managementKey",
    kind="Microsoft.EventHub",
    location="West US",
    resource_group_name="rg1",
    service_bus_namespace="sbn",
    shared_access_key="someSecretvalue",
    timestamp_property_name="someTimestampProperty",
    type=azure_native.timeseriesinsights.IngressStartAtType.EARLIEST_AVAILABLE)
Copy
resources:
  eventHubEventSource:
    type: azure-native:timeseriesinsights:EventHubEventSource
    properties:
      consumerGroupName: cgn
      environmentName: env1
      eventHubName: ehn
      eventSourceName: es1
      eventSourceResourceId: somePathInArm
      keyName: managementKey
      kind: Microsoft.EventHub
      location: West US
      resourceGroupName: rg1
      serviceBusNamespace: sbn
      sharedAccessKey: someSecretvalue
      timestampPropertyName: someTimestampProperty
      type: EarliestAvailable
Copy

EventSourcesCreateEventHubWithCustomEnquedTime

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var eventHubEventSource = new AzureNative.TimeSeriesInsights.EventHubEventSource("eventHubEventSource", new()
    {
        ConsumerGroupName = "cgn",
        EnvironmentName = "env1",
        EventHubName = "ehn",
        EventSourceName = "es1",
        EventSourceResourceId = "somePathInArm",
        KeyName = "managementKey",
        Kind = "Microsoft.EventHub",
        Location = "West US",
        ResourceGroupName = "rg1",
        ServiceBusNamespace = "sbn",
        SharedAccessKey = "someSecretvalue",
        Time = "2017-04-01T19:20:33.2288820Z",
        TimestampPropertyName = "someTimestampProperty",
        Type = AzureNative.TimeSeriesInsights.IngressStartAtType.CustomEnqueuedTime,
    });

});
Copy
package main

import (
	timeseriesinsights "github.com/pulumi/pulumi-azure-native-sdk/timeseriesinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timeseriesinsights.NewEventHubEventSource(ctx, "eventHubEventSource", &timeseriesinsights.EventHubEventSourceArgs{
			ConsumerGroupName:     pulumi.String("cgn"),
			EnvironmentName:       pulumi.String("env1"),
			EventHubName:          pulumi.String("ehn"),
			EventSourceName:       pulumi.String("es1"),
			EventSourceResourceId: pulumi.String("somePathInArm"),
			KeyName:               pulumi.String("managementKey"),
			Kind:                  pulumi.String("Microsoft.EventHub"),
			Location:              pulumi.String("West US"),
			ResourceGroupName:     pulumi.String("rg1"),
			ServiceBusNamespace:   pulumi.String("sbn"),
			SharedAccessKey:       pulumi.String("someSecretvalue"),
			Time:                  pulumi.String("2017-04-01T19:20:33.2288820Z"),
			TimestampPropertyName: pulumi.String("someTimestampProperty"),
			Type:                  pulumi.String(timeseriesinsights.IngressStartAtTypeCustomEnqueuedTime),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.timeseriesinsights.EventHubEventSource;
import com.pulumi.azurenative.timeseriesinsights.EventHubEventSourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var eventHubEventSource = new EventHubEventSource("eventHubEventSource", EventHubEventSourceArgs.builder()
            .consumerGroupName("cgn")
            .environmentName("env1")
            .eventHubName("ehn")
            .eventSourceName("es1")
            .eventSourceResourceId("somePathInArm")
            .keyName("managementKey")
            .kind("Microsoft.EventHub")
            .location("West US")
            .resourceGroupName("rg1")
            .serviceBusNamespace("sbn")
            .sharedAccessKey("someSecretvalue")
            .time("2017-04-01T19:20:33.2288820Z")
            .timestampPropertyName("someTimestampProperty")
            .type("CustomEnqueuedTime")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const eventHubEventSource = new azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSource", {
    consumerGroupName: "cgn",
    environmentName: "env1",
    eventHubName: "ehn",
    eventSourceName: "es1",
    eventSourceResourceId: "somePathInArm",
    keyName: "managementKey",
    kind: "Microsoft.EventHub",
    location: "West US",
    resourceGroupName: "rg1",
    serviceBusNamespace: "sbn",
    sharedAccessKey: "someSecretvalue",
    time: "2017-04-01T19:20:33.2288820Z",
    timestampPropertyName: "someTimestampProperty",
    type: azure_native.timeseriesinsights.IngressStartAtType.CustomEnqueuedTime,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

event_hub_event_source = azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSource",
    consumer_group_name="cgn",
    environment_name="env1",
    event_hub_name="ehn",
    event_source_name="es1",
    event_source_resource_id="somePathInArm",
    key_name="managementKey",
    kind="Microsoft.EventHub",
    location="West US",
    resource_group_name="rg1",
    service_bus_namespace="sbn",
    shared_access_key="someSecretvalue",
    time="2017-04-01T19:20:33.2288820Z",
    timestamp_property_name="someTimestampProperty",
    type=azure_native.timeseriesinsights.IngressStartAtType.CUSTOM_ENQUEUED_TIME)
Copy
resources:
  eventHubEventSource:
    type: azure-native:timeseriesinsights:EventHubEventSource
    properties:
      consumerGroupName: cgn
      environmentName: env1
      eventHubName: ehn
      eventSourceName: es1
      eventSourceResourceId: somePathInArm
      keyName: managementKey
      kind: Microsoft.EventHub
      location: West US
      resourceGroupName: rg1
      serviceBusNamespace: sbn
      sharedAccessKey: someSecretvalue
      time: 2017-04-01T19:20:33.2288820Z
      timestampPropertyName: someTimestampProperty
      type: CustomEnqueuedTime
Copy

Create EventHubEventSource Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EventHubEventSource(name: string, args: EventHubEventSourceArgs, opts?: CustomResourceOptions);
@overload
def EventHubEventSource(resource_name: str,
                        args: EventHubEventSourceArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def EventHubEventSource(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        resource_group_name: Optional[str] = None,
                        environment_name: Optional[str] = None,
                        event_hub_name: Optional[str] = None,
                        shared_access_key: Optional[str] = None,
                        event_source_resource_id: Optional[str] = None,
                        key_name: Optional[str] = None,
                        service_bus_namespace: Optional[str] = None,
                        consumer_group_name: Optional[str] = None,
                        location: Optional[str] = None,
                        local_timestamp: Optional[LocalTimestampArgs] = None,
                        event_source_name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        time: Optional[str] = None,
                        timestamp_property_name: Optional[str] = None,
                        type: Optional[Union[str, IngressStartAtType]] = None)
func NewEventHubEventSource(ctx *Context, name string, args EventHubEventSourceArgs, opts ...ResourceOption) (*EventHubEventSource, error)
public EventHubEventSource(string name, EventHubEventSourceArgs args, CustomResourceOptions? opts = null)
public EventHubEventSource(String name, EventHubEventSourceArgs args)
public EventHubEventSource(String name, EventHubEventSourceArgs args, CustomResourceOptions options)

type: azure-native:timeseriesinsights:EventHubEventSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EventHubEventSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EventHubEventSourceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EventHubEventSourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EventHubEventSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventHubEventSourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var eventHubEventSourceResource = new AzureNative.TimeSeriesInsights.EventHubEventSource("eventHubEventSourceResource", new()
{
    ResourceGroupName = "string",
    EnvironmentName = "string",
    EventHubName = "string",
    SharedAccessKey = "string",
    EventSourceResourceId = "string",
    KeyName = "string",
    Kind = "string",
    ServiceBusNamespace = "string",
    ConsumerGroupName = "string",
    Location = "string",
    LocalTimestamp = new AzureNative.TimeSeriesInsights.Inputs.LocalTimestampArgs
    {
        Format = "string",
        TimeZoneOffset = new AzureNative.TimeSeriesInsights.Inputs.LocalTimestampTimeZoneOffsetArgs
        {
            PropertyName = "string",
        },
    },
    EventSourceName = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Time = "string",
    TimestampPropertyName = "string",
    Type = "string",
});
Copy
example, err := timeseriesinsights.NewEventHubEventSource(ctx, "eventHubEventSourceResource", &timeseriesinsights.EventHubEventSourceArgs{
	ResourceGroupName:     pulumi.String("string"),
	EnvironmentName:       pulumi.String("string"),
	EventHubName:          pulumi.String("string"),
	SharedAccessKey:       pulumi.String("string"),
	EventSourceResourceId: pulumi.String("string"),
	KeyName:               pulumi.String("string"),
	Kind:                  pulumi.String("string"),
	ServiceBusNamespace:   pulumi.String("string"),
	ConsumerGroupName:     pulumi.String("string"),
	Location:              pulumi.String("string"),
	LocalTimestamp: &timeseriesinsights.LocalTimestampArgs{
		Format: pulumi.String("string"),
		TimeZoneOffset: &timeseriesinsights.LocalTimestampTimeZoneOffsetArgs{
			PropertyName: pulumi.String("string"),
		},
	},
	EventSourceName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Time:                  pulumi.String("string"),
	TimestampPropertyName: pulumi.String("string"),
	Type:                  pulumi.String("string"),
})
Copy
var eventHubEventSourceResource = new EventHubEventSource("eventHubEventSourceResource", EventHubEventSourceArgs.builder()
    .resourceGroupName("string")
    .environmentName("string")
    .eventHubName("string")
    .sharedAccessKey("string")
    .eventSourceResourceId("string")
    .keyName("string")
    .kind("string")
    .serviceBusNamespace("string")
    .consumerGroupName("string")
    .location("string")
    .localTimestamp(LocalTimestampArgs.builder()
        .format("string")
        .timeZoneOffset(LocalTimestampTimeZoneOffsetArgs.builder()
            .propertyName("string")
            .build())
        .build())
    .eventSourceName("string")
    .tags(Map.of("string", "string"))
    .time("string")
    .timestampPropertyName("string")
    .type("string")
    .build());
Copy
event_hub_event_source_resource = azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSourceResource",
    resource_group_name="string",
    environment_name="string",
    event_hub_name="string",
    shared_access_key="string",
    event_source_resource_id="string",
    key_name="string",
    kind="string",
    service_bus_namespace="string",
    consumer_group_name="string",
    location="string",
    local_timestamp={
        "format": "string",
        "time_zone_offset": {
            "property_name": "string",
        },
    },
    event_source_name="string",
    tags={
        "string": "string",
    },
    time="string",
    timestamp_property_name="string",
    type="string")
Copy
const eventHubEventSourceResource = new azure_native.timeseriesinsights.EventHubEventSource("eventHubEventSourceResource", {
    resourceGroupName: "string",
    environmentName: "string",
    eventHubName: "string",
    sharedAccessKey: "string",
    eventSourceResourceId: "string",
    keyName: "string",
    kind: "string",
    serviceBusNamespace: "string",
    consumerGroupName: "string",
    location: "string",
    localTimestamp: {
        format: "string",
        timeZoneOffset: {
            propertyName: "string",
        },
    },
    eventSourceName: "string",
    tags: {
        string: "string",
    },
    time: "string",
    timestampPropertyName: "string",
    type: "string",
});
Copy
type: azure-native:timeseriesinsights:EventHubEventSource
properties:
    consumerGroupName: string
    environmentName: string
    eventHubName: string
    eventSourceName: string
    eventSourceResourceId: string
    keyName: string
    kind: string
    localTimestamp:
        format: string
        timeZoneOffset:
            propertyName: string
    location: string
    resourceGroupName: string
    serviceBusNamespace: string
    sharedAccessKey: string
    tags:
        string: string
    time: string
    timestampPropertyName: string
    type: string
Copy

EventHubEventSource Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EventHubEventSource resource accepts the following input properties:

ConsumerGroupName This property is required. string
The name of the event hub's consumer group that holds the partitions from which events will be read.
EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
EventHubName This property is required. string
The name of the event hub.
EventSourceResourceId This property is required. string
The resource id of the event source in Azure Resource Manager.
KeyName This property is required. string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
ServiceBusNamespace This property is required. string
The name of the service bus that contains the event hub.
SharedAccessKey This property is required. string
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.
EventSourceName Changes to this property will trigger replacement. string
Name of the event source.
LocalTimestamp Pulumi.AzureNative.TimeSeriesInsights.Inputs.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.
Location Changes to this property will trigger replacement. string
The location of the resource.
Tags Dictionary<string, string>
Key-value pairs of additional properties for the resource.
Time string
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
TimestampPropertyName string
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.
Type string | Pulumi.AzureNative.TimeSeriesInsights.IngressStartAtType
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
ConsumerGroupName This property is required. string
The name of the event hub's consumer group that holds the partitions from which events will be read.
EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
EventHubName This property is required. string
The name of the event hub.
EventSourceResourceId This property is required. string
The resource id of the event source in Azure Resource Manager.
KeyName This property is required. string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
ServiceBusNamespace This property is required. string
The name of the service bus that contains the event hub.
SharedAccessKey This property is required. string
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.
EventSourceName Changes to this property will trigger replacement. string
Name of the event source.
LocalTimestamp LocalTimestampArgs
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.
Location Changes to this property will trigger replacement. string
The location of the resource.
Tags map[string]string
Key-value pairs of additional properties for the resource.
Time string
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
TimestampPropertyName string
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.
Type string | IngressStartAtType
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
consumerGroupName This property is required. String
The name of the event hub's consumer group that holds the partitions from which events will be read.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Time Series Insights environment associated with the specified resource group.
eventHubName This property is required. String
The name of the event hub.
eventSourceResourceId This property is required. String
The resource id of the event source in Azure Resource Manager.
keyName This property is required. String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
serviceBusNamespace This property is required. String
The name of the service bus that contains the event hub.
sharedAccessKey This property is required. String
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.
eventSourceName Changes to this property will trigger replacement. String
Name of the event source.
localTimestamp 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.
location Changes to this property will trigger replacement. String
The location of the resource.
tags Map<String,String>
Key-value pairs of additional properties for the resource.
time String
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
timestampPropertyName String
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.
type String | IngressStartAtType
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
consumerGroupName This property is required. string
The name of the event hub's consumer group that holds the partitions from which events will be read.
environmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
eventHubName This property is required. string
The name of the event hub.
eventSourceResourceId This property is required. string
The resource id of the event source in Azure Resource Manager.
keyName This property is required. string
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
serviceBusNamespace This property is required. string
The name of the service bus that contains the event hub.
sharedAccessKey This property is required. string
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.
eventSourceName Changes to this property will trigger replacement. string
Name of the event source.
localTimestamp 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.
location Changes to this property will trigger replacement. string
The location of the resource.
tags {[key: string]: string}
Key-value pairs of additional properties for the resource.
time string
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
timestampPropertyName string
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.
type string | IngressStartAtType
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
consumer_group_name This property is required. str
The name of the event hub's consumer group that holds the partitions from which events will be read.
environment_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Time Series Insights environment associated with the specified resource group.
event_hub_name This property is required. str
The name of the event hub.
event_source_resource_id This property is required. str
The resource id of the event source in Azure Resource Manager.
key_name This property is required. str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure Resource group.
service_bus_namespace This property is required. str
The name of the service bus that contains the event hub.
shared_access_key This property is required. str
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.
event_source_name Changes to this property will trigger replacement. str
Name of the event source.
local_timestamp LocalTimestampArgs
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.
location Changes to this property will trigger replacement. str
The location of the resource.
tags Mapping[str, str]
Key-value pairs of additional properties for the resource.
time str
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
timestamp_property_name str
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.
type str | IngressStartAtType
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
consumerGroupName This property is required. String
The name of the event hub's consumer group that holds the partitions from which events will be read.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Time Series Insights environment associated with the specified resource group.
eventHubName This property is required. String
The name of the event hub.
eventSourceResourceId This property is required. String
The resource id of the event source in Azure Resource Manager.
keyName This property is required. String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
serviceBusNamespace This property is required. String
The name of the service bus that contains the event hub.
sharedAccessKey This property is required. String
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.
eventSourceName Changes to this property will trigger replacement. String
Name of the event source.
localTimestamp Property Map
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.
location Changes to this property will trigger replacement. String
The location of the resource.
tags Map<String>
Key-value pairs of additional properties for the resource.
time String
ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
timestampPropertyName String
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.
type String | "EarliestAvailable" | "EventSourceCreationTime" | "CustomEnqueuedTime"
The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Outputs

All input properties are implicitly available as output properties. Additionally, the EventHubEventSource resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
CreationTime string
The time the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
ProvisioningState string
Provisioning state of the resource.
AzureApiVersion string
The Azure API version of the resource.
CreationTime string
The time the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
ProvisioningState string
Provisioning state of the resource.
azureApiVersion String
The Azure API version of the resource.
creationTime String
The time the resource was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
provisioningState String
Provisioning state of the resource.
azureApiVersion string
The Azure API version of the resource.
creationTime string
The time the resource was created.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name
provisioningState string
Provisioning state of the resource.
azure_api_version str
The Azure API version of the resource.
creation_time str
The time the resource was created.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name
provisioning_state str
Provisioning state of the resource.
azureApiVersion String
The Azure API version of the resource.
creationTime String
The time the resource was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
provisioningState String
Provisioning state of the resource.

Supporting Types

IngressStartAtType
, IngressStartAtTypeArgs

EarliestAvailable
EarliestAvailable
EventSourceCreationTime
EventSourceCreationTime
CustomEnqueuedTime
CustomEnqueuedTime
IngressStartAtTypeEarliestAvailable
EarliestAvailable
IngressStartAtTypeEventSourceCreationTime
EventSourceCreationTime
IngressStartAtTypeCustomEnqueuedTime
CustomEnqueuedTime
EarliestAvailable
EarliestAvailable
EventSourceCreationTime
EventSourceCreationTime
CustomEnqueuedTime
CustomEnqueuedTime
EarliestAvailable
EarliestAvailable
EventSourceCreationTime
EventSourceCreationTime
CustomEnqueuedTime
CustomEnqueuedTime
EARLIEST_AVAILABLE
EarliestAvailable
EVENT_SOURCE_CREATION_TIME
EventSourceCreationTime
CUSTOM_ENQUEUED_TIME
CustomEnqueuedTime
"EarliestAvailable"
EarliestAvailable
"EventSourceCreationTime"
EventSourceCreationTime
"CustomEnqueuedTime"
CustomEnqueuedTime

LocalTimestamp
, LocalTimestampArgs

Format string | Pulumi.AzureNative.TimeSeriesInsights.LocalTimestampFormat
An enum that represents the format of the local timestamp property that needs to be set.
TimeZoneOffset Pulumi.AzureNative.TimeSeriesInsights.Inputs.LocalTimestampTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
Format string | LocalTimestampFormat
An enum that represents the format of the local timestamp property that needs to be set.
TimeZoneOffset LocalTimestampTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format String | LocalTimestampFormat
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset LocalTimestampTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format string | LocalTimestampFormat
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset LocalTimestampTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format str | LocalTimestampFormat
An enum that represents the format of the local timestamp property that needs to be set.
time_zone_offset LocalTimestampTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format String | "Embedded"
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset Property Map
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

LocalTimestampFormat
, LocalTimestampFormatArgs

Embedded
Embedded
LocalTimestampFormatEmbedded
Embedded
Embedded
Embedded
Embedded
Embedded
EMBEDDED
Embedded
"Embedded"
Embedded

LocalTimestampResponse
, LocalTimestampResponseArgs

Format string
An enum that represents the format of the local timestamp property that needs to be set.
TimeZoneOffset Pulumi.AzureNative.TimeSeriesInsights.Inputs.LocalTimestampResponseTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
Format string
An enum that represents the format of the local timestamp property that needs to be set.
TimeZoneOffset LocalTimestampResponseTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format String
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset LocalTimestampResponseTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format string
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset LocalTimestampResponseTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format str
An enum that represents the format of the local timestamp property that needs to be set.
time_zone_offset LocalTimestampResponseTimeZoneOffset
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
format String
An enum that represents the format of the local timestamp property that needs to be set.
timeZoneOffset Property Map
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

LocalTimestampResponseTimeZoneOffset
, LocalTimestampResponseTimeZoneOffsetArgs

PropertyName 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)
PropertyName 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)
propertyName 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)
propertyName 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)
property_name str
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)
propertyName 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)

LocalTimestampTimeZoneOffset
, LocalTimestampTimeZoneOffsetArgs

PropertyName 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)
PropertyName 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)
propertyName 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)
propertyName 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)
property_name str
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)
propertyName 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)

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:timeseriesinsights:EventHubEventSource es1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native