Azure Appconfiguration Py

1---
2name: azure-appconfiguration-py
3description: |
4  Azure App Configuration SDK for Python. Use for centralized configuration management, feature flags, and dynamic settings.
5  Triggers: "azure-appconfiguration", "AzureAppConfigurationClient", "feature flags", "configuration", "key-value settings".
6package: azure-appconfiguration
7---
8 
9# Azure App Configuration SDK for Python
10 
11Centralized configuration management with feature flags and dynamic settings.
12 
13## Installation
14 
15```bash
16pip install azure-appconfiguration
17```
18 
19## Environment Variables
20 
21```bash
22AZURE_APPCONFIGURATION_CONNECTION_STRING=Endpoint=https://<name>.azconfig.io;Id=...;Secret=...
23# Or for Entra ID:
24AZURE_APPCONFIGURATION_ENDPOINT=https://<name>.azconfig.io
25```
26 
27## Authentication
28 
29### Connection String
30 
31```python
32from azure.appconfiguration import AzureAppConfigurationClient
33 
34client = AzureAppConfigurationClient.from_connection_string(
35    os.environ["AZURE_APPCONFIGURATION_CONNECTION_STRING"]
36)
37```
38 
39### Entra ID
40 
41```python
42from azure.appconfiguration import AzureAppConfigurationClient
43from azure.identity import DefaultAzureCredential
44 
45client = AzureAppConfigurationClient(
46    base_url=os.environ["AZURE_APPCONFIGURATION_ENDPOINT"],
47    credential=DefaultAzureCredential()
48)
49```
50 
51## Configuration Settings
52 
53### Get Setting
54 
55```python
56setting = client.get_configuration_setting(key="app:settings:message")
57print(f"{setting.key} = {setting.value}")
58```
59 
60### Get with Label
61 
62```python
63# Labels allow environment-specific values
64setting = client.get_configuration_setting(
65    key="app:settings:message",
66    label="production"
67)
68```
69 
70### Set Setting
71 
72```python
73from azure.appconfiguration import ConfigurationSetting
74 
75setting = ConfigurationSetting(
76    key="app:settings:message",
77    value="Hello, World!",
78    label="development",
79    content_type="text/plain",
80    tags={"environment": "dev"}
81)
82 
83client.set_configuration_setting(setting)
84```
85 
86### Delete Setting
87 
88```python
89client.delete_configuration_setting(
90    key="app:settings:message",
91    label="development"
92)
93```
94 
95## List Settings
96 
97### All Settings
98 
99```python
100settings = client.list_configuration_settings()
101for setting in settings:
102    print(f"{setting.key} [{setting.label}] = {setting.value}")
103```
104 
105### Filter by Key Prefix
106 
107```python
108settings = client.list_configuration_settings(
109    key_filter="app:settings:*"
110)
111```
112 
113### Filter by Label
114 
115```python
116settings = client.list_configuration_settings(
117    label_filter="production"
118)
119```
120 
121## Feature Flags
122 
123### Set Feature Flag
124 
125```python
126from azure.appconfiguration import ConfigurationSetting
127import json
128 
129feature_flag = ConfigurationSetting(
130    key=".appconfig.featureflag/beta-feature",
131    value=json.dumps({
132        "id": "beta-feature",
133        "enabled": True,
134        "conditions": {
135            "client_filters": []
136        }
137    }),
138    content_type="application/vnd.microsoft.appconfig.ff+json;charset=utf-8"
139)
140 
141client.set_configuration_setting(feature_flag)
142```
143 
144### Get Feature Flag
145 
146```python
147setting = client.get_configuration_setting(
148    key=".appconfig.featureflag/beta-feature"
149)
150flag_data = json.loads(setting.value)
151print(f"Feature enabled: {flag_data['enabled']}")
152```
153 
154### List Feature Flags
155 
156```python
157flags = client.list_configuration_settings(
158    key_filter=".appconfig.featureflag/*"
159)
160for flag in flags:
161    data = json.loads(flag.value)
162    print(f"{data['id']}: {'enabled' if data['enabled'] else 'disabled'}")
163```
164 
165## Read-Only Settings
166 
167```python
168# Make setting read-only
169client.set_read_only(
170    configuration_setting=setting,
171    read_only=True
172)
173 
174# Remove read-only
175client.set_read_only(
176    configuration_setting=setting,
177    read_only=False
178)
179```
180 
181## Snapshots
182 
183### Create Snapshot
184 
185```python
186from azure.appconfiguration import ConfigurationSnapshot, ConfigurationSettingFilter
187 
188snapshot = ConfigurationSnapshot(
189    name="v1-snapshot",
190    filters=[
191        ConfigurationSettingFilter(key="app:*", label="production")
192    ]
193)
194 
195created = client.begin_create_snapshot(
196    name="v1-snapshot",
197    snapshot=snapshot
198).result()
199```
200 
201### List Snapshot Settings
202 
203```python
204settings = client.list_configuration_settings(
205    snapshot_name="v1-snapshot"
206)
207```
208 
209## Async Client
210 
211```python
212from azure.appconfiguration.aio import AzureAppConfigurationClient
213from azure.identity.aio import DefaultAzureCredential
214 
215async def main():
216    credential = DefaultAzureCredential()
217    client = AzureAppConfigurationClient(
218        base_url=endpoint,
219        credential=credential
220    )
221    
222    setting = await client.get_configuration_setting(key="app:message")
223    print(setting.value)
224    
225    await client.close()
226    await credential.close()
227```
228 
229## Client Operations
230 
231| Operation | Description |
232|-----------|-------------|
233| `get_configuration_setting` | Get single setting |
234| `set_configuration_setting` | Create or update setting |
235| `delete_configuration_setting` | Delete setting |
236| `list_configuration_settings` | List with filters |
237| `set_read_only` | Lock/unlock setting |
238| `begin_create_snapshot` | Create point-in-time snapshot |
239| `list_snapshots` | List all snapshots |
240 
241## Best Practices
242 
2431. **Use labels** for environment separation (dev, staging, prod)
2442. **Use key prefixes** for logical grouping (app:database:*, app:cache:*)
2453. **Make production settings read-only** to prevent accidental changes
2464. **Create snapshots** before deployments for rollback capability
2475. **Use Entra ID** instead of connection strings in production
2486. **Refresh settings periodically** in long-running applications
2497. **Use feature flags** for gradual rollouts and A/B testing
250