> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure Event Hub

<Badge className="hny-badge-enterprise-addon" stroke>Ent+</Badge>

<Note>
  This feature is available as an add-on for the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).
  Please contact your Honeycomb account team for details.
</Note>

## Prerequisites

The source must have access to an Azure Event Hub with the necessary permissions, the minimum permission being `Listen`. You can configure resources' Diagnostic settings to send logs to the Azure Event Hub. Read more here: [Azure Event Hub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings).

Each event hub should only accept one telemetry type.

## Supported Platforms

HTP Agent: `v1.39.0`+

| Platform | Metrics | Logs | Traces |
| :------- | :------ | :--- | :----- |
| Linux    | ✓       | ✓    |        |
| Windows  | ✓       | ✓    |        |
| macOS    | ✓       | ✓    |        |

## Configuration

| Field          | Description                                                                                   |
| :------------- | :-------------------------------------------------------------------------------------------- |
| Telemetry Type | The type of telemetry to gather with this receiver.                                           |
| Connection     | A string describing the connection to an Azure event hub.                                     |
| Consumer Group | The Consumer Group to read from. Defaults to `$Default` if empty.                             |
| Partition      | The partition to watch. If empty, it will watch all partitions.                               |
| Offset         | The offset at which to start watching the event hub. If empty, starts with the latest offset. |

## Example Configuration

### Basic Configuration

For basic configuration, the `connection` parameter is required. Optionally, specify <code>consumer group</code>, `partition`, and `offset`.

#### Web Interface

<img src="https://mintcdn.com/honeycomb/xBk0WdKAt1ctZm35/_assets/images/htp/xnapper-azure-event-hub-source.png?fit=max&auto=format&n=xBk0WdKAt1ctZm35&q=85&s=747a0f4cebdf97cbb97e7311f3083e61" alt="Honeycomb Docs - Azure Event Hub Source - image 1" width="2170" height="2034" data-path="_assets/images/htp/xnapper-azure-event-hub-source.png" />

#### Standalone Source

```yaml YAML theme={}
apiVersion: bindplane.observiq.com/v1
kind: Source
metadata:
  id: azure_event_hub
  name: azure_event_hub
spec:
  type: azure_event_hub
  parameters:
    - name: telemetry_types
      value: Logs
    - name: connection
      value: '<your_connection_string>'
    - name: group
      value: '$Default' # optional
    - name: partition
      value: '1' # optional
    - name: offset
      value: '-1' # optional
```
