IotHubDataConnection interface

Package:

@azure/arm-kusto

Class representing an iot hub data connection.

Extends

DataConnection

Properties

consumerGroup	The iot 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.
eventSystemProperties	System properties of the iot hub
iotHubResourceId	The resource ID of the Iot hub to be used to create a data connection.
kind	Polymorphic discriminator, which specifies the different types this object can be
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. NOTE: This property will not be serialized. It can only be populated by the server.
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.
sharedAccessPolicyName	The name of the share access policy
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} NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

consumerGroup

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

eventSystemProperties

System properties of the iot hub

eventSystemProperties?: string[]

Property Value

string[]

iotHubResourceId

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

iotHubResourceId?: string

Property Value

string

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "IotHub"

Property Value

"IotHub"

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

sharedAccessPolicyName

The name of the share access policy

sharedAccessPolicyName?: string

Property Value

string

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} NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From DataConnection.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From DataConnection.type