[AppConfig] Add "list labels" and "filter by tags" supports (#35210)

Author: Yalin Li

sdk/appconfiguration/azure-appconfiguration/CHANGELOG.md

@@ -3,13 +3,19 @@
 ## 1.6.1 (Unreleased)
 
 ### Features Added
-
-### Breaking Changes
+- Added operation `list_labels()` for listing configuration setting labels.
+- Supported filtering by configuration setting tags in `list_configuration_settings()` and `list_revisions()`.
+- Added a new property tags to ConfigurationSettingsFilter to support filtering settings with tags filter for snapshot.
 
 ### Bugs Fixed
 - Fixed a bug where the `feature_id` of `FeatureFlagConfigurationSetting` will be different from `id` customer field, and may overwrite the original customer-defined value if different from the `FeatureFlagConfigurationSetting` key suffix.
 
 ### Other Changes
+- Updated the default `api_version` to "2023-11-01".
+- Published enum `LabelFields` and model `ConfigurationSettingLabel`.
+- Published enum `SnapshotFields`, and accepted the type for `fields` parameter in `get_snapshot()` and `list_snapshots()`.
+- Published enum `ConfigurationSettingFields`, and accepted the type for `fields` parameter in `list_configuration_settings()` and `list_revisions()`.
+- Published enum `SnapshotComposition`, and accepted the type for `ConfigurationSnapshot` property `composition_type` and `begion_create_snapshot()` kwarg `composition_type`.
 
 ## 1.6.0 (2024-04-09)
 

sdk/appconfiguration/azure-appconfiguration/README.md

@@ -179,7 +179,7 @@ There are two ways to store a Configuration Setting:
 
 - add_configuration_setting creates a setting only if the setting does not already exist in the store.
 
-<!-- SNIPPET:hello_world_advanced_sample.create_config_setting -->
+<!-- SNIPPET:hello_world_sample.create_config_setting -->
 
 ```python
 config_setting = ConfigurationSetting(
@@ -192,7 +192,7 @@ added_config_setting = client.add_configuration_setting(config_setting)
 
 - set_configuration_setting creates a setting if it doesn't exist or overrides an existing setting.
 
-<!-- SNIPPET:hello_world_advanced_sample.set_config_setting -->
+<!-- SNIPPET:hello_world_sample.set_config_setting -->
 
 ```python
 added_config_setting.value = "new value"
@@ -202,11 +202,33 @@ updated_config_setting = client.set_configuration_setting(added_config_setting)
 
 <!-- END SNIPPET -->
 
+### Set and clear read-only for a configuration setting.
+
+- Set a configuration setting to be read-only.
+
+<!-- SNIPPET:read_only_sample.set_read_only -->
+
+```python
+read_only_config_setting = client.set_read_only(updated_config_setting)
+```
+
+<!-- END SNIPPET -->
+
+- Clear read-only for a configuration setting.
+
+<!-- SNIPPET:read_only_sample.clear_read_only -->
+
+```python
+read_write_config_setting = client.set_read_only(updated_config_setting, False)
+```
+
+<!-- END SNIPPET -->
+
 ### Get a Configuration Setting
 
 Get a previously stored Configuration Setting.
 
-<!-- SNIPPET:hello_world_advanced_sample.get_config_setting -->
+<!-- SNIPPET:hello_world_sample.get_config_setting -->
 
 ```python
 fetched_config_setting = client.get_configuration_setting(key="MyKey", label="MyLabel")
@@ -218,49 +240,84 @@ fetched_config_setting = client.get_configuration_setting(key="MyKey", label="My
 
 Delete an existing Configuration Setting.
 
-<!-- SNIPPET:hello_world_advanced_sample.delete_config_setting -->
+<!-- SNIPPET:hello_world_sample.delete_config_setting -->
 
 ```python
-client.delete_configuration_setting(
-    key="MyKey",
-    label="MyLabel",
-)
+client.delete_configuration_setting(key="MyKey", label="MyLabel")
 ```
 
 <!-- END SNIPPET -->
 
 ### List Configuration Settings
 
-List all configuration settings filtered with label_filter and/or key_filter.
+List all configuration settings filtered with label_filter and/or key_filter and/or tags_filter.
+
+<!-- SNIPPET:list_configuration_settings_sample.list_configuration_settings -->
+
+```python
+config_settings = client.list_configuration_settings(key_filter="MyKey*", tags_filter=["my tag1=my tag1 value"])
+for config_setting in config_settings:
+    print(config_setting)
+```
+
+<!-- END SNIPPET -->
+
+### List revisions
+
+List revision history of configuration settings filtered with label_filter and/or key_filter and/or tags_filter.
+
+<!-- SNIPPET:list_revision_sample.list_revisions -->
+
+```python
+items = client.list_revisions(key_filter="MyKey", tags_filter=["my tag=my tag value"])
+for item in items:
+    print(item)
+```
+
+<!-- END SNIPPET -->
+
+### List labels
+
+List labels of all configuration settings.
 
-<!-- SNIPPET:hello_world_advanced_sample.list_config_setting -->
+<!-- SNIPPET:list_labels_sample.list_labels -->
 
 ```python
-config_settings = client.list_configuration_settings(label_filter="MyLabel")
-for item in config_settings:
-    print_configuration_setting(item)
+print("List all labels in resource")
+config_settings = client.list_labels()
+for config_setting in config_settings:
+    print(config_setting)
+
+print("List labels by exact match")
+config_settings = client.list_labels(name="my label1")
+for config_setting in config_settings:
+    print(config_setting)
+
+print("List labels by wildcard")
+config_settings = client.list_labels(name="my label*")
+for config_setting in config_settings:
+    print(config_setting)
 ```
 
 <!-- END SNIPPET -->
 
 ### Create a Snapshot
 
-<!-- SNIPPET:snapshot_samples.create_snapshot -->
+<!-- SNIPPET:snapshot_sample.create_snapshot -->
 
 ```python
 from azure.appconfiguration import ConfigurationSettingsFilter
 
 filters = [ConfigurationSettingsFilter(key="my_key1", label="my_label1")]
 response = client.begin_create_snapshot(name=snapshot_name, filters=filters)
 created_snapshot = response.result()
-print_snapshot(created_snapshot)
 ```
 
 <!-- END SNIPPET -->
 
 ### Get a Snapshot
 
-<!-- SNIPPET:snapshot_samples.get_snapshot -->
+<!-- SNIPPET:snapshot_sample.get_snapshot -->
 
 ```python
 received_snapshot = client.get_snapshot(name=snapshot_name)
@@ -270,52 +327,50 @@ received_snapshot = client.get_snapshot(name=snapshot_name)
 
 ### Archive a Snapshot
 
-<!-- SNIPPET:snapshot_samples.archive_snapshot -->
+<!-- SNIPPET:snapshot_sample.archive_snapshot -->
 
 ```python
 archived_snapshot = client.archive_snapshot(name=snapshot_name)
-print_snapshot(archived_snapshot)
 ```
 
 <!-- END SNIPPET -->
 
 ### Recover a Snapshot
 
-<!-- SNIPPET:snapshot_samples.recover_snapshot -->
+<!-- SNIPPET:snapshot_sample.recover_snapshot -->
 
 ```python
 recovered_snapshot = client.recover_snapshot(name=snapshot_name)
-print_snapshot(recovered_snapshot)
 ```
 
 <!-- END SNIPPET -->
 
 ### List Snapshots
 
-<!-- SNIPPET:snapshot_samples.list_snapshots -->
+<!-- SNIPPET:snapshot_sample.list_snapshots -->
 
 ```python
 for snapshot in client.list_snapshots():
-    print_snapshot(snapshot)
+    print(snapshot)
 ```
 
 <!-- END SNIPPET -->
 
 ### List Configuration Settings of a Snapshot
 
-<!-- SNIPPET:snapshot_samples.list_configuration_settings_for_snapshot -->
+<!-- SNIPPET:snapshot_sample.list_configuration_settings_for_snapshot -->
 
 ```python
 for config_setting in client.list_configuration_settings(snapshot_name=snapshot_name):
-    print_configuration_setting(config_setting)
+    print(config_setting)
 ```
 
 <!-- END SNIPPET -->
 
 ### Async APIs
 
 Async client is supported.
-To use the async client library, import the AzureAppConfigurationClient from package azure.appconfiguration.aio instead of azure.appconfiguration
+To use the async client library, import the AzureAppConfigurationClient from package azure.appconfiguration.aio instead of azure.appconfiguration.
 
 <!-- SNIPPET:hello_world_sample_async.create_app_config_client -->
 
@@ -325,88 +380,31 @@ from azure.appconfiguration.aio import AzureAppConfigurationClient
 
 CONNECTION_STRING = os.environ["APPCONFIGURATION_CONNECTION_STRING"]
 
-# Create app config client
+# Create an app config client
 client = AzureAppConfigurationClient.from_connection_string(CONNECTION_STRING)
 ```
 
 <!-- END SNIPPET -->
 
-This async AzureAppConfigurationClient has the same method signatures as the sync ones except that they're async.
-For instance, to retrieve a Configuration Setting asynchronously, async_client can be used:
+This async AzureAppConfigurationClient has the same method signatures as the sync ones except that they're async.\
+For instance, retrieve a Configuration Setting asynchronously:
 
-<!-- SNIPPET:hello_world_advanced_sample_async.get_config_setting -->
+<!-- SNIPPET:hello_world_sample_async.get_config_setting -->
 
 ```python
 fetched_config_setting = await client.get_configuration_setting(key="MyKey", label="MyLabel")
 ```
 
 <!-- END SNIPPET -->
 
-To use list_configuration_settings, call it synchronously and iterate over the returned async iterator asynchronously
-
-<!-- SNIPPET:hello_world_advanced_sample_async.list_config_setting -->
-
-```python
-config_settings = client.list_configuration_settings(label_filter="MyLabel")
-async for item in config_settings:
-    print_configuration_setting(item)
-```
-
-<!-- END SNIPPET -->
-
-<!-- SNIPPET:snapshot_samples_async.create_snapshot -->
-
-```python
-from azure.appconfiguration import ConfigurationSettingsFilter
-
-filters = [ConfigurationSettingsFilter(key="my_key1", label="my_label1")]
-response = await client.begin_create_snapshot(name=snapshot_name, filters=filters)
-created_snapshot = await response.result()
-print_snapshot(created_snapshot)
-```
-
-<!-- END SNIPPET -->
-
-<!-- SNIPPET:snapshot_samples_async.get_snapshot -->
-
-```python
-received_snapshot = await client.get_snapshot(name=snapshot_name)
-```
-
-<!-- END SNIPPET -->
-
-<!-- SNIPPET:snapshot_samples_async.archive_snapshot -->
-
-```python
-archived_snapshot = await client.archive_snapshot(name=snapshot_name)
-print_snapshot(archived_snapshot)
-```
-
-<!-- END SNIPPET -->
-
-<!-- SNIPPET:snapshot_samples_async.recover_snapshot -->
-
-```python
-recovered_snapshot = await client.recover_snapshot(name=snapshot_name)
-print_snapshot(recovered_snapshot)
-```
-
-<!-- END SNIPPET -->
-
-<!-- SNIPPET:snapshot_samples_async.list_snapshots -->
-
-```python
-async for snapshot in client.list_snapshots():
-    print_snapshot(snapshot)
-```
-
-<!-- END SNIPPET -->
+To list configuration settings, call `list_configuration_settings` operation synchronously and iterate over the returned async iterator asynchronously:
 
-<!-- SNIPPET:snapshot_samples_async.list_configuration_settings_for_snapshot -->
+<!-- SNIPPET:list_configuration_settings_sample_async.list_configuration_settings -->
 
 ```python
-async for config_setting in client.list_configuration_settings(snapshot_name=snapshot_name):
-    print_configuration_setting(config_setting)
+config_settings = client.list_configuration_settings(key_filter="MyKey*", tags_filter=["my tag1=my tag1 value"])
+async for config_setting in config_settings:
+    print(config_setting)
 ```
 
 <!-- END SNIPPET -->
@@ -421,11 +419,13 @@ See the [troubleshooting guide][troubleshooting_guide] for details on how to dia
 
 Several App Configuration client library samples are available to you in this GitHub repository.  These include:
 - [Hello world](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_sample_async.py)
-- [Hello world with labels](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_advanced_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_advanced_sample_async.py)
+- [List configuration settings](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/list_configuration_settings_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/list_configuration_settings_sample_async.py)
 - [Make a configuration setting readonly](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/read_only_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_sample_async.py)
 - [Read revision history](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/list_revision_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/list_revision_sample_async.py)
 - [Get a setting if changed](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/conditional_operation_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/conditional_operation_sample_async.py)
-- [Create, retrieve and update status of a configuration settings snapshot](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/snapshot_samples.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/snapshot_samples_async.py)
+- [Create, retrieve and update status of a configuration settings snapshot](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/snapshot_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/snapshot_sample_async.py)
+- [Send custom HTTP requests](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/send_request_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/send_request_sample_async.py)
+- [Update AzureAppConfigurationClient sync_token](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/sync_token_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/sync_token_sample_async.py)
 
  For more details see the [samples README](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appconfiguration/azure-appconfiguration/samples/README.md).
 

sdk/appconfiguration/azure-appconfiguration/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/appconfiguration/azure-appconfiguration",
-  "Tag": "python/appconfiguration/azure-appconfiguration_27c8f82a12"
+  "Tag": "python/appconfiguration/azure-appconfiguration_6552b5023e"
 }

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/__init__.py

@@ -15,10 +15,17 @@
     ConfigurationSetting,
     FeatureFlagConfigurationSetting,
     SecretReferenceConfigurationSetting,
-    ConfigurationSnapshot,
     ConfigurationSettingsFilter,
+    ConfigurationSnapshot,
+    ConfigurationSettingLabel,
+)
+from ._generated.models import (
+    SnapshotStatus,
+    LabelFields,
+    SnapshotFields,
+    ConfigurationSettingFields,
+    SnapshotComposition,
 )
-from ._generated.models import SnapshotStatus
 from ._version import VERSION
 from ._azure_appconfiguration_error import ResourceReadOnlyError
 
@@ -31,7 +38,12 @@
     "SecretReferenceConfigurationSetting",
     "ConfigurationSnapshot",
     "SnapshotStatus",
+    "SnapshotFields",
+    "SnapshotComposition",
+    "LabelFields",
+    "ConfigurationSettingFields",
     "ConfigurationSettingsFilter",
+    "ConfigurationSettingLabel",
     "FILTER_PERCENTAGE",
     "FILTER_TARGETING",
     "FILTER_TIME_WINDOW",