This repository contains the scripts required to install and run the Azure Event Hubs Emulator.
Azure Event Hubs is a cloud native data streaming service that can stream millions of events per second, with low latency, from any source to any destination. Event Hubs is compatible with Apache Kafka, and it enables you to run existing Kafka workloads without any code changes. Read more here.
Azure Event Hubs emulator is designed to offer a local development experience for Azure Event Hubs, enabling you to develop and test code against our services in isolation, free from cloud interference.
[!CAUTION] Emulator is intended solely for development and testing scenarios.Any kind of Production use is strictly discouraged. There is no official support provided for Emulator. Any issues/suggestions should be reported via GitHub issues on GitHub project.
Run Azure Event Hubs Emulator
This section summarizes the steps to develop and test locally with Event hubs Emulator. To read more about Event hubs, read here.
[!NOTE] Before you continue with the subsequent steps, make sure Docker Engine is operational in the background.
This section highlights different steps to run Event Hubs Emulator. Details are as follows:
Before running automated script, clone the installation repository locally.
After completing the prerequisites, you can proceed with the following steps to run the Event Hubs Emulator locally.
$>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser’
LaunchEmulator.ps1
. Running the script would bring up two containers – Event Hubs Emulator & Azurite (dependency for Emulator)After completing the prerequisites, you can proceed with the following steps to run the Event Hubs Emulator locally.
LaunchEmulator.sh
. Running the script would bring up two containers – Event Hubs Emulator & Azurite (dependency for Emulator)You can also spin up Emulator using Docker Compose file from Microsoft Container Registry. Refer here for details.
Once the steps are successful, Emulator compose set can be found in running in Docker.
"Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"
To get started, refer to our GitHub Samples here.
[!TIP] $Default consumer group is created by default when emulator runs. You can't create $default consumer group with supplied configuration.
Support
There is no official support provided for Emulator.Any issues/suggestions should be reported via GitHub issues on installation repo.
The scripts and documentation in this project are released under the MIT License.
The software (Azure Event Hubs Emulator) that the scripts in this repository install is licensed under separate terms. See the End User License Agreement for the terms governing the software.