Merge pull request #289870 from maud-lv/entra-dynamic-dotnet-background

Add Entra ID tab

Author: v-dirichards

articles/azure-app-configuration/enable-dynamic-configuration-dotnet-background-service.md

@@ -9,7 +9,7 @@ ms.service: azure-app-configuration
 ms.devlang: csharp
 ms.custom: devx-track-csharp, devx-track-dotnet
 ms.topic: tutorial
-ms.date: 02/20/2024
+ms.date: 11/12/2024
 ms.author: zhiyuanliang
 #Customer intent: I want to dynamically update my .NET background service to use the latest configuration data in App Configuration.
 ---
@@ -70,8 +70,39 @@ You use the [.NET command-line interface (CLI)](/dotnet/core/tools/) to create a
     using Microsoft.Extensions.Configuration.AzureAppConfiguration;
     ```
 
-1. Connect to App Configuration.
+1. Connect to App Configuration using Microsoft Entra ID (recommended), or a connection string.
 
+    ### [Microsoft Entra ID (recommended)](#tab/entra-id)
+
+    You use the `DefaultAzureCredential` to authenticate to your App Configuration store. Follow the [instructions](./concept-enable-rbac.md#authentication-with-token-credentials) to assign your credential the **App Configuration Data Reader role**. Be sure to allow sufficient time for the permission to propagate before running your application.
+ 
+    ```csharp
+    // Existing code in Program.cs
+    // ... ...
+    
+    var builder = Host.CreateApplicationBuilder(args);
+    
+    builder.Configuration.AddAzureAppConfiguration(options =>
+    {
+        string endpoint = Environment.GetEnvironmentVariable("Endpoint"); 
+        options.Connect(new Uri(endpoint), new DefaultAzureCredential());
+            // Load all keys that start with `TestApp:`.
+            .Select("TestApp:*")
+            // Configure to reload the key 'TestApp:Settings:Message' if it is modified.
+            .ConfigureRefresh(refreshOptions =>
+            {
+                refreshOptions.Register("TestApp:Settings:Message");
+            });
+    
+        // Register the refresher so that the Worker service can consume it through DI
+        builder.Services.AddSingleton(options.GetRefresher());
+    });
+    
+    // The rest of existing code in Program.cs
+    // ... ...
+    ```    
+
+    ### [Connection string](#tab/connection-string)
     ```csharp
     // Existing code in Program.cs
     // ... ...
@@ -96,6 +127,7 @@ You use the [.NET command-line interface (CLI)](/dotnet/core/tools/) to create a
     // The rest of existing code in Program.cs
     // ... ...
     ```
+    ---
 
     In the `ConfigureRefresh` method, a key within your App Configuration store is registered for change monitoring. The `Register` method has an optional boolean parameter `refreshAll` that can be used to indicate whether all configuration values should be refreshed if the registered key changes. In this example, only the key *TestApp:Settings:Message* will be refreshed. All settings registered for refresh have a default cache expiration of 30 seconds before a new refresh is attempted. It can be updated by calling the `AzureAppConfigurationRefreshOptions.SetCacheExpiration` method.
 
@@ -137,42 +169,49 @@ You use the [.NET command-line interface (CLI)](/dotnet/core/tools/) to create a
 
 ## Build and run the app locally
 
-1. Set an environment variable named **ConnectionString**, and set it to the access key to your App Configuration store. At the command line, run the following command.
+1. Set an environment variable.
 
-    ### [Windows command prompt](#tab/windowscommandprompt)
+    ### [Microsoft Entra ID (recommended)](#tab/entra-id)
+    Set the environment variable named **Endpoint** to the endpoint of your App Configuration store found under the *Overview* of your store in the Azure portal.
 
-    To build and run the app locally using the Windows command prompt, run the following command.
+    If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:
 
-    ```console
-    setx ConnectionString "connection-string-of-your-app-configuration-store"
+    ```cmd
+    setx Endpoint "endpoint-of-your-app-configuration-store"
     ```
 
-    Restart the command prompt to allow the change to take effect. Print the value of the environment variable to validate that it's set properly.
+    If you use PowerShell, run the following command:
 
-    ### [PowerShell](#tab/powershell)
+    ```powershell
+    $Env:Endpoint = "endpoint-of-your-app-configuration-store"
+    ```
 
-    If you use Windows PowerShell, run the following command.
+    If you use macOS or Linux, run the following command:
 
-    ```azurepowershell
-    $Env:ConnectionString = "connection-string-of-your-app-configuration-store"
+    ```bash
+    export Endpoint='endpoint-of-your-app-configuration-store'
     ```
 
-    ### [macOS](#tab/unix)
+    ### [Connection string](#tab/connection-string)
+    Set the environment variable named **ConnectionString** to the read-only connection string of your App Configuration store found under *Access keys* of your store in the Azure portal.
 
-    If you use macOS, run the following command.
+    If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:
 
-    ```console
-    export ConnectionString='connection-string-of-your-app-configuration-store'
+    ```cmd
+    setx ConnectionString "connection-string-of-your-app-configuration-store"
     ```
 
-    ### [Linux](#tab/linux)
+   If you use PowerShell, run the following command:
 
-    If you use Linux, run the following command.
+    ```powershell
+    $Env:ConnectionString = "connection-string-of-your-app-configuration-store"
+    ```
+
+    If you use macOS or Linux, run the following command:
 
-    ```console
+    ```bash
     export ConnectionString='connection-string-of-your-app-configuration-store'
     ```
-
     ---
 
 1. Run the following command to build the app.