EventHubDataConnectionWithManagedIdentity interface

Class representing an event hub data connection with required managed identity.

Extends

Properties

compression

The 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.

eventHubResourceIdForManagedIdentity

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

eventSystemProperties

System properties of the event hub

kind

Kind of the endpoint for the data connection

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.

Inherited Properties

id

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

location

Resource location.

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

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

Property Details

compression

The compression type

compression?: string

Property Value

string

consumerGroup

The event hub consumer group.

consumerGroup?: string

Property Value

string

databaseRouting

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

databaseRouting?: string

Property Value

string

dataFormat

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

dataFormat?: string

Property Value

string

eventHubResourceIdForManagedIdentity

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

eventHubResourceIdForManagedIdentity?: string

Property Value

string

eventSystemProperties

System properties of the event hub

eventSystemProperties?: string[]

Property Value

string[]

kind

Kind of the endpoint for the data connection

kind: "EventHubWithManagedIdentity"

Property Value

"EventHubWithManagedIdentity"

managedIdentityObjectId

The object ID of the managedIdentityResourceId

managedIdentityObjectId?: string

Property Value

string

managedIdentityResourceId

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

managedIdentityResourceId?: string

Property Value

string

mappingRuleName

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

mappingRuleName?: string

Property Value

string

provisioningState

The provisioned state of the resource.

provisioningState?: string

Property Value

string

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.

retrievalStartDate?: Date

Property Value

Date

tableName

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

tableName?: string

Property Value

string

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From DataConnection.id

location

Resource location.

location?: string

Property Value

string

Inherited From DataConnection.location

name

The name of the resource

name?: string

Property Value

string

Inherited From DataConnection.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From DataConnection.systemData

type

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

type?: string

Property Value

string

Inherited From DataConnection.type