AzureEventSourceProperties interface

Properties of an event source that reads events from an event broker in Azure.

Extends

Properties

eventSourceResourceId

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

Inherited Properties

creationTime

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

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

eventSourceResourceId

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

eventSourceResourceId: 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 EventSourceCommonProperties.creationTime

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

Inherited From EventSourceCommonProperties.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 EventSourceCommonProperties.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 EventSourceCommonProperties.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 EventSourceCommonProperties.timestampPropertyName

type

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

type?: string

Property Value

string

Inherited From EventSourceCommonProperties.type