Connectors Reference

Event Hubs

Connect to Azure Event Hubs to receive events.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetEventHubs ()

Get all Event Hubs in a namespace

GetConsumerGroups (string eventHubName)

Get all the consumer groups for an event hub

GetContentTypes ()

Get all content types

GenerateEventSchema (string contentType, [Optional]string contentSchema)

Generate event schema

GetPartitionKeys (string eventHubName)

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

 

Triggers:

Name

Summary

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)

When events are available in Event Hub

 

Objects:

Name

Summary

Event

 

Object

 

SendEvent

 

SystemProperties

 

 

Actions:

GetEventHubs

Summary: Get all Event Hubs in a namespace

Description: Get all Event Hubs in a namespace

 

Syntax:

EventHubs.GetEventHubs ()

 

Returns:

          Type:array of (string)

 

GetConsumerGroups

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)

 

GetContentTypes

Summary: Get all content types

Description: Get all content types

 

Syntax:

EventHubs.GetContentTypes ()

 

Returns:

          Type:array of (string)

 

GenerateEventSchema

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

GetContentTypes

contentSchema

string

(content schema of the event)

content schema of the event

False

 

Returns:

          Type:Object

 

GetPartitionKeys

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)

 

SendEvent

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

GetEventHubs

eventData

SendEvent

 

Send Event data

True

partitionKey

string

(Partition key)

Partition key

False

 

Returns:

 

SendEvents

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

GetEventHubs

events

array of (SendEvent)

 

 

True

partitionKey

string

(Partition key)

Partition key

True

 

Returns:

 

Triggers:

Trigger OnNewEvents

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

GetEventHubs

contentType

string

(Content type)

content type of the event

False

GetContentTypes

contentSchema

string

(Content schema)

content schema of the event

False

consumerGroupName

string

(Consumer group name)

Name of the consumer group

False

GetConsumerGroups

minimumPartitionKey

string

(Minimum partition key)

Minimum partition key to read from

False

GetPartitionKeys

maximumPartitionKey

string

(Maximum partition key)

Maximum partition key to read from

False

GetPartitionKeys

maximumEventsCount

integer(int32)

(Maximum events count)

Maximum number of events to read in a batch

False

 

Returns:

          Type:array of (Event)

 


 

Event

Summary:

Description: Event data

 

          Properties:

Name

Type

Summary

ContentData

Object

 

 

Properties

Properties

Properties

Key-value pairs for each application property

SystemProperties

SystemProperties

 

Event Hub's system properties

 

Properties

Summary: Properties

Description: Key-value pairs for each application property

 

          Properties:

Name

Type

Summary

 


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SendEvent

Summary:

Description: Send Event data

 

          Properties:

Name

Type

Summary

ContentData

string(byte)

Content

Content of the event

Properties

Properties

Properties

Key-value pairs for each application property

 

Properties

Summary: Properties

Description: Key-value pairs for each application property

 

          Properties:

Name

Type

Summary

 


 

SystemProperties

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