EventHubStreamInputDataSourceProperties interface
The properties that are associated with a Event Hub input containing stream data.
- Extends
Properties
| consumer |
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group. |
| prefetch |
The number of messages that the message receiver can simultaneously request. |
Inherited Properties
| authentication |
Authentication Mode. |
| event |
The name of the Event Hub. Required on PUT (CreateOrReplace) requests. |
| partition |
The partition count of the event hub data source. Range 1 - 256. |
| service |
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. |
| shared |
The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. |
| shared |
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. |
Property Details
consumerGroupName
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.
consumerGroupName?: string
Property Value
string
prefetchCount
The number of messages that the message receiver can simultaneously request.
prefetchCount?: number
Property Value
number
Inherited Property Details
authenticationMode
Authentication Mode.
authenticationMode?: string
Property Value
string
Inherited From EventHubDataSourceProperties.authenticationMode
eventHubName
The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
eventHubName?: string
Property Value
string
Inherited From EventHubDataSourceProperties.eventHubName
partitionCount
The partition count of the event hub data source. Range 1 - 256.
partitionCount?: number
Property Value
number
Inherited From EventHubDataSourceProperties.partitionCount
serviceBusNamespace
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
serviceBusNamespace?: string
Property Value
string
Inherited From EventHubDataSourceProperties.serviceBusNamespace
sharedAccessPolicyKey
The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey?: string
Property Value
string
Inherited From EventHubDataSourceProperties.sharedAccessPolicyKey
sharedAccessPolicyName
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName?: string
Property Value
string
Inherited From EventHubDataSourceProperties.sharedAccessPolicyName