Azure App Configuration client library samples for JavaScript
These sample programs show how to use the JavaScript client libraries for Azure App Configuration in some common scenarios.
| File Name | Description |
|---|---|
| helloworld.js | Demonstrates the CRUD operations on the configuration settings. |
| snapshot.js | Demonstrates the CRUD operations on the snapshot. |
| helloworldWithLabels.js | This sample builds on concepts in helloworld.ts and shows you how to use labels. |
| optimisticConcurrencyViaEtag.js | Demonstrates implementing optimistic concurrency using App Configuration and etags. |
| setReadOnlySample.js | Demonstrates making a configuration setting read-only. This can help prevent accidental deletion or modification of a setting. |
| updateSyncTokenSample.js | The AppConfiguration service supports EventGrid-based setting change notifications. This sample shows how to process these notifications. Due to the distributed nature of the AppConfiguration service, the synchronization token needs to be registered with the client to get the most up-to-date value of the setting. The ConfigurationClient.UpdateSyncToken is used to register the synchronization token. |
| getSettingOnlyIfChanged.js | Demonstrates getting a setting only if it has changed from what you already have. (This allows your app to avoid downloading the contents of a setting if the value is unchanged.) |
| listConfigurationSettings.js | Demonstrates listing multiple configuration settings using a filter for a key or label. |
| listRevisions.js | Demonstrates listing revisions for a configuration setting. |
| secretReference.js | SecretReference represents a configuration setting that references as KeyVault secret. |
| featureFlag.js | Feature flags are settings that follow specific JSON schema for the value. |
Prerequisites
The sample programs are compatible with LTS versions of Node.js.
You need an Azure subscription and the following Azure resources to run these sample programs:
Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.
Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.
Setup
To run the samples using the published version of the package:
- Install the dependencies using
npm:
npm install
Edit the file
sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file fromsample.envto just.env. The sample programs will read this file automatically.Run whichever samples you like (note that some samples may require additional setup, see the table above):
node helloworld.js
Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):
npx cross-env AZ_CONFIG_ENDPOINT="<az config endpoint>" node helloworld.js
Next Steps
Take a look at our API Documentation for more information about the APIs that are available in the clients.