Share via


EventHubConnectionProperties Class

Definition

Class representing the Kusto event hub connection properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.EventHubConnectionPropertiesTypeConverter))]
public class EventHubConnectionProperties : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IEventHubConnectionProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.EventHubConnectionPropertiesTypeConverter))>]
type EventHubConnectionProperties = class
    interface IEventHubConnectionProperties
    interface IJsonSerializable
Public Class EventHubConnectionProperties
Implements IEventHubConnectionProperties
Inheritance
EventHubConnectionProperties
Attributes
Implements

Constructors

EventHubConnectionProperties()

Creates an new EventHubConnectionProperties instance.

Properties

Compression

The event hub messages compression type

ConsumerGroup

The event hub consumer group.

DatabaseRouting

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

DataFormat

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

EventHubResourceId

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

EventSystemProperty

System properties of the event hub

ManagedIdentityObjectId

The object ID of the managedIdentityResourceId

ManagedIdentityResourceId

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

MappingRuleName

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

ProvisioningState

The provisioned state of the resource.

RetrievalStartDate

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.

TableName

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of EventHubConnectionProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of EventHubConnectionProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IEventHubConnectionProperties.

FromJsonString(String)

Creates a new instance of EventHubConnectionProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of EventHubConnectionProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to