Share via


EventHubDataConnection Class

Definition

Class representing an event hub data connection.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.EventHubDataConnectionTypeConverter))]
public class EventHubDataConnection : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IEventHubDataConnection, Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.EventHubDataConnectionTypeConverter))>]
type EventHubDataConnection = class
    interface IEventHubDataConnection
    interface IJsonSerializable
    interface IDataConnection
    interface IResource
    interface IValidates
Public Class EventHubDataConnection
Implements IEventHubDataConnection, IValidates
Inheritance
EventHubDataConnection
Attributes
Implements

Constructors

EventHubDataConnection()

Creates an new EventHubDataConnection 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

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Kind

Kind of the endpoint for the data connection

Location

Resource location.

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.

Name

The name of the resource

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.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of EventHubDataConnection.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of EventHubDataConnection.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of EventHubDataConnection into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to