Azure App Configuration - JavaScript Provider

Azure App Configuration is a managed service that helps developers centralize their application configurations simply and securely. The JavaScript configuration provider library enables loading configuration from an Azure App Configuration store in a managed way.

This client library adds additional functionality above the Azure SDK for JavaScript.

Getting started

Quickstart: A quickstart guide about how to use the JavaScript configuration provider library.

Feature Flag Quickstart: A quickstart guide about how to integrate feature flags from Azure App Configuration into your JavaScript applications.

Dynamic Configuration Tutorial: A tutorial about how to enable dynamic configuration in your JavaScript applications.

Feature Overview: This document provides a feature status overview.

Feature Reference: This document provides a full feature rundown.

Prerequisites

• An Azure Subscription
• An App Configuration resource

Install the package

npm install @azure/app-configuration-provider

Use the API

import { load } from "@azure/app-configuration-provider";

// Load settings from App Configuration as a readonly Map.
const settings = await load("<app-configuration-connection-string>");

// Consume the settings by calling `get(key)`, e.g.
const value = settings.get("<key-of-a-config>");

Examples

See code snippets under examples/ folder.

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. For more information see the Code of Conduct FAQ or contact [email protected] 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. 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.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry by setting the environment variable AZURE_APP_CONFIGURATION_TRACING_DISABLED to TRUE. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.