Overview
This output type sends notifications and alerts to a specified Event Hub URL.
Before you begin
To create this output, you must have an Azure AD token.
- To learn how to create an Azure AD token, review this document from Microsoft.
Review Parameters
Review the following parameters that you can configure in the Edge Delta App:
YAML | Description |
name |
Enter a descriptive name for the output or integration. For outputs, this name will be used to map this destination to a workflow. This parameter is required. Review the following example: name: eventhub-test |
integration_name |
This parameter only appears when you create an individual output. This parameter refers to the organization-level integration created in the Integrations page. If you enter this name, then the rest of the fields will be automatically populated. If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name field. In this situation, the name should be used to refer to the specific instance of the destination in the workflows. This parameter is optional. Review the following example: integration_name: ed-alert-azureevent |
type |
Enter eventhub. This parameter is required. Review the following example: type: eventhub |
endpoint |
Enter the Event Hubs endpoint. This parameter is required. Review the following example: endpoint: https://eventshub-test.servicebus.windows.net/test/messages |
token |
Enter the Azure AD token. This parameter is required. Review the following example: token: "test-token" |
custom_headers and custom_fields |
This parameter is used to customize the notification content. If you do not want to use default fields in a notification, then you can create custom headers and fields. To learn more, see Review Notify Content Parameters. This parameter is optional. Review the following example: notify_content: |
Review Sample Configuration
The following sample configuration displays an output without the name of the organization-level integration:
- name: eventhub-test
type: eventhub
endpoint: https://eventshub-test.servicebus.windows.net/test/messages
token: "test-token"
notify_content:
custom_fields:
"test-field": "test"
custom_headers:
X-header1: "test-header"