Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventHubConnectionConfig

Package version

Describes the connection config object that is created after parsing an EventHub connection string. It also provides some convenience methods for getting the address and audience for different entities.

Hierarchy

  • any
    • EventHubConnectionConfig

Index

Properties

Methods

Properties

entityPath

entityPath: string
property

{string} entityPath - The name/path of the entity (event hub name) to which the connection needs to happen.

Methods

getManagementAddress

  • getManagementAddress(): string

getManagementAudience

  • getManagementAudience(): string

  • Provides the EventHub Management audience.

    • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/$management"

    Returns string

getReceiverAddress

  • getReceiverAddress(partitionId: string | number, consumergroup?: undefined | string): string

  • Provides the EventHub Receiver address:

    • "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"

    Parameters

    • partitionId: string | number

      The partitionId in the EventHub from which messages will be received.

    • Optional consumergroup: undefined | string

      The consumergoup in the EventHub from which the messages will be received. Default: $default.

    Returns string

getReceiverAudience

  • getReceiverAudience(partitionId: string | number, consumergroup?: undefined | string): string

  • Provides the EventHub Receiver audience.

    • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"

    Parameters

    • partitionId: string | number

      The partitionId in the EventHub from which messages will be received.

    • Optional consumergroup: undefined | string

      The consumergoup in the EventHub from which the messages will be received. Default: $default.

    Returns string

getSenderAddress

  • getSenderAddress(partitionId?: string | number): string

  • Provides the EventHub Sender address in one of the following forms based on the input:

    • "<hubName>"
    • "<hubName>/Partitions/<partitionId>"

    Parameters

    • Optional partitionId: string | number

      The partitionId in the EventHub to which messages will be sent.

    Returns string

getSenderAudience

  • getSenderAudience(partitionId?: string | number): string

  • Provides the EventHub Sender audience in one of the following forms based on the input:

    • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
    • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>"

    Parameters

    • Optional partitionId: string | number

      The partitionId in the EventHub to which messages will be sent.

    Returns string

Generated using TypeDoc