@azure/app-configuration package

Classes

AppConfigurationClient	Client for the Azure App Configuration service.
FeatureFlagClient	Client for managing feature flags through the dedicated feature flag endpoint of the Azure App Configuration service. This requires the 2026-05-01-preview API version or later.

Interfaces

AddConfigurationSettingOptions	Options used when adding a ConfigurationSetting.
AddConfigurationSettingResponse	Response from adding a ConfigurationSetting.
AddFeatureFlagOptions	Options used when adding a feature flag through the dedicated feature flag endpoint.
AddFeatureFlagResponse	Response from adding a feature flag through the dedicated feature flag endpoint.
AppConfigurationClientOptions	Provides configuration options for AppConfigurationClient.
CheckConfigurationSettingsOptions	Options for checkConfigurationSettings that allow for filtering based on keys, labels and other fields.
ConfigurationSettingId	Fields that uniquely identify a configuration setting
ConfigurationSettingsFilter	Enables filtering of key-values. Syntax reference: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot	A snapshot is a named, immutable subset of an App Configuration store's key-values.
CreateSnapshotOptions	Options used when creating a Snapshot.
CreateSnapshotResponse	Response from updating a Snapshot.
DeleteConfigurationSettingOptions	Options for deleting a ConfigurationSetting.
DeleteConfigurationSettingResponse	Response from deleting a ConfigurationSetting.
DeleteFeatureFlagOptions	Options for deleting a feature flag through the dedicated feature flag endpoint.
DeleteFeatureFlagResponse	Response from deleting a feature flag through the dedicated feature flag endpoint.
EtagEntity	Entity with etag.
FeatureFilter	A filter that conditionally enables or disables a feature flag.
FeatureFlagAllocation	Defines how to allocate feature flag variants based on context.
FeatureFlagClientOptions	Provides configuration options for FeatureFlagClient.
FeatureFlagConditions	The conditions that must be met for the feature flag to be enabled.
FeatureFlagId	Fields that uniquely identify a feature flag.
FeatureFlagTelemetryConfiguration	Telemetry configuration for a feature flag.
FeatureFlagValue	Value of a feature flag
FeatureFlagVariantDefinition	A variant of a feature flag.
GetConfigurationHeaders	Headers from getting a ConfigurationSetting.
GetConfigurationSettingOptions	Options for getting a ConfigurationSetting.
GetConfigurationSettingResponse	Response from retrieving a ConfigurationSetting.
GetFeatureFlagOptions	Options for getting a feature flag through the dedicated feature flag endpoint.
GetSnapshotOptions	Options used when getting a Snapshot.
GetSnapshotResponse	Response from getting a Snapshot.
GroupAllocation	Allocates groups to a feature flag variant.
HttpOnlyIfChangedField	Options used to provide if-none-match for an HTTP request
HttpOnlyIfUnchangedField	Options used to provide if-match for an HTTP request
HttpResponseField	HTTP response related information - headers and raw body.
HttpResponseFields	Fields that are hoisted up from the _response field of the object Used in cases where individual HTTP response fields are important for the user to use in common-use cases like handling http status codes 204 or 304.
ListConfigurationSettingPage	A page of configuration settings and the corresponding HTTP response
ListConfigurationSettingsForSnapshotOptions	Common options for 'list' style APIs in AppConfig used to specify wildcards as well as the accept date time header.
ListConfigurationSettingsOptions	Options for listConfigurationSettings that allow for filtering based on keys, labels and other fields. Also provides fields which allows you to selectively choose which fields are populated in the result.
ListFeatureFlagPage	A page of feature flags and the corresponding HTTP response
ListFeatureFlagRevisionsOptions	Options for listFeatureFlagRevisions that allow for filtering based on name, label and tags.
ListFeatureFlagRevisionsPage	A page of feature flag revisions and the corresponding HTTP response
ListFeatureFlagsOptions	Options for listFeatureFlags that allow for filtering based on name, label and tags.
ListLabelsOptions	Options for listLabels
ListLabelsPage	A page of configuration settings and the corresponding HTTP response
ListRevisionsOptions	Options for listRevisions that allow for filtering based on keys, labels and other fields. Also provides fields which allows you to selectively choose which fields are populated in the result.
ListRevisionsPage	A page of configuration settings and the corresponding HTTP response
ListSettingsOptions	Common options for 'list' style APIs in AppConfig used to specify wildcards as well as the accept date time header.
ListSnapshots	Common options for 'list' style APIs in AppConfig used to specify wildcards as well as the accept date time header.
ListSnapshotsOptions	Options for listConfigurationSettings that allow for filtering based on keys, labels and other fields. Also provides fields which allows you to selectively choose which fields are populated in the result.
ListSnapshotsPage	A page of configuration settings and the corresponding HTTP response
OptionalFields	Used when the API supports selectively returning fields.
OptionalLabelsFields	Used when the API supports selectively returning labels fields.
OptionalSnapshotFields	Used when the API supports selectively returning fields.
PageSettings	An interface that tracks the settings for paged iteration
PercentileAllocation	Allocates a percentile range to a feature flag variant.
RetryOptions	Options that control how to retry failed requests.
SecretReferenceValue	Necessary fields for updating or creating a new secret reference.
SetConfigurationSettingOptions	Options used when saving a ConfigurationSetting.
SetConfigurationSettingResponse	Response from setting a ConfigurationSetting.
SetFeatureFlagOptions	Options used when creating or updating a feature flag through the dedicated feature flag endpoint.
SetFeatureFlagResponse	Response from setting a feature flag through the dedicated feature flag endpoint.
SetReadOnlyOptions	Options for setReadOnly
SetReadOnlyResponse	Response when setting a value to read-only.
SettingLabel	Labels are used to group key-values.
SimplePollerLike	A simple poller that can be used to poll a long running operation. This interface mirrors the shape of SimplePollerLike from @azure/core-lro v2 so that the public API surface is preserved while internally using the v3 poller.
SnapshotInfo	Fields that uniquely identify a snapshot
SnapshotReferenceValue	Necessary fields for updating or creating a new snapshot reference.
SnapshotResponse	Response from adding a Snapshot.
SyncTokenHeaderField	Sync token header field
UpdateSnapshotOptions	Options used when updating a Snapshot.
UpdateSnapshotResponse	Response from updating a Snapshot.
UserAllocation	Allocates users to a feature flag variant.

Type Aliases

AddConfigurationSettingParam	Parameters for adding a new configuration setting
AddFeatureFlagParam	Parameters for adding a feature flag through the dedicated feature flag endpoint.
ConfigurationSetting	Configuration setting with extra metadata from the server, indicating its etag, whether it is currently readOnly and when it was last modified.
ConfigurationSettingParam	Necessary fields for updating or creating a new configuration setting
ConfigurationSettingResponse	Standard base response for getting, deleting or updating a configuration setting
ConfigurationSnapshotStatus	Defines values for ConfigurationSnapshotStatus. KnownConfigurationSnapshotStatus can be used interchangeably with ConfigurationSnapshotStatus.
FeatureFlag	A feature flag managed through the dedicated feature flag endpoint.
FeatureFlagFields	Fields that can be selected when retrieving feature flags.
FeatureFlagParam	Necessary fields for updating or creating a feature flag.
GetFeatureFlagResponse	Response from retrieving a feature flag through the dedicated feature flag endpoint. When a conditional request is made with onlyIfChanged and the feature flag has not changed, the service responds with a 304 status and an otherwise empty body. In that case statusCode is 304 and the feature flag fields (other than name) are left unset.
RequirementType	Defines values for the feature flag condition requirement type.
SetConfigurationSettingParam	Parameters for creating or updating a new configuration setting
SetFeatureFlagParam	Parameters for creating or updating a feature flag through the dedicated feature flag endpoint.
SnapshotComposition	Defines values for SnapshotComposition. KnownSnapshotComposition can be used interchangeably with SnapshotComposition.
StatusOverride	Defines values for a feature flag variant status override.

Enums

KnownAppConfigAudience	Known values for Azure App Configuration Audience
KnownAppConfigurationApiVersion	Known service API versions supported by AppConfigurationClient.
KnownConfigurationSnapshotStatus	Known values of ConfigurationSnapshotStatus that the service accepts.
KnownFeatureFlagApiVersion	Known service API versions supported by FeatureFlagClient.
KnownRequirementType	Known values of RequirementType that the service accepts.
KnownSnapshotComposition	Known values of SnapshotComposition that the service accepts.
KnownStatusOverride	Known values of StatusOverride that the service accepts.

Functions

isFeatureFlag(ConfigurationSetting)	Lets you know if the ConfigurationSetting is a feature flag. [Checks if the content type is featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isRestError(unknown)	Typeguard for RestError
isSecretReference(ConfigurationSetting)	Lets you know if the ConfigurationSetting is a secret reference. [Checks if the content type is secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
isSnapshotReference(ConfigurationSetting)	Lets you know if the ConfigurationSetting is a snapshot reference. [Checks if the content type is snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]
parseFeatureFlag(ConfigurationSetting)	Takes the ConfigurationSetting as input and returns the ConfigurationSetting<FeatureFlagValue> by parsing the value string.
parseSecretReference(ConfigurationSetting)	Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SecretReferenceValue> by parsing the value string.
parseSnapshotReference(ConfigurationSetting)	Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SnapshotReferenceValue> by parsing the value string.

Variables

RestError	A custom error type for failed pipeline requests.
featureFlagContentType	The content type for a FeatureFlag
featureFlagPrefix	The prefix for feature flags.
secretReferenceContentType	content-type for the secret reference.
snapshotReferenceContentType	content-type for the snapshot reference.

Function Details

isFeatureFlag(ConfigurationSetting)

Lets you know if the ConfigurationSetting is a feature flag.

[Checks if the content type is featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

function isFeatureFlag(setting: ConfigurationSetting): setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

Parameters

setting

ConfigurationSetting

Returns

setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

isSecretReference(ConfigurationSetting)

Lets you know if the ConfigurationSetting is a secret reference.

[Checks if the content type is secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

function isSecretReference(setting: ConfigurationSetting): setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

Parameters

setting

ConfigurationSetting

Returns

setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

isSnapshotReference(ConfigurationSetting)

Lets you know if the ConfigurationSetting is a snapshot reference.

[Checks if the content type is snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]

function isSnapshotReference(setting: ConfigurationSetting): setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

Parameters

setting

ConfigurationSetting

Returns

setting is ConfigurationSettingId & { contentType?: string, description?: string, tags?: {[propertyName: string]: string} } & { value?: string } & { isReadOnly: boolean, lastModified?: Date } & Required<Pick<ConfigurationSetting, "value">>

parseFeatureFlag(ConfigurationSetting)

Takes the ConfigurationSetting as input and returns the ConfigurationSetting<FeatureFlagValue> by parsing the value string.

function parseFeatureFlag(setting: ConfigurationSetting): ConfigurationSetting<FeatureFlagValue>

Parameters

setting

ConfigurationSetting

Returns

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting)

Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SecretReferenceValue> by parsing the value string.

function parseSecretReference(setting: ConfigurationSetting): ConfigurationSetting<SecretReferenceValue>

Parameters

setting

ConfigurationSetting

Returns

ConfigurationSetting<SecretReferenceValue>

parseSnapshotReference(ConfigurationSetting)

Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SnapshotReferenceValue> by parsing the value string.

function parseSnapshotReference(setting: ConfigurationSetting): ConfigurationSetting<SnapshotReferenceValue>

Parameters

setting

ConfigurationSetting

Returns

ConfigurationSetting<SnapshotReferenceValue>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

featureFlagContentType

The content type for a FeatureFlag

featureFlagContentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"

Type

"application/vnd.microsoft.appconfig.ff+json;charset=utf-8"

featureFlagPrefix

The prefix for feature flags.

featureFlagPrefix: ".appconfig.featureflag/"

Type

".appconfig.featureflag/"

secretReferenceContentType

content-type for the secret reference.

secretReferenceContentType: "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"

Type

"application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"

snapshotReferenceContentType

content-type for the snapshot reference.

snapshotReferenceContentType: "application/json; profile="https://azconfig.io/mime-profiles/snapshot-ref"; charset=utf-8"

Type

"application/json; profile="https://azconfig.io/mime-profiles/snapshot-ref"; charset=utf-8"