DataExplorerConnectionProperties Class

Definition

Namespace:

Azure.ResourceManager.DigitalTwins.Models

Assembly:

Azure.ResourceManager.DigitalTwins.dll

Package:

Azure.ResourceManager.DigitalTwins v1.3.1

Source:

DataExplorerConnectionProperties.cs

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

public class DataExplorerConnectionProperties : Azure.ResourceManager.DigitalTwins.Models.TimeSeriesDatabaseConnectionProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DigitalTwins.Models.DataExplorerConnectionProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DigitalTwins.Models.DataExplorerConnectionProperties>

type DataExplorerConnectionProperties = class
    inherit TimeSeriesDatabaseConnectionProperties
    interface IJsonModel<DataExplorerConnectionProperties>
    interface IPersistableModel<DataExplorerConnectionProperties>

Public Class DataExplorerConnectionProperties
Inherits TimeSeriesDatabaseConnectionProperties
Implements IJsonModel(Of DataExplorerConnectionProperties), IPersistableModel(Of DataExplorerConnectionProperties)

Inheritance

Object

TimeSeriesDatabaseConnectionProperties

DataExplorerConnectionProperties

Implements

IJsonModel<DataExplorerConnectionProperties> IPersistableModel<DataExplorerConnectionProperties> IPersistableModel<T>

Constructors

DataExplorerConnectionProperties(ResourceIdentifier, Uri, String, Uri, String, ResourceIdentifier)

Initializes a new instance of DataExplorerConnectionProperties.

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.
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.
Identity	Managed identity properties for the time series database connection resource. (Inherited from TimeSeriesDatabaseConnectionProperties)
ProvisioningState	The provisioning state. (Inherited from TimeSeriesDatabaseConnectionProperties)
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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DataExplorerConnectionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DataExplorerConnectionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<TimeSeriesDatabaseConnectionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from TimeSeriesDatabaseConnectionProperties)
IJsonModel<TimeSeriesDatabaseConnectionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from TimeSeriesDatabaseConnectionProperties)
IPersistableModel<DataExplorerConnectionProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<DataExplorerConnectionProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DataExplorerConnectionProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<TimeSeriesDatabaseConnectionProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from TimeSeriesDatabaseConnectionProperties)
IPersistableModel<TimeSeriesDatabaseConnectionProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from TimeSeriesDatabaseConnectionProperties)
IPersistableModel<TimeSeriesDatabaseConnectionProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from TimeSeriesDatabaseConnectionProperties)