@azure/app-configuration package

Classes

AppConfigurationClient

Client for the Azure App Configuration service.

Interfaces

AddConfigurationSettingOptions	Options used when adding a ConfigurationSetting.
AddConfigurationSettingResponse	Response from adding a ConfigurationSetting.
AppConfigurationClientOptions	Provides configuration options for AppConfigurationClient.
ConfigurationSettingId	Fields that uniquely identify a configuration setting
ConfigurationSettingsFilter	Enables filtering of key-values. Syntax reference: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot	Snapshot details include name, filters, expiresOn, sizeInBytes, status, itemCount, and more
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.
EtagEntity	Entity with etag.
FeatureFlagValue	Value of a feature flag
GetConfigurationHeaders	Headers from getting a ConfigurationSetting.
GetConfigurationSettingOptions	Options for getting a ConfigurationSetting.
GetConfigurationSettingResponse	Response from retrieving a ConfigurationSetting.
GetSnapshotOptions	Options used when getting a Snapshot.
GetSnapshotResponse	Response from getting a Snapshot.
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.
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
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.
SetReadOnlyOptions	Options for setReadOnly
SetReadOnlyResponse	Response when setting a value to read-only.
SettingLabel	Label details, with name property that can only be populated by the server
SnapshotInfo	Fields that uniquely identify a snapshot
SnapshotResponse	Response from adding a Snapshot.
SyncTokenHeaderField	Sync token header field
UpdateSnapshotOptions	Options used when updating a Snapshot.
UpdateSnapshotResponse	Response from updating a Snapshot.

Type Aliases

AddConfigurationSettingParam	Parameters for adding a new configuration setting
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, this enum contains the known values that the service supports. Known values supported by the service provisioning ready archived failed
SetConfigurationSettingParam	Parameters for creating or updating a new configuration setting
SnapshotComposition	Defines values for SnapshotComposition. KnownSnapshotComposition can be used interchangeably with SnapshotComposition, this enum contains the known values that the service supports. Known values supported by the service key key_label

Enums

KnownConfigurationSnapshotStatus	Known values of ConfigurationSnapshotStatus that the service accepts.
KnownSnapshotComposition	Known values of SnapshotComposition that the service accepts.

Functions

isFeatureFlag(ConfigurationSetting<string>)	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"]
isSecretReference(ConfigurationSetting<string>)	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"]
parseFeatureFlag(ConfigurationSetting<string>)	Takes the ConfigurationSetting as input and returns the ConfigurationSetting by parsing the value string.
parseSecretReference(ConfigurationSetting<string>)	Takes the ConfigurationSetting as input and returns the ConfigurationSetting by parsing the value string.

Function Details

isFeatureFlag(ConfigurationSetting<string>)

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<string>): setting

Parameters

setting

ConfigurationSetting<string>

Returns

setting

isSecretReference(ConfigurationSetting<string>)

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<string>): setting

Parameters

setting

ConfigurationSetting<string>

Returns

setting

parseFeatureFlag(ConfigurationSetting<string>)

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

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

Parameters

setting

ConfigurationSetting<string>

Returns

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

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

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

Parameters

setting

ConfigurationSetting<string>

Returns

ConfigurationSetting<SecretReferenceValue>