Fixing App Configuration Provider Readme (#46611)

* Updating readme

* removing aad

* fixing a few entra id items

* updating snippets and samples

* review items

* Update test_azureappconfigurationproviderbase.py

* Update README.md

* fixing readme

* fix snippets

* Update README.md

Author: mrm9084

sdk/appconfiguration/azure-appconfiguration-provider/README.md

@@ -65,6 +65,9 @@ def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     configurations from azure-keyvault-secrets. This is optional if keyvault_credential is provided. If a credential
     isn't provided a credential will need to be in each set for each.
     :keyword Callable[[str], str] secret_resolver: A function that takes a URI and returns a value.
+    :keyword int secret_refresh_interval: The interval in seconds at which to refresh resolved Key Vault secrets.
+    Only applies when Key Vault references are being resolved. If not specified, secrets are not periodically
+    refreshed. Minimum value is 1 second.
     :keyword List[Tuple[str, str]] refresh_on: One or more settings whose modification will trigger a full refresh
     after a fixed interval. This should be a list of Key-Label pairs for specific settings (filters and wildcards are
     not supported).
@@ -136,6 +139,9 @@ def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     configurations from azure-keyvault-secrets. This is optional if keyvault_credential is provided. If a credential
     isn't provided a credential will need to be in each set for each.
     :keyword Callable[[str], str] secret_resolver: A function that takes a URI and returns a value.
+    :keyword int secret_refresh_interval: The interval in seconds at which to refresh resolved Key Vault secrets.
+    Only applies when Key Vault references are being resolved. If not specified, secrets are not periodically
+    refreshed. Minimum value is 1 second.
     :keyword List[Tuple[str, str]] refresh_on: One or more settings whose modification will trigger a full refresh
     after a fixed interval. This should be a list of Key-Label pairs for specific settings (filters and wildcards are
     not supported).

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_load.py

@@ -68,6 +68,9 @@ async def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     configurations from azure-keyvault-secrets. This is optional if keyvault_credential is provided. If a credential
     isn't provided a credential will need to be in each set for each.
     :keyword Callable[[str], str] secret_resolver: A function that takes a URI and returns a value.
+    :keyword int secret_refresh_interval: The interval in seconds at which to refresh resolved Key Vault secrets.
+    Only applies when Key Vault references are being resolved. If not specified, secrets are not periodically
+    refreshed. Minimum value is 1 second.
     :keyword List[Tuple[str, str]] refresh_on: One or more settings whose modification will trigger a full refresh
     after a fixed interval. This should be a list of Key-Label pairs for specific settings (filters and wildcards are
     not supported).
@@ -139,6 +142,9 @@ async def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     configurations from azure-keyvault-secrets. This is optional if keyvault_credential is provided. If a credential
     isn't provided a credential will need to be in each set for each.
     :keyword Callable[[str], str] secret_resolver: A function that takes a URI and returns a value.
+    :keyword int secret_refresh_interval: The interval in seconds at which to refresh resolved Key Vault secrets.
+    Only applies when Key Vault references are being resolved. If not specified, secrets are not periodically
+    refreshed. Minimum value is 1 second.
     :keyword List[Tuple[str, str]] refresh_on: One or more settings whose modification will trigger a full refresh
     after a fixed interval. This should be a list of Key-Label pairs for specific settings (filters and wildcards are
     not supported).

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_async_load.py

@@ -46,7 +46,7 @@ pip install azure.appconfiguration.provider
 
 | File | Description |
 |-------------|-------------|
-| aad_sample.py | demos connecting to app configuration with Azure Active Directory |
+| entra_id_sample.py | demos connecting to app configuration with Entra ID |
 | connection_string_sample.py | demos connecting to app configuration with a Connection String |
 | key_vault_reference_sample.py | demos resolving key vault references with App Configuration |
 

sdk/appconfiguration/azure-appconfiguration-provider/samples/README.md

@@ -16,16 +16,22 @@ async def main():
     credential = get_credential(authority, is_async=True)
     kwargs = get_client_modifications()
 
-    # Connecting to Azure App Configuration using AAD
+    # [START create_provider_entra_id_async]
+    from azure.appconfiguration.provider.aio import load
+
+    # Connecting to Azure App Configuration using Entra ID
     config = await load(endpoint=endpoint, credential=credential, **kwargs)
     print(config["message"])
 
     await credential.close()
     await config.close()
+    # [END create_provider_entra_id_async]
 
-    # Connecting to Azure App Configuration using AAD and trim key prefixes
+    # [START trim_prefixes_entra_id_async]
+    # Connecting to Azure App Configuration using Entra ID and trim key prefixes
     trimmed = ["test."]
     config = await load(endpoint=endpoint, credential=credential, trim_prefixes=trimmed, **kwargs)
+    # [END trim_prefixes_entra_id_async]
 
     print(config["message"])
 

sdk/appconfiguration/azure-appconfiguration-provider/samples/aad_sample.py

@@ -17,7 +17,7 @@ async def main():
     credential = get_credential(authority, is_async=True)
     kwargs = get_client_modifications()
 
-    # Connection to Azure App Configuration using AAD with Provided Client
+    # Connection to Azure App Configuration using Entra ID with Provided Client
     client_configs = {key_vault_uri: {"credential": credential}}
     selects = [SettingSelector(key_filter="*", label_filter="prod")]
     config = await load(

…ion-provider/samples/async_aad_sample.py …rovider/samples/async_entra_id_sample.pysdk/appconfiguration/azure-appconfiguration-provider/samples/async_aad_sample.py renamed to sdk/appconfiguration/azure-appconfiguration-provider/samples/async_entra_id_sample.py sdk/appconfiguration/azure-appconfiguration-provider/samples/async_aad_sample.py renamed to sdk/appconfiguration/azure-appconfiguration-provider/samples/async_entra_id_sample.py

@@ -16,7 +16,7 @@ async def main():
     credential = get_credential(authority, is_async=True)
     kwargs = get_client_modifications()
 
-    # Connection to Azure App Configuration using AAD and Resolving Key Vault References
+    # Connection to Azure App Configuration using Entra ID and Resolving Key Vault References
     selects = [SettingSelector(key_filter="*", label_filter="prod")]
 
     config = await load(

sdk/appconfiguration/azure-appconfiguration-provider/samples/async_key_vault_reference_provided_clients_sample.py

@@ -13,6 +13,7 @@
     FeatureFlagConfigurationSetting,
 )
 from azure.identity.aio import DefaultAzureCredential
+from sample_utilities import get_client_modifications
 from azure.appconfiguration.provider.aio import load
 from azure.appconfiguration.provider import SettingSelector
 
@@ -70,9 +71,11 @@ async def main():
     created_snapshot = await poller.result()
     print(f"Created snapshot: {created_snapshot.name} with status: {created_snapshot.status}")
 
+    kwargs = get_client_modifications()
+
     # Step 2: Loading configuration settings from the snapshot
     snapshot_selects = [SettingSelector(snapshot_name=snapshot_name)]
-    config = await load(endpoint=endpoint, credential=credential, selects=snapshot_selects)
+    config = await load(endpoint=endpoint, credential=credential, selects=snapshot_selects, **kwargs)
 
     print("Configuration settings from snapshot:")
     for key, value in config.items():
@@ -84,7 +87,7 @@ async def main():
         SettingSelector(snapshot_name=snapshot_name),  # Load all settings from snapshot
         SettingSelector(key_filter="override.*", label_filter="prod"),  # Also load specific override settings
     ]
-    config_mixed = await load(endpoint=endpoint, credential=credential, selects=mixed_selects)
+    config_mixed = await load(endpoint=endpoint, credential=credential, selects=mixed_selects, **kwargs)
 
     print("\nMixed configuration (snapshot + filtered settings):")
     for key, value in config_mixed.items():
@@ -98,6 +101,7 @@ async def main():
         credential=credential,
         selects=feature_flag_selects,
         feature_flag_enabled=True,
+        **kwargs,
     )
 
     print(f"\nFeature flags loaded: {'feature_management' in config_with_flags}")

sdk/appconfiguration/azure-appconfiguration-provider/samples/async_key_vault_reference_sample.py

@@ -10,21 +10,36 @@
 kwargs = get_client_modifications()
 connection_string = os.environ["APPCONFIGURATION_CONNECTION_STRING"]
 
+# [START create_provider_connection_string]
+import os
+from azure.appconfiguration.provider import load
+
+connection_string = os.environ["APPCONFIGURATION_CONNECTION_STRING"]
+
 # Connecting to Azure App Configuration using connection string
 config = load(connection_string=connection_string, **kwargs)
+# [END create_provider_connection_string]
 
 print(config["message"])
 print(config["my_json"]["key"])
 
+# [START trim_prefixes_connection_string]
+from azure.appconfiguration.provider import load
+
 # Connecting to Azure App Configuration using connection string and trimmed key prefixes
 trimmed = ["test."]
 config = load(connection_string=connection_string, trim_prefixes=trimmed, **kwargs)
+# [END trim_prefixes_connection_string]
 
 print(config["message"])
 
+# [START setting_selector_connection_string]
+from azure.appconfiguration.provider import load, SettingSelector
+
 # Connection to Azure App Configuration using SettingSelector
 selects = [SettingSelector(key_filter="message*")]
 config = load(connection_string=connection_string, selects=selects, **kwargs)
+# [END setting_selector_connection_string]
 
 print("message found: " + str("message" in config))
 print("test.message found: " + str("test.message" in config))