IoTHubEventSourceCreateOrUpdateParameters interface

Package:

@azure/arm-timeseriesinsights

Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.

Extends

EventSourceCreateOrUpdateParameters

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.
kind	Polymorphic discriminator, which specifies the different types this object can be
localTimestampPropertiesLocalTimestamp	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.
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.
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".

Inherited Properties

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	The location of the resource.
tags	Key-value pairs of additional properties for the resource.

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

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

eventSourceResourceId

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

eventSourceResourceId: string

Property Value

string

iotHubName

The name of the iot hub.

iotHubName: string

Property Value

string

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

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Microsoft.IoTHub"

Property Value

"Microsoft.IoTHub"

localTimestampPropertiesLocalTimestamp

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.

localTimestampPropertiesLocalTimestamp?: LocalTimestamp

Property Value

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

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

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

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

type

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

type?: string

Property Value

string

Inherited Property Details

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 EventSourceCreateOrUpdateParameters.localTimestamp

location

The location of the resource.

location: string

Property Value

string

Inherited From EventSourceCreateOrUpdateParameters.location

tags

Key-value pairs of additional properties for the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From EventSourceCreateOrUpdateParameters.tags