AzureAppConfigurationClient Class

Add a ConfigurationSetting instance into the Azure App Configuration service.

Example

   config_setting = ConfigurationSetting(
       key="MyKey",
       label="MyLabel",
       value="my value",
       content_type="my content type",
       tags={"my tag": "my tag value"}
   )
   added_config_setting = client.add_configuration_setting(config_setting)

add_configuration_setting(configuration_setting: ConfigurationSetting, **kwargs) -> ConfigurationSetting

Parameters

Returns

Exceptions

Archive a configuration setting snapshot. It will update the status of a snapshot from "ready" to "archived". The retention period will start to count, the snapshot will expire when the entire retention period elapses.

archive_snapshot(name: str, *, match_condition: MatchConditions = MatchConditions.Unconditionally, etag: str | None = None, **kwargs) -> ConfigurationSnapshot

Parameters

Keyword-Only Parameters

Returns

Exceptions

Create a snapshot of the configuration settings.

begin_create_snapshot(name: str, filters: List[ConfigurationSettingsFilter], *, composition_type: str | SnapshotComposition | None = None, retention_period: int | None = None, tags: Dict[str, str] | None = None, **kwargs) -> LROPoller[ConfigurationSnapshot]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Close all connections made by the client

close() -> None

Exceptions

Delete a ConfigurationSetting if it exists

Example

   deleted_config_setting = client.delete_configuration_setting(
       key="MyKey", label="MyLabel"
   )

delete_configuration_setting(key: str, label: str | None = None, *, etag: str | None = None, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs) -> None | ConfigurationSetting

Parameters

Keyword-Only Parameters

Returns

Exceptions

Create AzureAppConfigurationClient from a Connection String.

Example

   from azure.appconfiguration import AzureAppConfigurationClient
   connection_str = "<my connection string>"
   client = AzureAppConfigurationClient.from_connection_string(connection_str)

from_connection_string(connection_string: str, **kwargs: Any) -> AzureAppConfigurationClient

Parameters

Returns

Exceptions

Get the matched ConfigurationSetting from Azure App Configuration service

Example

   fetched_config_setting = client.get_configuration_setting(
       key="MyKey", label="MyLabel"
   )

get_configuration_setting(key: str, label: str | None = None, etag: str | None = '*', match_condition: MatchConditions = MatchConditions.Unconditionally, *, accept_datetime: datetime | str | None = None, **kwargs) -> None | ConfigurationSetting

Parameters

Keyword-Only Parameters

Returns

Exceptions

Get a configuration setting snapshot.

get_snapshot(name: str, *, fields: List[str | SnapshotFields] | None = None, **kwargs) -> ConfigurationSnapshot

Parameters

Keyword-Only Parameters

Returns

Exceptions

list_configuration_settings(*, key_filter: str | None = None, label_filter: str | None = None, tags_filter: List[str] | None = None, accept_datetime: datetime | str | None = None, fields: List[str | ConfigurationSettingFields] | None = None, **kwargs: Any) -> ItemPaged[ConfigurationSetting]

Exceptions

Gets a list of labels.

list_labels(*, name: str | None = None, after: str | None = None, accept_datetime: datetime | str | None = None, fields: List[str | LabelFields] | None = None, **kwargs) -> ItemPaged[ConfigurationSettingLabel]

Keyword-Only Parameters

Returns

Exceptions

Find the ConfigurationSetting revision history, optionally filtered by key, label, tags and accept_datetime. For more information about supported filters, see https://video2.skills-academy.com/azure/azure-app-configuration/rest-api-revisions?pivots=v23-11#supported-filters.

Example

   from datetime import datetime, timedelta

   accept_datetime = datetime.utcnow() + timedelta(days=-1)

   all_revisions = client.list_revisions()
   for item in all_revisions:
       pass  # do something

   filtered_revisions = client.list_revisions(
       label_filter="Labe*", key_filter="Ke*", accept_datetime=str(accept_datetime)
   )
   for item in filtered_revisions:
       pass  # do something

list_revisions(key_filter: str | None = None, label_filter: str | None = None, *, tags_filter: List[str] | None = None, accept_datetime: datetime | str | None = None, fields: List[str | ConfigurationSettingFields] | None = None, **kwargs) -> ItemPaged[ConfigurationSetting]

Parameters

Keyword-Only Parameters

Returns

Exceptions

List the configuration setting snapshots stored in the configuration service, optionally filtered by snapshot name, snapshot status and fields to present in return.

list_snapshots(*, name: str | None = None, fields: List[str | SnapshotFields] | None = None, status: List[str | SnapshotStatus] | None = None, **kwargs) -> ItemPaged[ConfigurationSnapshot]

Keyword-Only Parameters

Returns

Exceptions

Recover a configuration setting snapshot. It will update the status of a snapshot from "archived" to "ready".

recover_snapshot(name: str, *, match_condition: MatchConditions = MatchConditions.Unconditionally, etag: str | None = None, **kwargs) -> ConfigurationSnapshot

Parameters

Keyword-Only Parameters

Returns

Exceptions

Runs a network request using the client's existing pipeline.

The request URL can be relative to the vault URL. The service API version used for the request is the same as the client's unless otherwise specified. This method does not raise if the response is an error; to raise an exception, call raise_for_status() on the returned response object. For more information about how to send custom requests with this method, see https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parameters

Keyword-Only Parameters

Returns

Exceptions

Add or update a ConfigurationSetting. If the configuration setting identified by key and label does not exist, this is a create. Otherwise this is an update.

Example

   config_setting = ConfigurationSetting(
       key="MyKey",
       label="MyLabel",
       value="my set value",
       content_type="my set content type",
       tags={"my set tag": "my set tag value"}
   )
   returned_config_setting = client.set_configuration_setting(config_setting)

set_configuration_setting(configuration_setting: ConfigurationSetting, match_condition: MatchConditions = MatchConditions.Unconditionally, *, etag: str | None = None, **kwargs) -> ConfigurationSetting

Parameters

Keyword-Only Parameters

Returns

Exceptions

Set a configuration setting read only

Example

   config_setting = client.get_configuration_setting(
       key="MyKey", label="MyLabel"
   )

   read_only_config_setting = client.set_read_only(config_setting)
   read_only_config_setting = client.set_read_only(config_setting, read_only=False)

set_read_only(configuration_setting: ConfigurationSetting, read_only: bool = True, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs) -> ConfigurationSetting

Parameters

Keyword-Only Parameters

Returns

Exceptions

Add a sync token to the internal list of tokens.

update_sync_token(token: str) -> None

Parameters

Exceptions