appconfiguration Package

Packages

aio

Classes

AsyncConfigurationSettingPaged

An async iterable of ConfigurationSettings that supports etag-based change detection.

This class provides asynchronous iteration over configuration settings, with optional support for etag-based change detection. By supplying a list of etags via the match_conditions parameter to the by_page method, you can efficiently detect and retrieve only those pages that have changed since your last retrieval.

Example:


   async for setting in AsyncConfigurationSettingPaged(...):
       # Process each setting asynchronously
       print(setting)

   # To iterate by page and use etag-based change detection:
   etags = ["etag1", "etag2", "etag3"]
   async for page in paged.by_page(match_conditions=etags):
       async for setting in page:
           print(setting)

When match_conditions is provided, each page is checked against the corresponding etag. If the page has not changed (HTTP 304), it is skipped. If the page has changed (HTTP 200), the new page is returned. This allows efficient polling for changes without retrieving unchanged data.

Return an async iterator of items.

args and kwargs will be passed to the AsyncPageIterator constructor directly, except page_iterator_class

AzureAppConfigurationClient

Represents a client that calls restful API of Azure App Configuration service.

ConfigurationSetting

A setting, defined by a unique combination of a key and label.

ConfigurationSettingLabel

The label info of a configuration setting.

ConfigurationSettingPaged

An iterable of ConfigurationSettings that supports etag-based change detection.

This class extends ItemPaged to provide efficient monitoring of configuration changes by using ETags. When used with the match_conditions parameter in by_page(), it only returns pages that have changed since the provided ETags were collected.

Example:


   # Get initial page ETags
   items = client.list_configuration_settings(key_filter="sample_*")
   match_conditions = [page.etag for page in items.by_page()]

   # Later, check for changes - only changed pages are returned
   items = client.list_configuration_settings(key_filter="sample_*")
   for page in items.by_page(match_conditions=match_conditions):
       # Process only changed pages
       pass

Return an iterator of items.

args and kwargs will be passed to the PageIterator constructor directly, except page_iterator_class

ConfigurationSettingsFilter

Enables filtering of configuration settings.

ConfigurationSnapshot

A point-in-time snapshot of configuration settings.

FeatureFlagConfigurationSetting

A configuration setting that stores a feature flag value.

ResourceReadOnlyError

An error response with status code 409

The key is read-only.

To allow modification unlock it first.

SecretReferenceConfigurationSetting

A configuration value that references a configuration setting secret.

Enums

ConfigurationSettingFields

Key-value fields.

LabelFields

Label fields.

SnapshotComposition

Composition types.

SnapshotFields

Snapshot fields.

SnapshotStatus

Snapshot status.