Frends.AzureEventHub.Receive / 3.0.0
Summary
Reads events from a consumer group, using a blob container to remember how far it has read so the next run carries on rather than starting over. It listens for a bounded period, so a run ends whether or not events arrived.
Typical use — scheduled consumption of an event stream, where the stored position is what keeps runs from overlapping or repeating
Input parameters.
| Name | Type | Default | Example | Description |
|---|---|---|---|---|
| EventHubName | String |
– | ExampleHub |
Specifies the name of the Event Hub to connect to. |
| ConsumerGroup | String |
– | $Default |
Specifies the name of the consumer group for reading events. If left empty, the default consumer group will be used. |
| MaximumWaitTime | Double |
0 |
0, 10, 10.1 |
Specifies the maximum wait time (in seconds) for an event to become available before emitting an empty event. If set to 0, the processor will wait indefinitely for an event to become available. Note: MaximumWaitTime cannot exceed Options.MaxRunTime when Options.MaxRunTime is greater than 0. |
| ContainerName | String |
– | examplecontainer |
The name of the blob container used for checkpointing. |
| CreateContainer | Boolean |
False |
false |
If true, a new container is created under the specified account if it does not exist. Not supported when using SAS Token as an authentication method. |