Class KustoEventHubDataConnection

Class representing an event hub data connection.

Inheritance
Azure.ResourceManager.Models.ResourceData
KustoDataConnectionData
KustoEventHubDataConnection
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Kusto.dll
Syntax
public class KustoEventHubDataConnection : Azure.ResourceManager.Kusto.KustoDataConnectionData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Kusto.Models.KustoEventHubDataConnection>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Kusto.Models.KustoEventHubDataConnection>

Constructors

KustoEventHubDataConnection()

Initializes a new instance of KustoEventHubDataConnection.

Declaration
public KustoEventHubDataConnection ();

Properties

Compression

The event hub messages compression type.

Declaration
public Nullable<Azure.ResourceManager.Kusto.Models.EventHubMessagesCompressionType> Compression { get; set; }
Property Value
System.Nullable<EventHubMessagesCompressionType>

ConsumerGroup

The event hub consumer group.

Declaration
public string ConsumerGroup { get; set; }
Property Value
System.String

DatabaseRouting

Indication for database routing information from the data connection, by default only database routing information is allowed.

Declaration
public Nullable<Azure.ResourceManager.Kusto.Models.KustoDatabaseRouting> DatabaseRouting { get; set; }
Property Value
System.Nullable<KustoDatabaseRouting>

DataFormat

The data format of the message. Optionally the data format can be added to each message.

Declaration
public Nullable<Azure.ResourceManager.Kusto.Models.KustoEventHubDataFormat> DataFormat { get; set; }
Property Value
System.Nullable<KustoEventHubDataFormat>

EventHubResourceId

The resource ID of the event hub to be used to create a data connection.

Declaration
public Azure.Core.ResourceIdentifier EventHubResourceId { get; set; }
Property Value
Azure.Core.ResourceIdentifier

EventSystemProperties

System properties of the event hub.

Declaration
public System.Collections.Generic.IList<string> EventSystemProperties { get; }
Property Value
System.Collections.Generic.IList<System.String>

ManagedIdentityObjectId

The object ID of the managedIdentityResourceId.

Declaration
public Nullable<Guid> ManagedIdentityObjectId { get; }
Property Value
System.Nullable<System.Guid>

ManagedIdentityResourceId

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

Declaration
public Azure.Core.ResourceIdentifier ManagedIdentityResourceId { get; set; }
Property Value
Azure.Core.ResourceIdentifier

MappingRuleName

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

Declaration
public string MappingRuleName { get; set; }
Property Value
System.String

ProvisioningState

The provisioned state of the resource.

Declaration
public Nullable<Azure.ResourceManager.Kusto.Models.KustoProvisioningState> ProvisioningState { get; }
Property Value
System.Nullable<KustoProvisioningState>

RetrievalStartOn

When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period.

Declaration
public Nullable<DateTimeOffset> RetrievalStartOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

TableName

The table where the data should be ingested. Optionally the table information can be added to each message.

Declaration
public string TableName { get; set; }
Property Value
System.String

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<KustoEventHubDataConnection>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Kusto.Models.KustoEventHubDataConnection IJsonModel<KustoEventHubDataConnection>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
KustoEventHubDataConnection

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<KustoEventHubDataConnection>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<KustoEventHubDataConnection>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<KustoEventHubDataConnection>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Kusto.Models.KustoEventHubDataConnection IPersistableModel<KustoEventHubDataConnection>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
KustoEventHubDataConnection

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<KustoEventHubDataConnection>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<KustoEventHubDataConnection>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<KustoEventHubDataConnection>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<KustoEventHubDataConnection>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.