Merge pull request #192985 from mrm9084/AppConfigSpringUpdates

App Configuration Spring Updates

Author: v-regandowner

articles/azure-app-configuration/enable-dynamic-configuration-java-spring-app.md

@@ -7,40 +7,112 @@ author: mrm9084
 ms.service: azure-app-configuration
 ms.devlang: java
 ms.topic: tutorial
-ms.date: 12/09/2020
+ms.date: 05/02/2022
 ms.custom: devx-track-java
 ms.author: mametcal
 
 #Customer intent: As a Java Spring developer, I want to dynamically update my app to use the latest configuration data in App Configuration.
 ---
 # Tutorial: Use dynamic configuration in a Java Spring app
 
-App Configuration has two libraries for Spring. `azure-spring-cloud-appconfiguration-config` requires Spring Boot and takes a dependency on `spring-cloud-context`. `azure-spring-cloud-appconfiguration-config-web` requires Spring Web along with Spring Boot. Both libraries support manual triggering to check for refreshed configuration values. `azure-spring-cloud-appconfiguration-config-web` also adds support for automatic checking of configuration refresh.
+App Configuration has two libraries for Spring. 
 
-Refresh allows you to refresh your configuration values without having to restart your application, though it will cause all beans in the `@RefreshScope` to be recreated. The client library caches a hash ID of the currently loaded configurations to avoid too many calls to the configuration store. The refresh operation doesn't update the value until the cached value has expired, even when the value has changed in the configuration store. The default expiration time for each request is 30 seconds. It can be overridden if necessary.
+* `azure-spring-cloud-appconfiguration-config` requires Spring Boot and takes a dependency on `spring-cloud-context`.
+* `azure-spring-cloud-appconfiguration-config-web` requires Spring Web along with Spring Boot, and also adds support for automatic checking of configuration refresh.
 
-`azure-spring-cloud-appconfiguration-config-web`'s automated refresh is triggered based off activity, specifically Spring Web's `ServletRequestHandledEvent`. If a `ServletRequestHandledEvent` is not triggered, `azure-spring-cloud-appconfiguration-config-web`'s automated refresh will not trigger a refresh even if the cache expiration time has expired.
+Both libraries support manual triggering to check for refreshed configuration values.
+
+Refresh allows you to update your configuration values without having to restart your application, though it will cause all beans in the `@RefreshScope` to be recreated. It checks for any changes to configured triggers, including metadata. By default, the minimum amount of time between checks for changes, refresh interval, is set to 30 seconds.
+
+`azure-spring-cloud-appconfiguration-config-web`'s automated refresh is triggered based on activity, specifically Spring Web's `ServletRequestHandledEvent`. If a `ServletRequestHandledEvent` is not triggered, `azure-spring-cloud-appconfiguration-config-web`'s automated refresh will not trigger a refresh even if the cache expiration time has expired.
 
 ## Use manual refresh
 
+To use manual refresh, start with a Spring Boot app that uses App Configuration, such as the app you create by following the [Spring Boot quickstart for App Configuration](quickstart-java-spring-app.md).
+
 App Configuration exposes `AppConfigurationRefresh` which can be used to check if the cache is expired and if it is expired trigger a refresh.
 
-```java
-import com.azure.spring.cloud.config.AppConfigurationRefresh;
+1. Update HelloController to use `AppConfigurationRefresh`.
+
+    ```java
+    import com.azure.spring.cloud.config.AppConfigurationRefresh;
+
+    ...
+    
+    import com.azure.spring.cloud.config.AppConfigurationRefresh;
+    
+    @RestController
+    public class HelloController {
+        private final MessageProperties properties;
+        
+        @Autowired(required = false)
+        private AppConfigurationRefresh refresh;
+    
+        public HelloController(MessageProperties properties) {
+            this.properties = properties;
+        }
+    
+        @GetMapping
+        public String getMessage() throws InterruptedException, ExecutionException {
+            if (refresh != null) {
+                refresh.refreshConfigurations();
+            }
+            return "Message: " + properties.getMessage();
+        }
+    }
+    ```
 
-...
+    `AppConfigurationRefresh`'s `refreshConfigurations()` returns a `Future` that is true if a refresh has been triggered, and false if not. False means either the cache expiration time hasn't expired, there was no change, or another thread is currently checking for a refresh.
 
-@Autowired
-private AppConfigurationRefresh appConfigurationRefresh;
+1. Update `bootstrap.properties` to enable refresh
 
-...
+    ```properties
+    spring.cloud.azure.appconfiguration.stores[0].monitoring.enabled=true
+    spring.cloud.azure.appconfiguration.stores[0].monitoring.refresh-interval= 30s
+    spring.cloud.azure.appconfiguration.stores[0].monitoring.triggers[0].key=sentinel
+    ```
 
-public void myConfigurationRefreshCheck() {
-    Future<Boolean> triggeredRefresh = appConfigurationRefresh.refreshConfigurations();
-}
-```
+1. Open the **Azure Portal** and navigate to your App Configuration resource associated with your application. Select **Configuration Explorer** under **Operations** and create a new key-value pair by selecting **+ Create** > **Key-value** to add the following parameters:
+
+    | Key | Value |
+    |---|---|
+    | sentinel | 1 |
+
+    Leave **Label** and **Content Type** empty for now.
+
+1. Select **Apply**.
+
+1. Build your Spring Boot application with Maven and run it.
+
+    ```shell
+    mvn clean package
+    mvn spring-boot:run
+    ```
+
+1. Open a browser window, and go to the URL: `http://localhost:8080`.  You will see the message associated with your key.
 
-`AppConfigurationRefresh`'s `refreshConfigurations()` returns a `Future` that is true if a refresh has been triggered, and false if not. False means either the cache expiration time hasn't expired, there was no change, or another thread is currently checking for a refresh.
+    You can also use *curl* to test your application, for example:
+
+    ```cmd
+    curl -X GET http://localhost:8080/
+    ```
+
+1. To test dynamic configuration, open the Azure App Configuration portal associated with your application. Select **Configuration Explorer**, and update the value of your displayed key, for example:
+
+    | Key | Value |
+    |---|---|
+    | /application/config.message | Hello - Updated |
+
+1. Update the sentinel key you created earlier to a new value. This change will trigger the application to refresh all configuration keys once the refresh interval has passed.
+
+    | Key | Value |
+    |---|---|
+    | sentinel | 2 |
+
+1. Refresh the browser page twice to see the new message displayed. The first time triggers the refresh, the second loads the changes.
+
+> [!NOTE]
+> The library only checks for changes on the after the refresh interval has passed, if the period hasn't passed then no change will be seen, you will have to wait for the period to pass then trigger the refresh check.
 
 ## Use automated refresh
 
@@ -54,7 +126,7 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `azu
 <dependency>
     <groupId>com.azure.spring</groupId>
     <artifactId>azure-spring-cloud-appconfiguration-config-web</artifactId>
-    <version>2.0.0</version>
+    <version>2.6.0</version>
 </dependency>
 ```
 
@@ -65,6 +137,7 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `azu
 
     ```properties
     spring.cloud.azure.appconfiguration.stores[0].monitoring.enabled=true
+    spring.cloud.azure.appconfiguration.stores[0].monitoring.refresh-interval= 30s
     spring.cloud.azure.appconfiguration.stores[0].monitoring.triggers[0].key=sentinel
     ```
 
@@ -105,11 +178,14 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `azu
     |---|---|
     | sentinel | 2 |
 
-1. Refresh the browser page to see the new message displayed.
+1. Refresh the browser page twice to see the new message displayed. The first time triggers the refresh, the second loads the changes, as the first request returns using the original scope.
+
+> [!NOTE]
+> The library only checks for changes on after the refresh interval has passed. If the refresh interval hasn't passed then it will not check for changes, you will have to wait for the interval to pass then trigger the refresh check.
 
 ## Next steps
 
-In this tutorial, you enabled your Spring Boot app to dynamically refresh configuration settings from App Configuration. To learn how to use an Azure managed identity to streamline the access to App Configuration, continue to the next tutorial.
+In this tutorial, you enabled your Spring Boot app to dynamically refresh configuration settings from App Configuration. For further questions see the [reference documentation](https://go.microsoft.com/fwlink/?linkid=2180917), it has all of the details on how the Spring Cloud Azure App Configuration library works. To learn how to use an Azure managed identity to streamline the access to App Configuration, continue to the next tutorial.
 
 > [!div class="nextstepaction"]
 > [Managed identity integration](./howto-integrate-azure-managed-service-identity.md)

articles/azure-app-configuration/enable-dynamic-configuration-java-spring-push-refresh.md

@@ -13,7 +13,7 @@ ms.service: azure-app-configuration
 ms.workload: tbd
 ms.devlang: java
 ms.topic: tutorial
-ms.date: 04/05/2021
+ms.date: 05/02/2022
 ms.author: mametcal
 
 #Customer intent: I want to use push refresh to dynamically update my app to use the latest configuration data in App Configuration.
@@ -41,7 +41,7 @@ In this tutorial, you learn how to:
 ## Prerequisites
 
 - Azure subscription - [create one for free](https://azure.microsoft.com/free/)
-- A supported [Java Development Kit (JDK)](/java/azure/jdk) with version 8.
+- A supported [Java Development Kit (JDK)](/java/azure/jdk) with version 11.
 - [Apache Maven](https://maven.apache.org/download.cgi) version 3.0 or above.
 - An existing Azure App Configuration Store.
 
@@ -55,7 +55,7 @@ In this tutorial, you learn how to:
            <dependency>
                <groupId>com.azure.spring</groupId>
                <artifactId>azure-spring-cloud-appconfiguration-config-web</artifactId>
-               <version>2.0.0</version>
+               <version>2.6.0</version>
            </dependency>
 
            <!-- Adds the Ability to Push Refresh -->
@@ -65,7 +65,7 @@ In this tutorial, you learn how to:
            </dependency>
    ```
 
-1. Setup [Maven App Service Deployment](../app-service/quickstart-java.md?tabs=javase) so the application can be deployed to Azure App Service via Maven.
+1. Set up [Maven App Service Deployment](../app-service/quickstart-java.md?tabs=javase) so the application can be deployed to Azure App Service via Maven.
 
    ```console
    mvn com.microsoft.azure:azure-webapp-maven-plugin:1.12.0:config
@@ -144,7 +144,7 @@ Event Grid Web Hooks require validation on creation. You can validate by followi
 
 1. Click on `Create` to create the event subscription. When `Create` is selected a registration request for the Web Hook will be sent to your application. This is received by the Azure App Configuration client library, verified, and returns a valid response.
 
-1. Click on `Event Subscriptions` in the `Events` pane to validated that the subscription was created successfully.
+1. Click on `Event Subscriptions` in the `Events` pane to validate that the subscription was created successfully.
 
     :::image type="content" source="./media/event-subscription-view-webhook.png" alt-text="Web Hook shows up in a table on the bottom of the page." :::
 
@@ -173,7 +173,7 @@ Event Grid Web Hooks require validation on creation. You can validate by followi
 
 ## Next steps
 
-In this tutorial, you enabled your Java app to dynamically refresh configuration settings from App Configuration. To learn how to use an Azure managed identity to streamline the access to App Configuration, continue to the next tutorial.
+In this tutorial, you enabled your Java app to dynamically refresh configuration settings from App Configuration. For further questions see the [reference documentation](https://go.microsoft.com/fwlink/?linkid=2180917), it has all of the details on how the Spring Cloud Azure App Configuration library works. To learn how to use an Azure managed identity to streamline the access to App Configuration, continue to the next tutorial.
 
 > [!div class="nextstepaction"]
 > [Managed identity integration](./howto-integrate-azure-managed-service-identity.md)

articles/azure-app-configuration/howto-convert-to-the-new-spring-boot.md

@@ -7,7 +7,7 @@ ms.devlang: java
 author: mrm9084
 ms.author: mametcal
 ms.topic: how-to
-ms.date: 07/08/2021
+ms.date: 05/02/2022
 ---
 
 # Convert to new App Configuration Spring Boot library
@@ -29,12 +29,12 @@ All of the Azure Spring Boot libraries have had their Group and Artifact IDs upd
 <dependency>
     <groupId>com.azure.spring</groupId>
     <artifactId>azure-spring-cloud-appconfiguration-config</artifactId>
-    <version>2.0.0-beta.2</version>
+    <version>2.6.0</version>
 </dependency>
 <dependency>
     <groupId>com.azure.spring</groupId>
     <artifactId>azure-spring-cloud-appconfiguration-config-web</artifactId>
-    <version>2.0.0-beta.2</version>
+    <version>2.6.0</version>
 </dependency>
 ```
 
@@ -61,7 +61,7 @@ az appconfig kv import -n your-stores-name -s file --format properties --label d
 
 or use the Import/Export feature in the portal.
 
-When you are completely moved to the new version, you can removed the old keys by running:
+When you are completely moved to the new version, you can remove the old keys by running:
 
 ```azurecli
 az appconfig kv delete -n ConversionTest --key /application_dev/*