IoTHubEventSourceCreationProperties interface

Package:

@azure/arm-timeseriesinsights

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

Extends

IoTHubEventSourceCommonProperties

Properties

sharedAccessKey

The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.

Inherited Properties

consumerGroupName	The name of the iot 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.
eventSourceResourceId	The resource id of the event source in Azure Resource Manager.
iotHubName	The name of the iot hub.
keyName	The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot 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.
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 Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.

sharedAccessKey: string

Property Value

string

Inherited Property Details

consumerGroupName

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

consumerGroupName: string

Property Value

string

Inherited From IoTHubEventSourceCommonProperties.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 IoTHubEventSourceCommonProperties.creationTime

eventSourceResourceId

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

eventSourceResourceId: string

Property Value

string

Inherited From IoTHubEventSourceCommonProperties.eventSourceResourceId

iotHubName

The name of the iot hub.

iotHubName: string

Property Value

string

Inherited From IoTHubEventSourceCommonProperties.iotHubName

keyName

The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.

keyName: string

Property Value

string

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

type

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

type?: string

Property Value

string

Inherited From IoTHubEventSourceCommonProperties.type