1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# Release History
## 2.1.1 (Unreleased)
### Features Added
### Breaking Changes
### Bugs Fixed
### Other Changes
## 2.1.0 (2025-04-28)
### Features Added
* Added AllocationId to the feature flag telemetry metadata when the feature flag has telemetry enabled.
## 2.0.2 (2025-04-17)
### Other Changes
* Updates telemetry for JSON usage.
## 2.1.0b1 (2025-04-10)
### Bugs Fixed
* Updates the feature flag telemetry to use the provided endpoint instead of the endpoint of the store the feature flag was loaded from.
* Removes FeatureFlagId from feature flag telemetry.
## 2.0.1 (2025-03-07)
### Bugs Fixed
* Updates the failure to load from a config store from a debug level log to a warning level log.
* Fixes an issue where the stack trace from the azure sdk wasn't being logged on startup.
* Fixes a bug where feature flags could be loaded as configurations.
### Other Changes
* Bumped minimum dependency on `azure-core` to `>=1.30.0`
* Bumped minimum dependency on `azure-appconfiguration` to `>=1.6.1`
## 2.0.0 (2025-01-06)
### Features Added
* Added support for load balancing between replicas.
* Added support for adding telemetry information to feature flags.
## 2.0.0b3 (2024-11-13)
### Breaking Changes
* Allocation Id value changed so other providers can match the value.
## 2.0.0b2 (2024-10-11)
### Feature Added
* Added AllocationId to the feature flag telemetry metadata when the feature flag has telemetry enabled.
### Bugs Fixed
* Fixed a number of cases where snake case was used instead of pascal case for feature flag telemetry.
* etag -> ETag
* feature_flag_reference -> FeatureFlagReference
* feature_flag_id -> FeatureFlagId
## 2.0.0b1 (2024-09-11)
### Features Added
* Added support for feature flag telemetry.
## 1.3.0 (2024-09-09)
### Features Added
* Added support for auto failover between replicas.
* Added support for auto discovery of replicas.
## 1.2.0 (2024-05-24)
### Features Added
* Enable loading of feature flags with `feature_flag_enabled`
* Select Feature Flags to load with `feature_flag_selectors`
* Enable/Disable Feature Flag Refresh with `feature_flag_refresh_enabled`
### Bugs Fixed
* Fixes issue where loading configurations were slower due to returning a copy of the configurations.
## 1.1.0 (2024-01-29)
### Features Added
* New API for Azure App Configuration Provider, `refresh`, which can be used to refresh the configuration from the Azure App Configuration service. `refresh` by default can check every 30 seconds for changes to specified sentinel keys. If a change is detected then all configurations are reloaded. Sentinel keys can be set by passing a list of `SentinelKey`'s to `refresh_on`.
* Added new options `on_refresh_success` and `on_refresh_failure` callbacks to the load method. These callbacks are called when the refresh method successfully refreshes the configuration or fails to refresh the configuration.
### Bugs Fixed
* Verifies that the `refresh_interval` is at least 1 second.
## 1.1.0b3 (2023-12-19)
### Features Added
- Added on_refresh_success callback to load method. This callback is called when the refresh method successfully refreshes the configuration.
- Added minimum up time. This is the minimum amount of time the provider will try to be up before throwing an error. This is to prevent quick restart loops.
### Bugs Fixed
- Fixes issue where the refresh timer only reset after a change was found.
### Other Changes
- Renamed the type `SentinelKey` to be `WatchKey`.
## 1.1.0b2 (2023-09-29)
### Features Added
* Added support for `keyvault_credential`, `keyvault_client_configs`, and `secret_resolver` as `kwargs` instead of using `AzureAppConfigurationKeyVaultOptions`.
### Bugs Fixed
* Fixes issue where `user_agent` was required to be set.
* Fixes issue where correlation context info is wrong on refresh.
## 1.1.0b1 (2023-09-13)
### Features Added
* New API for Azure App Configuration Provider, `refresh`, which can be used to refresh the configuration from the Azure App Configuration service. `refresh` by default can check every 30 seconds for changes to specified sentinel keys. If a change is detected then all configurations are reloaded. Sentinel keys can be set by passing a list of `SentinelKey`'s to `refresh_on`.
* Added support for customer provided user agent prefix.
### Other Changes
* Updated to use AZURE_APP_CONFIGURATION_TRACING_DISABLED environment variable to disable tracing.
* Changed the maximum number of retries to 2 from the default of 3 retries.
* Changed the maximum back off time between retries to 1 minute from the default of 2 minutes.
* Bumped minimum dependency on `azure-core` to `>=1.25.0`
## 1.0.0 (2023-03-09)
### Breaking Changes
* Renamed `load_provider` to `load`
* Added `AzureAppConfigurationKeyVaultOptions` to take in a `client_configs` a Mapping of endpoints to client kwargs instead of taking in the whole client.
* Removed `AzureAppConfigurationKeyVaultOptions` `secret_clients`, `client_configs` should be used instead.
* Made key_filter and label_filter kwargs for Setting Selector
* Renamed `trimmed_key_prefixes` to `trim_prefixes`
### Other Changes
* Made EMPTY_LABEL a constant. i.e. "\0"
## 1.0.0b2 (2023-02-15)
### Features Added
* Added Async Support
* Added missing methods for Mapping API
* Made load method properties unordered.
### Breaking Changes
* Changes how load works. Moves if from AzureAppConfigurationProvider.load to load_provider.
* Removed custom Key Vault Error
* Removed unneeded __repr__ and copy methods.
* All Feature Flags are added to there own key and have there prefix removed
### Bugs Fixed
* Fixed Issue where Key Vault Clients couldn't be set in some situations
### Other Changes
* Updated method docs
* Fixed load doc that used `selector` instead of `selects`.
* Fixed CLI link in Readme.
## 1.0.0b1 (2022-10-13)
New Azure App Configuration Provider
Provides additional support above the Azure App Configuration SDK. Enables:
* Connecting to an Azure App Configuration store
* Selecting multiple keys using Setting Selector
* Resolve Key Vault References when supplied AzureAppConfigurationKeyVaultOptions
The Azure App Configuration Provider once loaded returns a dictionary of key/value pairs to use in configuration.
```python
endpoint = "https://<your-store>.azconfig.io"
default_credential = DefaultAzureCredential()
config = AzureAppConfigurationProvider.load(
endpoint=endpoint, credential=default_credential)
print(config["message"])
```
|
