Skip to content

Commit fe215f5

Browse files
update comment to point to use options.connect pattern
1 parent f256759 commit fe215f5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationExtensions.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ private static bool IsProviderDisabled()
3232

3333
/// <summary>
3434
/// Adds key-value data from an Azure App Configuration store to a configuration builder using its connection string.
35+
/// This is a simplified overload that loads all key-values with no label. For advanced scenarios such as selecting specific keys,
36+
/// filtering by labels, configuring refresh, using feature flags, or resolving Key Vault references,
37+
/// use the overload that accepts an <see cref="Action{AzureAppConfigurationOptions}"/> parameter with options.Connect().
3538
/// </summary>
3639
/// <param name="configurationBuilder">The configuration builder to add key-values to.</param>
3740
/// <param name="connectionString">The connection string used to connect to the configuration store.</param>
@@ -49,6 +52,9 @@ public static IConfigurationBuilder AddAzureAppConfiguration(
4952

5053
/// <summary>
5154
/// Adds key-value data from a primary Azure App Configuration store and one or more replica stores to a configuration builder using connection strings.
55+
/// This is a simplified overload that loads all key-values with no label. For advanced scenarios such as selecting specific keys,
56+
/// filtering by labels, configuring refresh, using feature flags, or resolving Key Vault references,
57+
/// use the overload that accepts an <see cref="Action{AzureAppConfigurationOptions}"/> parameter with options.Connect().
5258
/// </summary>
5359
/// <param name="configurationBuilder">The configuration builder to add key-values to.</param>
5460
/// <param name="connectionStrings">The list of connection strings used to connect to the configuration store and its replicas.</param>
@@ -66,6 +72,9 @@ public static IConfigurationBuilder AddAzureAppConfiguration(
6672

6773
/// <summary>
6874
/// Adds key-value data from an Azure App Configuration store to a configuration builder using endpoint with AAD authentication.
75+
/// This is a simplified overload that loads all key-values with no label. For advanced scenarios such as selecting specific keys,
76+
/// filtering by labels, configuring refresh, using feature flags, or resolving Key Vault references,
77+
/// use the overload that accepts an <see cref="Action{AzureAppConfigurationOptions}"/> parameter with options.Connect().
6978
/// </summary>
7079
/// <param name="configurationBuilder">The configuration builder to add key-values to.</param>
7180
/// <param name="endpoint">The endpoint used to connect to the configuration store.</param>
@@ -85,6 +94,9 @@ public static IConfigurationBuilder AddAzureAppConfiguration(
8594

8695
/// <summary>
8796
/// Adds key-value data from a primary Azure App Configuration store and one or more replica stores to a configuration builder using endpoints with AAD authentication.
97+
/// This is a simplified overload that loads all key-values with no label. For advanced scenarios such as selecting specific keys,
98+
/// filtering by labels, configuring refresh, using feature flags, or resolving Key Vault references,
99+
/// use the overload that accepts an <see cref="Action{AzureAppConfigurationOptions}"/> parameter with options.Connect().
88100
/// </summary>
89101
/// <param name="configurationBuilder">The configuration builder to add key-values to.</param>
90102
/// <param name="endpoints">The list of endpoints used to connect to the configuration store and its replicas.</param>

0 commit comments

Comments
 (0)