Skip to content

Commit 0be7ad3

Browse files
committed
acrolinx items
1 parent e950bac commit 0be7ad3

6 files changed

+27
-27
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Both libraries support manual triggering to check for refreshed configuration va
2323

2424
Refresh allows you to update your configuration values without having to restart your application, though it causes 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.
2525

26-
`spring-cloud-azure-appconfiguration-config-web`'s automated refresh is triggered based on activity, specifically Spring Web's `ServletRequestHandledEvent`. If a `ServletRequestHandledEvent` isn't triggered, `spring-cloud-azure-appconfiguration-config-web`'s automated refresh doesn't trigger a refresh even if the cache expiration time has expired.
26+
`spring-cloud-azure-appconfiguration-config-web`'s automated refresh is triggered based on activity, specifically Spring Web's `ServletRequestHandledEvent`. If a `ServletRequestHandledEvent` isn't triggered, `spring-cloud-azure-appconfiguration-config-web`'s automated refresh doesn't trigger a refresh even if the cache expiration time is expired.
2727

2828
## Use manual refresh
2929

@@ -57,9 +57,9 @@ App Configuration exposes `AppConfigurationRefresh`, which can be used to check
5757
}
5858
```
5959

60-
`AppConfigurationRefresh`'s `refreshConfigurations()` returns a `Mono` 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.
60+
`AppConfigurationRefresh`'s `refreshConfigurations()` returns a `Mono` that is true if a refresh is triggered, and false if not. False means either the cache expiration time isn't expired, there was no change, or another thread is currently checking for a refresh.
6161

62-
1. Update `bootstrap.properties` to enable refresh:
62+
1. To enable refresh update `bootstrap.properties`:
6363

6464
```properties
6565
spring.cloud.azure.appconfiguration.stores[0].monitoring.enabled=true
@@ -84,7 +84,7 @@ App Configuration exposes `AppConfigurationRefresh`, which can be used to check
8484
mvn spring-boot:run
8585
```
8686

87-
1. Open a browser window, and go to the URL: `http://localhost:8080`. You see the message associated with your key.
87+
1. Open a browser window, and go to the URL: `http://localhost:8080`. You see the message associated with your key.
8888

8989
You can also use *curl* to test your application, for example:
9090

@@ -98,7 +98,7 @@ App Configuration exposes `AppConfigurationRefresh`, which can be used to check
9898
|---|---|
9999
| /application/config.message | Hello - Updated |
100100

101-
1. Update the sentinel key you created earlier to a new value. This change triggers the application to refresh all configuration keys once the refresh interval has passed.
101+
1. Update the sentinel key you created earlier to a new value. This change triggers the application to refresh all configuration keys once the refresh interval is passed.
102102

103103
| Key | Value |
104104
|---|---|
@@ -123,7 +123,7 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `spr
123123
</dependency>
124124
```
125125
126-
1. Update `bootstrap.properties` to enable refresh
126+
1. To enable refresh update `bootstrap.properties`:
127127
128128
```properties
129129
spring.cloud.azure.appconfiguration.stores[0].monitoring.enabled=true
@@ -148,7 +148,7 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `spr
148148
mvn spring-boot:run
149149
```
150150
151-
1. Open a browser window, and go to the URL: `http://localhost:8080`. You now see the message associated with your key.
151+
1. Open a browser window, and go to the URL: `http://localhost:8080`. You now see the message associated with your key.
152152
153153
You can also use *curl* to test your application, for example:
154154
@@ -162,7 +162,7 @@ Then, open the *pom.xml* file in a text editor and add a `<dependency>` for `spr
162162
|---|---|
163163
| /application/config.message | Hello - Updated |
164164
165-
1. Update the sentinel key you created earlier to a new value. This change triggers the application to refresh all configuration keys once the refresh interval has passed.
165+
1. Update the sentinel key you created earlier to a new value. This change triggers the application to refresh all configuration keys once the refresh interval is passed.
166166
167167
| Key | Value |
168168
|---|---|

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.author: mametcal
1717

1818
The App Configuration Java Spring client library supports updating configuration on demand without causing an application to restart. An application can be configured to detect changes in App Configuration using one or both of the following two approaches.
1919

20-
- Poll Model: This is the default behavior that uses polling to detect changes in configuration. Once the cached value of a setting expires, the next call to `AppConfigurationRefresh`'s `refreshConfigurations` sends a request to the server to check if the configuration has changed, and pulls the updated configuration if needed.
20+
- Poll Model: The Poll Model is the default behavior that uses polling to detect changes in configuration. Once the cached value of a setting expires, the next call to `AppConfigurationRefresh`'s `refreshConfigurations` sends a request to the server to check if the configuration changed, and pulls the updated configuration if needed.
2121

2222
- Push Model: This uses [App Configuration events](./concept-app-configuration-event.md) to detect changes in configuration. Once App Configuration is set up to send key value change events with Event Grid, with a [Web Hook](../event-grid/handler-event-hubs.md), the application can use these events to optimize the total number of requests needed to keep the configuration updated.
2323

@@ -77,7 +77,7 @@ In this tutorial, you learn how to:
7777
mvn com.microsoft.azure:azure-webapp-maven-plugin:2.5.0:config
7878
```
7979

80-
1. Navigate to the `resources` directory of your app and open `bootstrap.properties` and configure Azure App Configuration Push Refresh. If the file does not exist, create it. Add the following line to the file.
80+
1. Navigate to the `resources` directory of your app and open `bootstrap.properties` and configure Azure App Configuration Push Refresh. If the file doesn't exist, create it. Add the following line to the file.
8181

8282
### [Microsoft Entra ID (recommended)](#tab/entra-id)
8383
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. Create a new file named *AppConfigCredential.java* and add the following lines:
@@ -93,7 +93,7 @@ In this tutorial, you learn how to:
9393
management.endpoints.web.exposure.include= appconfiguration-refresh
9494
```
9595

96-
Additionally, you need to add the following code to your project, unless you want to use just Managed Identity:
96+
Additionally, you need to add the following code to your project, unless you want to use Managed Identity:
9797

9898
```java
9999
import org.springframework.stereotype.Component;
@@ -133,7 +133,7 @@ A random delay is added before the cached value is marked as dirty to reduce pot
133133

134134
## Build and run the app in app service
135135

136-
Event Grid Web Hooks require validation on creation. You can validate by following this [guide](../event-grid/webhook-event-delivery.md) or by starting your application with Azure App Configuration Spring Web Library already configured, which will register your application for you. To use an event subscription, follow the steps in the next two sections.
136+
Event Grid Web Hooks require validation on creation. You can validate by following this [guide](../event-grid/webhook-event-delivery.md) or by starting your application with Azure App Configuration Spring Web Library already configured, which registers your application for you. To use an event subscription, follow the steps in the next two sections.
137137

138138
1. Set an environment variable.
139139

@@ -180,7 +180,7 @@ Event Grid Web Hooks require validation on creation. You can validate by followi
180180
```
181181
---
182182

183-
Restart the command prompt to allow the change to take effect. Print the value of the environment variable to validate that it is set properly.
183+
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.
184184
185185
---
186186
@@ -210,17 +210,17 @@ Event Grid Web Hooks require validation on creation. You can validate by followi
210210
211211
:::image type="content" source="./media/events-pane.png" alt-text="The events pane has an option to create new Subscriptions." :::
212212
213-
1. Enter a name for the `Event Subscription` and the `System Topic`. By default the Event Types Key-Value modified and Key-Value deleted are set, this can be changed along with using the Filters tab to choose the exact reasons a Push Event will be sent.
213+
1. Enter a name for the `Event Subscription` and the `System Topic`. By default the Event Types Key-Value modified and Key-Value deleted are set, the reason can be changed along with using the Filters tab to choose the exact reasons a Push Event is sent.
214214
215215
:::image type="content" source="./media/create-event-subscription.png" alt-text="Events require a name, topic, and filters." :::
216216
217217
1. Select the `Endpoint Type` as `Web Hook`, select `Select an endpoint`.
218218
219219
:::image type="content" source="./media/event-subscription-webhook-endpoint.png" alt-text="Selecting Endpoint creates a new blade to enter the endpoint URI." :::
220220
221-
1. The endpoint is the URI of the application + "/actuator/appconfiguration-refresh?{your-token-name}={your-token-secret}". For example `https://my-azure-webapp.azurewebsites.net/actuator/appconfiguration-refresh?myToken=myTokenSecret`
221+
1. The endpoint is the URI of the application + "/actuator/appconfiguration-refresh?{your-token-name}={your-token-secret}". For example, `https://my-azure-webapp.azurewebsites.net/actuator/appconfiguration-refresh?myToken=myTokenSecret`
222222
223-
1. Select `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.
223+
1. Select `Create` to create the event subscription. When `Create` is selected, a registration request for the Web Hook is sent to your application. The request is received by the Azure App Configuration client library, verified, and returns a valid response.
224224
225225
1. Select `Event Subscriptions` in the `Events` pane to validate that the subscription was created successfully.
226226
@@ -230,7 +230,7 @@ Event Grid Web Hooks require validation on creation. You can validate by followi
230230
> When subscribing for configuration changes, one or more filters can be used to reduce the number of events sent to your application. These can be configured either as [Event Grid subscription filters](../event-grid/event-filtering.md). For example, a subscription filter can be used to only subscribe to events for changes in a key that starts with a specific string.
231231
232232
> [!NOTE]
233-
> If you have multiple instances of your application running, you can use the `appconfiguration-refresh-bus` endpoint which requires setting up Azure Service Bus, which is used to send a message to all instances of your application to refresh their configuration. This is useful if you have multiple instances of your application running and want to ensure that all instances are updated with the latest configuration. This endpoint isn't available unless you have `spring-cloud-bus` as a dependency with it configured. See the [Azure Service Bus Spring Cloud Bus documentation](/azure/developer/java/spring-framework/using-service-bus-in-spring-applications) for more information. The service bus connection only needs to be set up and the Azure App Configuration library will handle sending and receiving the messages.
233+
> If you have multiple instances of your application running, you can use the `appconfiguration-refresh-bus` endpoint which requires setting up Azure Service Bus, which is used to send a message to all instances of your application to refresh their configuration. This is useful if you have multiple instances of your application running and want to ensure that all instances are updated with the latest configuration. This endpoint isn't available unless you have `spring-cloud-bus` as a dependency with it configured. For more information, see [Azure Service Bus Spring Cloud Bus documentation](/azure/developer/java/spring-framework/using-service-bus-in-spring-applications). The service bus connection only needs to be set up and the Azure App Configuration library will handle sending and receiving the messages.
234234
235235
## Verify and test application
236236

articles/azure-app-configuration/quickstart-feature-flag-spring-boot.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ To create a new Spring Boot project:
4141

4242
* Generate a **Maven** project with **Java**.
4343
* Specify a **Spring Boot** version that's equal to or greater than 2.0.
44-
* Specify the **Group** and **Artifact** names for your application. This article uses `com.example` and `demo`.
44+
* Specify the **Group** and **Artifact** names for your application. This article uses `com.example` and `demo`.
4545
* Add the **Spring Web** dependency.
4646

4747
1. After you specify the previous options, select **Generate Project**. When prompted, download the project to your local computer.
4848

4949
## Add feature management
5050

51-
1. After you extract the files on your local system, your Spring Boot application is ready for editing. Locate *pom.xml* in the root directory of your app.
51+
1. After you extract the files on your local system, your Spring Boot application is ready for editing. Locate *pom.xml* in the root directory of your app.
5252

5353
1. Open the *pom.xml* file in a text editor and add the following to the list of `<dependencies>`:
5454

@@ -85,7 +85,7 @@ To create a new Spring Boot project:
8585
## Connect to an App Configuration store
8686

8787

88-
1. Navigate to the `resources` directory of your app and open `bootstrap.properties`. If the file does not exist, create it. Add the following line to the file.
88+
1. Navigate to the `resources` directory of your app and open `bootstrap.properties`. If the file does not exist, create it. Add the following line to the file.
8989

9090
### [Microsoft Entra ID (recommended)](#tab/entra-id)
9191
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. Create a new file named *AppConfigCredential.java* and add the following lines:
@@ -95,7 +95,7 @@ To create a new Spring Boot project:
9595
spring.cloud.azure.appconfiguration.stores[0].feature-flags.enabled=true
9696
```
9797

98-
Additionally, you need to add the following code to your project, unless you want to use just Managed Identity:
98+
Additionally, you need to add the following code to your project, unless you want to use Managed Identity:
9999

100100
```java
101101
import org.springframework.stereotype.Component;

articles/azure-app-configuration/quickstart-java-spring-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ To use the Spring Cloud Azure Config starter to have your application communicat
136136
```
137137

138138

139-
1. Open the auto-generated unit test and update to disable Azure App Configuration, or it will try to load from the service when running unit tests.
139+
1. Open the auto-generated unit test and update to disable Azure App Configuration, or it tries to load from the service when running unit tests.
140140

141141
```java
142142
import org.junit.jupiter.api.Test;

articles/azure-app-configuration/use-feature-flags-spring-boot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Feature Management libraries also manage feature flag lifecycles behind the
2222

2323
The [Add feature flags to a Spring Boot app Quickstart](./quickstart-feature-flag-spring-boot.md) shows several ways to add feature flags in a Spring Boot application. This tutorial explains these methods in more detail.
2424

25-
In this tutorial, you will learn how to:
25+
In this tutorial, you learn how to:
2626

2727
> [!div class="checklist"]
2828
> * Add feature flags in key parts of your application to control feature availability.
@@ -174,7 +174,7 @@ public String getOldFeature() {
174174

175175
## Next steps
176176

177-
In this tutorial, you learned how to implement feature flags in your Spring Boot application by using the `spring-cloud-azure-feature-management-web` libraries. 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.For more information about feature management support in Spring Boot and App Configuration, see the following resources:
177+
In this tutorial, you learned how to implement feature flags in your Spring Boot application by using the `spring-cloud-azure-feature-management-web` libraries. For further questions see the [reference documentation](https://go.microsoft.com/fwlink/?linkid=2180917). The reference documentation has all of the details on how the Spring Cloud Azure App Configuration library works.For more information about feature management support in Spring Boot and App Configuration, see the following resources:
178178

179179
* [Spring Boot feature flag sample code](./quickstart-feature-flag-spring-boot.md)
180180
* [Manage feature flags](./manage-feature-flags.md)

articles/azure-app-configuration/use-key-vault-references-spring-boot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In this tutorial, you learn how to use the Azure App Configuration service toget
1717

1818
App Configuration helps you use the services together by creating keys that reference values stored in Key Vault. When App Configuration creates such keys, it stores the URIs of Key Vault values rather than the values themselves.
1919

20-
Your application uses the App Configuration client provider to retrieve Key Vault references, just as it does for any other keys stored in App Configuration. In this case, the values stored in App Configuration are URIs that reference the values in the Key Vault. They are not Key Vault values or credentials. Because the client provider recognizes the keys as Key Vault references, it uses Key Vault to retrieve their values.
20+
Your application uses the App Configuration client provider to retrieve Key Vault references, just as it does for any other keys stored in App Configuration. In this case, the values stored in App Configuration are URIs that reference the values in the Key Vault. They aren't Key Vault values or credentials. Because the client provider recognizes the keys as Key Vault references, it uses Key Vault to retrieve their values.
2121

2222
Your application is responsible for authenticating properly to both App Configuration and Key Vault. The two services don't communicate directly.
2323

@@ -43,7 +43,7 @@ In this tutorial, you learn how to:
4343

4444
![Screenshot shows the Create a resource option in the Azure portal.](./media/quickstarts/search-services.png)
4545
1. In the search box, enter **Key Vault**.
46-
1. From the results list, select **Key vaults** on the left.
46+
1. From the results list, select **Key vaults**.
4747
1. In **Key vaults**, select **Add**.
4848
1. On the right in **Create key vault**, provide the following information:
4949
* Select **Subscription** to choose a subscription.
@@ -59,7 +59,7 @@ At this point, your Azure account is the only one authorized to access this new
5959

6060
## Add a secret to Key Vault
6161

62-
To add a secret to the vault, you need to take just a few additional steps. In this case, add a message that you can use to test Key Vault retrieval. The message is called **Message**, and you store the value "Hello from Key Vault" in it.
62+
To add a secret to the vault, you need to take just a few more steps. In this case, add a message that you can use to test Key Vault retrieval. The message is called **Message**, and you store the value "Hello from Key Vault" in it.
6363

6464
1. From the Key Vault properties pages, select **Secrets**.
6565
1. Select **Generate/Import**.

0 commit comments

Comments
 (0)