Connectors Reference
Connect to Azure Event Hubs to send and receive events.
|
Status: Production |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get all Event Hubs in a namespace |
|
|
Get all the consumer groups for an event hub |
|
|
Get all content types |
|
|
GenerateEventSchema (string contentType, [Optional]string contentSchema) |
Generate event schema |
|
GenerateEventSchemaV2 (string contentType, [Optional]string contentSchema) |
Generate event schema V2 |
|
Get all partition keys in an Event Hub |
|
|
SendEvent (string eventHubName, SendEvent eventData, [advanced][Optional]string partitionKey) |
Send event |
|
SendEvents (string eventHubName, array events, string partitionKey) |
Send one or more events to the Event Hub partition |
|
Name |
Summary |
|
When events are available in Event Hub |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: Get all Event Hubs in a namespace
Description: Get all Event Hubs in a namespace.
Syntax:
EventHubs.GetEventHubs ()
Returns:
Type:array of (string)
Summary: Get all the consumer groups for an event hub
Description: Get all the consumer groups for an event hub.
Syntax:
EventHubs.GetConsumerGroups (string eventHubName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
eventHubName |
string (The Event Hub name) |
The Event Hub name. |
True |
Returns:
Type:array of (string)
Summary: Get all content types
Description: Get all content types.
Syntax:
EventHubs.GetContentTypes ()
Returns:
Type:array of (string)
Summary: Generate event schema
Description: Generate event schema.
Syntax:
EventHubs.GenerateEventSchema (string contentType, [Optional]string contentSchema)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
contentType |
string (Content type) |
Content type. |
True |
|
|
contentSchema |
string (content schema of the event) |
content schema of the event. |
False |
Returns:
Type:Object
Summary: Generate event schema V2
Description: Generate event schema V2.
Syntax:
EventHubs.GenerateEventSchemaV2 (string contentType, [Optional]string contentSchema)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
contentType |
string (Content type) |
Content type. |
True |
|
|
contentSchema |
string (content schema of the event) |
content schema of the event. |
False |
Returns:
Type:Object
Summary: Get all partition keys in an Event Hub
Description: Get all partition keys in an Event Hub.
Syntax:
EventHubs.GetPartitionKeys (string eventHubName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
eventHubName |
string (The Event Hub name) |
The Event Hub name. |
True |
Returns:
Type:array of (string)
Summary: Send event
Description: Send event.
Syntax:
EventHubs.SendEvent (string eventHubName, SendEvent eventData, [advanced][Optional]string partitionKey)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
eventHubName |
string (Event Hub name) |
Name of the Event Hub. |
True |
|
|
eventData |
|
Send Event data |
True |
|
|
partitionKey |
string (Partition key) |
Partition key. |
False |
Returns:
Summary: Send one or more events to the Event Hub partition
Description: Send one or more events to the Event Hub partition.
Syntax:
EventHubs.SendEvents (string eventHubName, array events, string partitionKey)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
eventHubName |
string (Event Hub name) |
Name of the Event Hub. |
True |
|
|
events |
array of (SendEvent)
|
|
True |
|
|
partitionKey |
string (Partition key) |
Partition key. |
True |
Returns:
Summary: When events are available in Event Hub
Description: When events are available in Event Hub.
Syntax:
EventHubs.OnNewEvents (string eventHubName, [advanced][Optional]string contentType, [advanced][Optional]string contentSchema, [advanced][Optional]string consumerGroupName, [advanced][Optional]string minimumPartitionKey, [advanced][Optional]string maximumPartitionKey, [advanced][Optional]integer maximumEventsCount)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
eventHubName |
string (Event Hub name) |
Name of the Event Hub. |
True |
|
|
contentType |
string (Content type) |
content type of the event. |
False |
|
|
contentSchema |
string (Content schema) |
content schema of the event. |
False |
|
|
consumerGroupName |
string (Consumer group name) |
Name of the consumer group. |
False |
|
|
minimumPartitionKey |
string (Minimum partition key) |
Minimum partition key to read from. |
False |
|
|
maximumPartitionKey |
string (Maximum partition key) |
Maximum partition key to read from. |
False |
|
|
maximumEventsCount |
integer(int32) (Maximum events count) |
Maximum number of events to read in a batch. |
False |
Returns:
Type:array of (Event)
Summary:
Description: Event data
Properties:
|
Name |
Type |
Summary |
|
ContentData |
|
|
|
Properties |
Properties |
Key-value pairs for each application property |
|
SystemProperties |
|
Event Hub's system properties |
Summary: Properties
Description: Key-value pairs for each application property
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Send Event data
Properties:
|
Name |
Type |
Summary |
|
ContentData |
string(byte) Content |
Content of the event |
|
Properties |
Properties |
Key-value pairs for each application property |
Summary: Properties
Description: Key-value pairs for each application property
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Event Hub's system properties
Properties:
|
Name |
Type |
Summary |
|
EnqueuedTimeUtc |
string(date-time) Enqueued time in UTC |
Enqueued time |
|
Offset |
string Offset |
Offset in a partition |
|
PartitionKey |
string Partition Key |
Partition Key |
|
SequenceNumber |
integer(int64) Sequence Number |
Sequence number |