EventHubEventSourceCommonProperties interface

Package:

@azure/arm-timeseriesinsights

Properties of the EventHub event source.

Extends

AzureEventSourceProperties

Properties

consumerGroupName	The name of the event hub's consumer group that holds the partitions from which events will be read.
eventHubName	The name of the event hub.
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.
serviceBusNamespace	The name of the service bus that contains the event hub.

Inherited Properties

creationTime	The time the resource was created. NOTE: This property will not be serialized. It can only be populated by the server.
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.
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.
provisioningState	Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
time	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	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	The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Property Details

consumerGroupName

The name of the event hub's consumer group that holds the partitions from which events will be read.

consumerGroupName: string

Property Value

string

eventHubName

The name of the event hub.

eventHubName: string

Property Value

string

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.

keyName: string

Property Value

string

serviceBusNamespace

The name of the service bus that contains the event hub.

serviceBusNamespace: string

Property Value

string

Inherited Property Details

creationTime

The time the resource was created. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

Inherited From AzureEventSourceProperties.creationTime

eventSourceResourceId

The resource id of the event source in Azure Resource Manager.

eventSourceResourceId: string

Property Value

string

Inherited From AzureEventSourceProperties.eventSourceResourceId

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?: LocalTimestamp

Property Value

LocalTimestamp

Inherited From AzureEventSourceProperties.localTimestamp

provisioningState

Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From AzureEventSourceProperties.provisioningState

time

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.

time?: string

Property Value

string

Inherited From AzureEventSourceProperties.time

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.

timestampPropertyName?: string

Property Value

string

Inherited From AzureEventSourceProperties.timestampPropertyName

type

The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

type?: string

Property Value

string

Inherited From AzureEventSourceProperties.type