EventHubEventSourceCreationProperties interface

Package:

@azure/arm-timeseriesinsights

Properties of the EventHub event source that are required on create or update requests.

Extends

EventHubEventSourceCommonProperties

Properties

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.

Inherited Properties

consumerGroupName	The name of the event hub's consumer group that holds the partitions from which events will be read.
creationTime	The time the resource was created. NOTE: This property will not be serialized. It can only be populated by the server.
eventHubName	The name of the event hub.
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.
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.
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.
serviceBusNamespace	The name of the service bus that contains the event hub.
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

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.

sharedAccessKey: string

Property Value

string

Inherited 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

Inherited From EventHubEventSourceCommonProperties.consumerGroupName

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 EventHubEventSourceCommonProperties.creationTime

eventHubName

The name of the event hub.

eventHubName: string

Property Value

string

Inherited From EventHubEventSourceCommonProperties.eventHubName

eventSourceResourceId

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

eventSourceResourceId: string

Property Value

string

Inherited From EventHubEventSourceCommonProperties.eventSourceResourceId

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

Inherited From EventHubEventSourceCommonProperties.keyName

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 EventHubEventSourceCommonProperties.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 EventHubEventSourceCommonProperties.provisioningState

serviceBusNamespace

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

serviceBusNamespace: string

Property Value

string

Inherited From EventHubEventSourceCommonProperties.serviceBusNamespace

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 EventHubEventSourceCommonProperties.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 EventHubEventSourceCommonProperties.timestampPropertyName

type

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

type?: string

Property Value

string

Inherited From EventHubEventSourceCommonProperties.type