
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@azure/app-configuration
Advanced tools
An isomorphic client library for the Azure App Configuration service.
Azure App Configuration is a managed service that helps developers centralize their application and feature settings simply and securely.
Use the client library for App Configuration to:
Key links:
npm install @azure/app-configuration
See our support policy for more details.
You can use the Azure Portal or the Azure CLI to create an Azure App Configuration resource.
Example (Azure CLI):
az appconfig create --name <app-configuration-resource-name> --resource-group <resource-group-name> --location eastus
AppConfigurationClient can authenticate using a service principal or using a connection string.
Authentication via service principal is done by:
@azure/identity
package.Using DefaultAzureCredential
const azureIdentity = require("@azure/identity");
const appConfig = require("@azure/app-configuration");
const credential = new azureIdentity.DefaultAzureCredential();
const client = new appConfig.AppConfigurationClient(
endpoint, // ex: <https://<your appconfig resource>.azconfig.io>
credential
);
More information about @azure/identity
can be found here
To authenticate with a resource in a Sovereign Cloud, you will need to set the authorityHost
in the credential options or via the AZURE_AUTHORITY_HOST
environment variable.
const { AppConfigurationClient } = require("@azure/app-configuration");
const { DefaultAzureCredential, AzureAuthorityHosts } = require("@azure/identity");
// Create an AppConfigurationClient that will authenticate through AAD in the China cloud
const client = new AppConfigurationClient(
endpoint, // ex: <https://<your appconfig resource>.azconfig.azure.cn>
new DefaultAzureCredential({ authorityHost: AzureAuthorityHosts.AzureChina })
);
More information about @azure/identity
can be found here
To get the Primary connection string for an App Configuration resource you can use this Azure CLI command:
az appconfig credential list -g <resource-group-name> -n <app-configuration-resource-name> --query "([?name=='Primary'].connectionString)[0]"
And in code you can now create your App Configuration client with the connection string you got from the Azure CLI:
const client = new AppConfigurationClient("<connection string>");
The AppConfigurationClient
has some terminology changes from App Configuration in the portal.
ConfigurationSetting
objectsisReadOnly
field, which you can toggle using setReadOnly
.ConfigurationSnapshot
objects.The client follows a simple design methodology - ConfigurationSetting
can be passed into any method that takes a ConfigurationSettingParam
or ConfigurationSettingId
.
This means this pattern works:
const setting = await client.getConfigurationSetting({
key: "hello"
});
setting.value = "new value!";
await client.setConfigurationSetting(setting);
// fields unrelated to just identifying the setting are simply
// ignored (for instance, the `value` field)
await client.setReadOnly(setting, true);
// delete just needs to identify the setting so other fields are
// just ignored
await client.deleteConfigurationSetting(setting);
or, for example, re-getting a setting:
let setting = await client.getConfigurationSetting({
key: "hello"
});
// re-get the setting
setting = await client.getConfigurationSetting(setting);
The 2022-11-01-preview
API version supports configuration snapshots: immutable, point-in-time copies of a configuration store. Snapshots can be created with filters that determine which key-value pairs are contained within the snapshot, creating an immutable, composed view of the configuration store. This feature enables applications to hold a consistent view of configuration, ensuring that there are no version mismatches to individual settings due to reading as updates were made. For example, this feature can be used to create "release configuration snapshots" within an App Configuration. See the create and get a snapshot section in the example below.
const appConfig = require("@azure/app-configuration");
const client = new appConfig.AppConfigurationClient(
"<App Configuration connection string goes here>"
);
async function run() {
const newSetting = await client.setConfigurationSetting({
key: "testkey",
value: "testvalue",
// Labels allow you to create variants of a key tailored
// for specific use-cases like supporting multiple environments.
// https://docs.microsoft.com/azure/azure-app-configuration/concept-key-value#label-keys
label: "optional-label"
});
const retrievedSetting = await client.getConfigurationSetting({
key: "testkey",
label: "optional-label"
});
console.log("Retrieved value:", retrievedSetting.value);
}
run().catch((err) => console.log("ERROR:", err));
beginCreateSnapshot
gives you the poller to poll for the snapshot creation.
const { AppConfigurationClient } = require("@azure/app-configuration");
const client = new AppConfigurationClient(
"<App Configuration connection string goes here>"
);
async function run() {
const key = "testkey";
const value = "testvalue";
const label = "optional-label";
await client.addConfigurationSetting({
key,
value,
label
});
const poller = await client.beginCreateSnapshot({
name:"testsnapshot",
retentionPeriod: 2592000,
filters: [{keyFilter: key, labelFilter: label}],
});
const snapshot = await poller.pollUntilDone();
}
run().catch((err) => console.log("ERROR:", err));
You can also use beginCreateSnapshotAndWait
to have the result of the creation directly after the polling is done.
const snapshot = await client.beginCreateSnapshotAndWait({
name:"testsnapshot",
retentionPeriod: 2592000,
filters: [{keyFilter: key, labelFilter: label}],
});
const retrievedSnapshot = await client.getSnapshot("testsnapshot");
console.log("Retrieved snapshot:", retrievedSnapshot);
ConfigurationSetting
in the snapshotconst retrievedSnapshotSettings = await client.listConfigurationSettingsForSnapshot("testsnapshot");
for await (const setting of retrievedSnapshotSettings) {
console.log(`Found key: ${setting.key}, label: ${setting.label}`);
}
const snapshots = await client.listSnapshots();
for await (const snapshot of snapshots) {
console.log(`Found snapshot: ${snapshot.name}`);
}
// Snapshot is in ready status
const archivedSnapshot = await client.archiveSnapshot("testsnapshot");
console.log("Snapshot updated status is:", archivedSnapshot.status);
// Snapshot is in archive status
const recoverSnapshot = await client.recoverSnapshot("testsnapshot");
console.log("Snapshot updated status is:", recoverSnapshot.status);
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL
environment variable to info
. Alternatively, logging can be enabled at runtime by calling setLogLevel
in the @azure/logger
:
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.
React Native does not support some JavaScript API used by this SDK library so you need to provide polyfills for them. Please see our React Native sample with Expo for more details.
The following samples show you the various ways you can interact with App Configuration:
helloworld.ts
- Get, set, and delete configuration values.helloworldWithLabels.ts
- Use labels to add additional dimensions to your settings for scenarios like beta vs production.optimisticConcurrencyViaEtag.ts
- Set values using etags to prevent accidental overwrites.setReadOnlySample.ts
- Marking settings as read-only to prevent modification.getSettingOnlyIfChanged.ts
- Get a setting only if it changed from the last time you got it.listRevisions.ts
- List the revisions of a key, allowing you to see previous values and when they were set.secretReference.ts
- SecretReference represents a configuration setting that references as KeyVault secret.snapshot.ts
- Create, list configuration settings, and archive snapshots.featureFlag.ts
- Feature flags are settings that follow specific JSON schema for the value.More in-depth examples can be found in the samples folder on GitHub.
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.
This module's tests are a mixture of live and unit tests, which require you to have an Azure App Configuration instance. To execute the tests you'll need to run:
rush update
rush build -t @azure/app-configuration
sdk\appconfiguration\app-configuration
folder:
APPCONFIG_CONNECTION_STRING=connection string for your App Configuration instance
cd sdk\appconfiguration\app-configuration
npm run test
.View our tests folder for more details.
FAQs
An isomorphic client library for the Azure App Configuration service.
The npm package @azure/app-configuration receives a total of 77,228 weekly downloads. As such, @azure/app-configuration popularity was classified as popular.
We found that @azure/app-configuration demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.