App Configuration references in App Configuration

Open
#852 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
azure
Domain
cloud

Research direction

No files, tests, or entry points are named. Start by reviewing the App Configuration provider behavior and the Key Vault reference example in this issue, then determine how an appconfigref URI should resolve values across configurations; done means aliases resolve consistently while preserving the described key and label behavior.

Written by the indexing model from the issue text.

Description

enhancement service

Currently App Configuration supports adding Azure Key Vault references, and the providers can resolve those values. Azure App Service configuration also supports references like this, but it works with both Key Vault references and App Configuration references.

We would like to have App Configuration references to other App Configuration values, so basically we would like to create aliases inside App Configuration.

The use case is that we have some configuration values that are used by multiple applications and we would like to specify these values at a single place (so if we need to change it, we don't have to find all the configs and modify all of them). An example of this could be the URL of a service endpoint that is used in multiple applications.
On the other hand, we would like to use hierarchic namespaces (or use another App Configuraton for each app) to group the configs of an app. So in the example, we would specify the URL in an app config, and in the application-specific config we would reference that one value as the single source of truth.

Example App Config reference:

{
    "key": "my-application:weather-api-url",
    "label": null,
    "value": "{\"uri\":\"https://my-app-configuration.azconfig.io/configs/weather-api-url\"}",
    "content_type": "application/vnd.microsoft.appconfig.appconfigref+json;charset=utf-8",
    "tags": {}
}
Main config value 
{
    "key": "weather-api-url",
    "label": null,
    "value": "https://weather-service.com/api/",
    "content_type": "",
    "tags": {}
}
Similar Key Vault reference 
{
    "key": "my-application:weather-api-url",
    "label": null,
    "value": "{\"uri\":\"https://my-keyvault.vault.azure.net/secrets/weather-api-url\"}",
    "content_type": "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8",
    "tags": {}
}

Compared to a Key Vault reference, the content type would use appconfigref instead of keyvaultref, and the uri in the value would point to an App Config value.

Dominant language
No language data
Stars
263
Forks
82
Avg merge
3d 15h
Merged PRs (30d)
6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/AppConfiguration

All issues in Azure/AppConfiguration

Similar issues

More Cloud issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.