AzureDataExplorerConnectionProperties interface

Package:

@azure/arm-digitaltwins

Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.

Extends

TimeSeriesDatabaseConnectionProperties

Properties

adxDatabaseName	The name of the Azure Data Explorer database.
adxEndpointUri	The URI of the Azure Data Explorer endpoint.
adxRelationshipLifecycleEventsTableName	The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
adxResourceId	The resource ID of the Azure Data Explorer cluster.
adxTableName	The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adxTwinLifecycleEventsTableName	The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
connectionType	Polymorphic discriminator, which specifies the different types this object can be
eventHubConsumerGroup	The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
eventHubEndpointUri	The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath	The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId	The resource ID of the EventHub namespace.
recordPropertyAndItemRemovals	Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

Inherited Properties

identity	Managed identity properties for the time series database connection resource.
provisioningState	The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

adxDatabaseName

The name of the Azure Data Explorer database.

adxDatabaseName: string

Property Value

string

adxEndpointUri

The URI of the Azure Data Explorer endpoint.

adxEndpointUri: string

Property Value

string

adxRelationshipLifecycleEventsTableName

The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.

adxRelationshipLifecycleEventsTableName?: string

Property Value

string

adxResourceId

The resource ID of the Azure Data Explorer cluster.

adxResourceId: string

Property Value

string

adxTableName

The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.

adxTableName?: string

Property Value

string

adxTwinLifecycleEventsTableName

The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.

adxTwinLifecycleEventsTableName?: string

Property Value

string

connectionType

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

connectionType: "AzureDataExplorer"

Property Value

"AzureDataExplorer"

eventHubConsumerGroup

The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

eventHubConsumerGroup?: string

Property Value

string

eventHubEndpointUri

The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://

eventHubEndpointUri: string

Property Value

string

eventHubEntityPath

The EventHub name in the EventHub namespace for identity-based authentication.

eventHubEntityPath: string

Property Value

string

eventHubNamespaceResourceId

The resource ID of the EventHub namespace.

eventHubNamespaceResourceId: string

Property Value

string

recordPropertyAndItemRemovals

Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

recordPropertyAndItemRemovals?: string

Property Value

string

Inherited Property Details

identity

Managed identity properties for the time series database connection resource.

identity?: ManagedIdentityReference

Property Value

ManagedIdentityReference

Inherited From TimeSeriesDatabaseConnectionProperties.identity

provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From TimeSeriesDatabaseConnectionProperties.provisioningState