IotHubDataConnection interface
Class representing an iot hub data connection.
- Extends
Properties
| consumer |
The iot hub consumer group. |
| database |
Indication for database routing information from the data connection, by default only database routing information is allowed |
| data |
The data format of the message. Optionally the data format can be added to each message. |
| event |
System properties of the iot hub |
| iot |
The resource ID of the Iot hub to be used to create a data connection. |
| kind | Kind of the endpoint for the data connection |
| mapping |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
| provisioning |
The provisioned state of the resource. |
| retrieval |
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. |
| shared |
The name of the share access policy |
| table |
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 |
| system |
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
consumerGroup
The iot hub consumer group.
consumerGroup?: stringProperty Value
string
databaseRouting
Indication for database routing information from the data connection, by default only database routing information is allowed
databaseRouting?: stringProperty Value
string
dataFormat
The data format of the message. Optionally the data format can be added to each message.
dataFormat?: stringProperty 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?: stringProperty Value
string
kind
Kind of the endpoint for the data connection
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?: stringProperty Value
string
provisioningState
The provisioned state of the resource.
provisioningState?: stringProperty 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?: DateProperty Value
Date
sharedAccessPolicyName
The name of the share access policy
sharedAccessPolicyName?: stringProperty Value
string
tableName
The table where the data should be ingested. Optionally the table information can be added to each message.
tableName?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From DataConnection.id
location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From DataConnection.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From DataConnection.type
