AppConfiguration-Emulator

KO | EN

gitlite — search

#golang #javascript #go #python3 #react #wordpress #linux #machine-learning #python #typescript #deep-learning #vuejs2

AppConfiguration-Emulator

★ 37 Open GitHub ↗

The Azure App Configuration emulator is a tool that allows you to run Azure App Configuration locally, enabling development and testing without needing to connect to Azure. It's perfect for projects like .NET Aspire and other local development scenarios.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Azure App Configuration Emulator

[![MCR](https://img.shields.io/badge/MCR-mcr.microsoft.com%2Fazure--app--configuration%2Fapp--configuration--emulator-blue)](https://mcr.microsoft.com/artifact/mar/azure-app-configuration/app-configuration-emulator/about)

The Azure App Configuration Emulator is a local development tool that provides a lightweight implementation of the Azure App Configuration service. This emulator allows developers to test and develop applications locally without requiring an active Azure subscription or connection to the cloud service.

![Creating and Retrieving Configuration Demo](https://raw.githubusercontent.com/Azure/AppConfiguration-Emulator/main/docs/images/create-retrieve-demo.gif)

## Features

- **Local Azure App Configuration API**: Emulates the Azure App Configuration REST API
- **Web UI**: Provides a web-based interface for managing configuration settings
- **Multiple Authentication Methods**: Supports HMAC and anonymous authentication
- **Configuration Snapshots**: Supports creating and managing configuration snapshots
- **Cross-platform**: Runs on Windows, macOS, and Linux

## Prerequisites

Before building and running the Azure App Configuration Emulator, ensure you have the following technologies installed:

### For Building and Running
- **.NET 8.0 SDK** - Required for building and running the C# application
  - Download from: https://dotnet.microsoft.com/download/dotnet/8.0
- **Node.js and npm** - Required for building the React/TypeScript UI component
  - Download from: https://nodejs.org/
  - Minimum Node.js version: 16.x or later

## Build

Follow these steps to build the Azure App Configuration Emulator:

### 1. Clone the Repository
```bash
git clone https://github.com/Azure/AppConfiguration-Emulator.git
cd AppConfiguration-Emulator
```

### 2. Restore Dependencies
Restore all .NET package dependencies:
```bash
dotnet restore
```

### 3. Build the Solution
Build the entire solution including the UI components:
```bash
dotnet build
```

## Run

To run the Azure App Configuration Emulator locally:

### Start the Emulator
```bash
dotnet run --project src/Azure.AppConfiguration.Emulator.Host/Azure.AppConfiguration.Emulator.Host.csproj
```

### Access the Application
Once started, the emulator will be available at:
- **API Endpoint**: `http://127.0.0.1:8483`
- **Health Endpoint**: `http://127.0.0.1:8483/health`
- **Web UI**: `http://127.0.0.1:8483` (serves both API and UI)

### Default Configuration
The emulator runs with the following default settings in development mode:
- **Port**: 8483
- **Authentication**: Anonymous authentication enabled
- **Anonymous User Role**: Owner (full permissions)
- **Logging Level**: Debug

### Stopping the Emulator
Press `Ctrl+C` in the terminal to stop the emulator.

## Test

### Running Tests
Currently, there are no automated tests included in this solution.

### Manual Testing
You can manually test the emulator by:

1. **Using the Web UI**: Navigate to `http://127.0.0.1:8483` in your browser
2. **Using REST API**: Make HTTP requests directly to the emulator endpoints

### API Testing Example
```bash
# Example: List configuration settings
curl -X GET "http://127.0.0.1:8483/kv" \
  -H "Accept: application/json"
```

### Import Key-Values with Azure CLI

[Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) 2.83.0 or later supports anonymous authentication for App Configuration data-plane commands. This allows the CLI to connect directly to the emulator without an Azure subscription, credentials, or access keys.

Start the emulator, then confirm that your Azure CLI version is 2.83.0 or later:

```bash
az version
```

Create a local file named `appconfig.json` with the key-values to import:

```json
{
  "Sample:BackgroundColor": "green",
  "Sample:Message": "Hello from the emulator"
}
```

Import the file into the emulator:

```bash
az appconfig kv import --endpoint http://127.0.0.1:8483 --auth-mode anonymous --source file --path ./appconfig.json --format json --yes
```

The import creates new settings and updates existing settings with matching keys and labels. Use `--dry-run` instead of `--yes` to preview the changes without modifying the emulator.

The imported settings have a null label by default. Use `--label <label>` on the import command to apply the same label to every setting in the file.

Verify the imported settings:

```bash
az appconfig kv list --endpoint http://127.0.0.1:8483 --auth-mode anonymous --key "Sample:*" --fields key value --output table
```

## Development

### Configuration
The emulator can be configured through `appsettings.json` and `appsettings.Development.json` files in the Host project.

## Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
trademarks or logos is subject to and must follow 
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.

AppConfiguration-Emulator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README