EventProcessorClient Constructors

Definition

Overloads

EventProcessorClient()

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient(BlobContainerClient, String, String)

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient(BlobContainerClient, String, String, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient(BlobContainerClient, String, String, String)

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient(BlobContainerClient, String, String, String, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient(BlobContainerClient, String, String, String, TokenCredential, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

EventProcessorClient()

Initializes a new instance of the EventProcessorClient class.

protected EventProcessorClient ();
Protected Sub New ()

Applies to

EventProcessorClient(BlobContainerClient, String, String)

Initializes a new instance of the EventProcessorClient class.

public EventProcessorClient (Azure.Storage.Blobs.BlobContainerClient checkpointStore, string consumerGroup, string connectionString);
new Azure.Messaging.EventHubs.EventProcessorClient : Azure.Storage.Blobs.BlobContainerClient * string * string -> Azure.Messaging.EventHubs.EventProcessorClient
Public Sub New (checkpointStore As BlobContainerClient, consumerGroup As String, connectionString As String)

Parameters

checkpointStore
BlobContainerClient

The client responsible for persisting checkpoints and processor state to durable storage. The associated container is expected to exist.

consumerGroup
String

The name of the consumer group this processor is associated with. Events are read in the context of this group.

connectionString
String

The connection string to use for connecting to the Event Hubs namespace; it is expected that the Event Hub name and the shared key properties are contained in this connection string.

Remarks

The container associated with the checkpointStore is expected to exist; the EventProcessorClient does not assume the ability to manage the storage account and is safe to run with only read/write permission for blobs in the container.

If the connection string is copied from the Event Hubs namespace, it will likely not contain the name of the desired Event Hub, which is needed. In this case, the name can be added manually by adding ";EntityPath=[[ EVENT HUB NAME ]]" to the end of the connection string. For example, ";EntityPath=telemetry-hub".

 If you have defined a shared access policy directly on the Event Hub itself, then copying the connection string from that
 Event Hub will result in a connection string that contains the name.</p>

Applies to

EventProcessorClient(BlobContainerClient, String, String, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

public EventProcessorClient (Azure.Storage.Blobs.BlobContainerClient checkpointStore, string consumerGroup, string connectionString, Azure.Messaging.EventHubs.EventProcessorClientOptions clientOptions);
new Azure.Messaging.EventHubs.EventProcessorClient : Azure.Storage.Blobs.BlobContainerClient * string * string * Azure.Messaging.EventHubs.EventProcessorClientOptions -> Azure.Messaging.EventHubs.EventProcessorClient
Public Sub New (checkpointStore As BlobContainerClient, consumerGroup As String, connectionString As String, clientOptions As EventProcessorClientOptions)

Parameters

checkpointStore
BlobContainerClient

The client responsible for persisting checkpoints and processor state to durable storage. The associated container is expected to exist.

consumerGroup
String

The name of the consumer group this processor is associated with. Events are read in the context of this group.

connectionString
String

The connection string to use for connecting to the Event Hubs namespace; it is expected that the Event Hub name and the shared key properties are contained in this connection string.

clientOptions
EventProcessorClientOptions

The set of options to use for this processor.

Remarks

The container associated with the checkpointStore is expected to exist; the EventProcessorClient does not assume the ability to manage the storage account and is safe to run with only read/write permission for blobs in the container.

If the connection string is copied from the Event Hubs namespace, it will likely not contain the name of the desired Event Hub, which is needed. In this case, the name can be added manually by adding ";EntityPath=[[ EVENT HUB NAME ]]" to the end of the connection string. For example, ";EntityPath=telemetry-hub".

 If you have defined a shared access policy directly on the Event Hub itself, then copying the connection string from that
 Event Hub will result in a connection string that contains the name.</p>

Applies to

EventProcessorClient(BlobContainerClient, String, String, String)

Initializes a new instance of the EventProcessorClient class.

public EventProcessorClient (Azure.Storage.Blobs.BlobContainerClient checkpointStore, string consumerGroup, string connectionString, string eventHubName);
new Azure.Messaging.EventHubs.EventProcessorClient : Azure.Storage.Blobs.BlobContainerClient * string * string * string -> Azure.Messaging.EventHubs.EventProcessorClient
Public Sub New (checkpointStore As BlobContainerClient, consumerGroup As String, connectionString As String, eventHubName As String)

Parameters

checkpointStore
BlobContainerClient

The client responsible for persisting checkpoints and processor state to durable storage. The associated container is expected to exist.

consumerGroup
String

The name of the consumer group this processor is associated with. Events are read in the context of this group.

connectionString
String

The connection string to use for connecting to the Event Hubs namespace; it is expected that the shared key properties are contained in this connection string, but not the Event Hub name.

eventHubName
String

The name of the specific Event Hub to associate the processor with.

Remarks

The container associated with the checkpointStore is expected to exist; the EventProcessorClient does not assume the ability to manage the storage account and is safe to run with only read/write permission for blobs in the container.

If the connection string is copied from the Event Hub itself, it will contain the name of the desired Event Hub, and can be used directly without passing the eventHubName. The name of the Event Hub should be passed only once, either as part of the connection string or separately.

Applies to

EventProcessorClient(BlobContainerClient, String, String, String, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

public EventProcessorClient (Azure.Storage.Blobs.BlobContainerClient checkpointStore, string consumerGroup, string connectionString, string eventHubName, Azure.Messaging.EventHubs.EventProcessorClientOptions clientOptions);
new Azure.Messaging.EventHubs.EventProcessorClient : Azure.Storage.Blobs.BlobContainerClient * string * string * string * Azure.Messaging.EventHubs.EventProcessorClientOptions -> Azure.Messaging.EventHubs.EventProcessorClient
Public Sub New (checkpointStore As BlobContainerClient, consumerGroup As String, connectionString As String, eventHubName As String, clientOptions As EventProcessorClientOptions)

Parameters

checkpointStore
BlobContainerClient

The client responsible for persisting checkpoints and processor state to durable storage. The associated container is expected to exist.

consumerGroup
String

The name of the consumer group this processor is associated with. Events are read in the context of this group.

connectionString
String

The connection string to use for connecting to the Event Hubs namespace; it is expected that the shared key properties are contained in this connection string, but not the Event Hub name.

eventHubName
String

The name of the specific Event Hub to associate the processor with.

clientOptions
EventProcessorClientOptions

The set of options to use for this processor.

Remarks

The container associated with the checkpointStore is expected to exist; the EventProcessorClient does not assume the ability to manage the storage account and is safe to run with only read/write permission for blobs in the container.

If the connection string is copied from the Event Hub itself, it will contain the name of the desired Event Hub, and can be used directly without passing the eventHubName. The name of the Event Hub should be passed only once, either as part of the connection string or separately.

Applies to

EventProcessorClient(BlobContainerClient, String, String, String, TokenCredential, EventProcessorClientOptions)

Initializes a new instance of the EventProcessorClient class.

public EventProcessorClient (Azure.Storage.Blobs.BlobContainerClient checkpointStore, string consumerGroup, string fullyQualifiedNamespace, string eventHubName, Azure.Core.TokenCredential credential, Azure.Messaging.EventHubs.EventProcessorClientOptions clientOptions = default);
new Azure.Messaging.EventHubs.EventProcessorClient : Azure.Storage.Blobs.BlobContainerClient * string * string * string * Azure.Core.TokenCredential * Azure.Messaging.EventHubs.EventProcessorClientOptions -> Azure.Messaging.EventHubs.EventProcessorClient
Public Sub New (checkpointStore As BlobContainerClient, consumerGroup As String, fullyQualifiedNamespace As String, eventHubName As String, credential As TokenCredential, Optional clientOptions As EventProcessorClientOptions = Nothing)

Parameters

checkpointStore
BlobContainerClient

The client responsible for persisting checkpoints and processor state to durable storage. The associated container is expected to exist.

consumerGroup
String

The name of the consumer group this processor is associated with. Events are read in the context of this group.

fullyQualifiedNamespace
String

The fully qualified Event Hubs namespace to connect to. This is likely to be similar to {yournamespace}.servicebus.windows.net.

eventHubName
String

The name of the specific Event Hub to associate the processor with.

credential
TokenCredential

The Azure identity credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

clientOptions
EventProcessorClientOptions

The set of options to use for this processor.

Remarks

The container associated with the checkpointStore is expected to exist; the EventProcessorClient does not assume the ability to manage the storage account and is safe to run with only read/write permission for blobs in the container.

Applies to