Skip to content

Commit 4f96d9e

Browse files
Update docs with new 'Get*ClientOptions()' overloads for Azure builders. (#208)
1 parent 0309df8 commit 4f96d9e

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ linked here:
2828
object being created by `ConfigurationManager.OpenConfiguration*` API's rather than being part of a fully-initialized runtime configuration stack.
2929
* Json use has migrated to use `System.Text.Json` instead of `Newtonsoft.Json`.
3030
* The [Azure Config Builders](#azure-config-builders) have been updated to require a newer minimum version of `Azure.Identity` by default which allows for more
31-
methods of connecting to Azure, such as **User-Assigned Managed Identity**, or **Client Certificate-based** via environment variables. An overload named
32-
`GetCredential` has also been added for users who need something more custom than upgrading `Azure.Identity` can easily provide.
31+
methods of connecting to Azure, such as **User-Assigned Managed Identity**, or **Client Certificate-based** via environment variables. Also a pair of overloads
32+
(`GetCredential` and `GetSecretClientOptions/GetConfigurationClientOptions`) have been added for users who need something more than `DefaultAzureCredential`
33+
with default client options can provide.
3334
* Added *RecursionGuard* to help detect and prevent situations where a `ConfigurationBuilder` accessing values from a `ConfigurationSection` other than the one
3435
which it is currently processing could result in stack overflow.
3536
* `optional` attribute is obsolete => [`enabled`](docs/KeyValueConfigBuilders.md#enabled) attribute which provides more versatility. (The `optional` attribute is still parsed and recognized in the absence

docs/KeyValueConfigBuilders.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,10 @@ to read the necessary options for these methods via environment variables. Build
184184
their Azure credential for these builders can extend and override the `GetCredential()` method of either builder to supply the correct
185185
`TokenCredential` for connecting to Azure.
186186

187+
In a similar vein to `GetCredential()`, builders who need finer control over the way it connects to Azure, the `GetConfigurationClientOptions()`
188+
and `GetSecretClientOptions()` virtual methods have been added to the Azure config builders to support special scenarios. (For
189+
example, connecting to Azure through a proxy.)
190+
187191
NOTE: These packages both currently depend on version ***1.2*** of the `Azure.Identity` nuget package. This version was chosen because
188192
it has a fairly comprehensive list of capabilities for `DefaultAzureCredential` but also is a relatively early version of this SDK package.
189193
This way these builders won't be responsible for forcing unwanted package upgrades when not necessary. However, `DefaultAzureCredential`

0 commit comments

Comments
 (0)