Skip to content

Commit 97eca24

Browse files
Apply suggestions from Karl's review
Co-authored-by: Karl Erickson <[email protected]>
1 parent 451f5f2 commit 97eca24

File tree

4 files changed

+35
-35
lines changed

4 files changed

+35
-35
lines changed

articles/spring-apps/includes/quickstart-deploy-restful-api-app/clean-up-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ azd down
3535

3636
The following list describes the command interaction:
3737

38-
- **Total resources to delete: [your-resources-total], are you sure you want to continue?**: Enter `y`.
38+
- **Total resources to delete: [your-resources-total], are you sure you want to continue?**: Press <kbd>y</kbd>.
3939

4040
The console outputs messages similar to the following example:
4141

articles/spring-apps/includes/quickstart-deploy-restful-api-app/deploy-restful-api-app-with-consumption-plan.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ To deploy the RESTful API app, the first step is to prepare the Spring project t
1919

2020
### [Azure portal](#tab/Azure-portal)
2121

22-
Use the following steps to clone and run the app locally.
22+
Use the following steps to clone and run the app locally:
2323

2424
1. Use the following command to clone the sample project from GitHub:
2525

2626
```bash
2727
git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
2828
```
2929

30-
1. If you want to run the app locally, complete the steps in the [Expose RESTful APIs](#expose-restful-apis) and [Update the application configuration](#update-the-application-configuration) sections first, and then use the following command to run the sample application with Maven.
30+
1. If you want to run the app locally, complete the steps in the [Expose RESTful APIs](#expose-restful-apis) and [Update the application configuration](#update-the-application-configuration) sections first, and then use the following command to run the sample application with Maven:
3131

3232
```bash
3333
cd ASA-Samples-Restful-Application
@@ -49,7 +49,7 @@ Use the following steps to initialize the web application from Azure Developer C
4949
The following list describes the command interactions:
5050

5151
- **OAuth2 login**: You need to authorize the login to Azure based on the OAuth2 protocol.
52-
- **Please enter a new environment name**: Provide an environment name. This name is used as a suffix for the resource group that is created to hold all the Azure resources. This name should be unique within your Azure subscription.
52+
- **Please enter a new environment name**: Provide an environment name. This name is used as a suffix for the resource group that's created to hold all the Azure resources. This name should be unique within your Azure subscription.
5353

5454
The console outputs messages similar to the following example:
5555

@@ -95,8 +95,8 @@ Use the following steps to create a service instance:
9595
| **Subscription** | Your subscription name. | The Azure subscription that you want to use for your server. If you have multiple subscriptions, choose the subscription in which you'd like to be billed for the resource. |
9696
| **Resource group** | *myresourcegroup* | A new resource group name or an existing one from your subscription. |
9797
| **Name** | *myasa* | A unique name that identifies your Azure Spring Apps service. The name must be between 4 and 32 characters long and can contain only lowercase letters, numbers, and hyphens. The first character of the service name must be a letter and the last character must be either a letter or a number. |
98-
| **Plan** | **Standard consumption & dedicated (preview)** | The pricing plan determines the resource and cost associated with your instance. |
99-
| **Region** | The region closest to your users. | The location that is closest to your users. |
98+
| **Plan** | **Standard consumption & dedicated (preview)** | The pricing plan determines the resources and cost associated with your instance. |
99+
| **Region** | The region closest to your users. | The location that's closest to your users. |
100100
| **Container Apps Environment** | *myenvironment* | Select which Container Apps environment instance to share the same virtual network with other services and resources. |
101101

102102
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/create-consumption-service-basics.png" alt-text="Screenshot of the Azure portal showing the Create Azure Spring Apps consumption plan page." lightbox="../../media/quickstart-deploy-restful-api-app/create-consumption-service-basics.png":::
@@ -106,7 +106,7 @@ Use the following steps to create a service instance:
106106
| Setting | Suggested value | Description |
107107
|----------------------|-----------------|------------------------------------------------------------------------------------------|
108108
| **Environment name** | *myenvironment* | A unique name that identifies your Azure Container Apps Environment service. |
109-
| **Plan** | **Consumption** | The pricing plan determines the resource and cost associated with your instance. |
109+
| **Plan** | **Consumption** | The pricing plan determines the resources and cost associated with your instance. |
110110
| **Zone Redundant** | Disabled | Whether to create your Container Apps Environment service in an Azure availability zone. |
111111

112112
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/create-apps-container-env-basics.png" alt-text="Screenshot of the Azure portal that shows the Create Azure Container Apps page." lightbox="../../media/quickstart-deploy-restful-api-app/create-apps-container-env-basics.png":::
@@ -120,7 +120,7 @@ Use the following steps to create a service instance:
120120
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/notifications.png" alt-text="Screenshot of the Azure portal that shows the Overview page with the Notifications page open." lightbox="../../media/quickstart-deploy-restful-api-app/notifications.png":::
121121

122122
> [!IMPORTANT]
123-
> The Consumption workload profile has a pay-as-you-go billing model, with no starting cost. You're billed for the dedicated workload profile based on the provisioned resources. For more information, see [Workload profiles in Consumption + Dedicated plan structure environments in Azure Container Apps (preview)](../../../container-apps/workload-profiles-overview.md) and [Azure Spring Apps pricing](https://azure.microsoft.com/pricing/details/spring-apps/).
123+
> The Consumption workload profile has a pay-as-you-go billing model, with no starting cost. You're billed for the dedicated workload profile based on the provisioned resources. For more information, see [Workload profiles in Azure Container Apps](../../../container-apps/workload-profiles-overview.md) and [Azure Spring Apps pricing](https://azure.microsoft.com/pricing/details/spring-apps/).
124124
125125
### 3.3. Prepare the PostgreSQL instance
126126

@@ -142,7 +142,7 @@ Use the following steps to connect your service instances:
142142

143143
1. Go to the created app, expand **Settings** and select **Configuration** from the navigation menu, and then select **Environment variables** to set the environment variables.
144144

145-
1. Add the following environment variables for the PostgreSQL connection, and then select **Save** to finish the app configuration update. Be sure to replace the placeholders with your own values you created previously.
145+
1. Add the following environment variables for the PostgreSQL connection, and then select **Save** to finish the app configuration update. Be sure to replace the placeholders with your own values that you created previously.
146146

147147
| Environment variable | Value |
148148
|------------------------------|----------------------------------------------------------------------------------------|
@@ -166,7 +166,7 @@ Use the following steps to connect your service instances:
166166
azd config set alpha.springapp on
167167
```
168168

169-
1. Run the following command to package a deployable copy of your application, provision the template's infrastructure to Azure, and also deploy the application code to those newly provisioned resources:
169+
1. Run the following command to package a deployable copy of your application, provision the template's infrastructure to Azure, and deploy the application code to those newly provisioned resources:
170170

171171
```bash
172172
azd provision
@@ -186,13 +186,13 @@ Use the following steps to connect your service instances:
186186
```
187187

188188
> [!NOTE]
189-
> This command may take a while to complete. You'll see a progress indicator as it provisions Azure resources.
189+
> This command might take a while to complete. You see a progress indicator as it provisions Azure resources.
190190
191191
---
192192

193193
### Expose RESTful APIs
194194

195-
Use the following steps to expose your RESTful APIs in Microsoft Entra ID.
195+
Use the following steps to expose your RESTful APIs in Microsoft Entra ID:
196196

197197
1. Sign in to the [Azure portal](https://portal.azure.com/).
198198

@@ -220,7 +220,7 @@ Use the following steps to expose your RESTful APIs in Microsoft Entra ID.
220220
- For **Who can consent**, select **Admins only**.
221221
- For **Admin consent display name**, enter *Read the ToDo data*.
222222
- For **Admin consent description**, enter *Allows authenticated users to read the ToDo data.*.
223-
- For **State**, keep **Enabled**.
223+
- For **State**, keep it enabled.
224224
- Select **Add scope**.
225225

226226
1. Repeat the previous step to add the two other scopes: *ToDo.Write* and *ToDo.Delete*.
@@ -229,7 +229,7 @@ Use the following steps to expose your RESTful APIs in Microsoft Entra ID.
229229

230230
### Update the application configuration
231231

232-
Use the following steps to update the YAML file to use with your Microsoft Entra ID registered application information to establish a relationship with the RESTful API application:
232+
Use the following steps to update the YAML file to use your Microsoft Entra ID registered application information to establish a relationship with the RESTful API application:
233233

234234
1. Use the following YAML to update the `spring.cloud.azure.active-directory` configuration in the configuration file. Be sure to replace the placeholders with your own values that you created previously.
235235

@@ -239,7 +239,7 @@ Use the following steps to update the YAML file to use with your Microsoft Entra
239239
azure:
240240
active-directory:
241241
profile:
242-
tenant-id: <your-Azure-AD-tenant-ID>
242+
tenant-id: <your-Microsoft-Entra-ID-tenant-ID>
243243
credential:
244244
client-id: <your-application-ID-of-ToDo>
245245
app-id-uri: <your-application-ID-URI-of-ToDo>
@@ -260,7 +260,7 @@ Now, you can deploy the app to Azure Spring Apps.
260260

261261
### [Azure portal](#tab/Azure-portal)
262262

263-
Use the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Spring-Apps) to deploy.
263+
Use the following steps to deploy using the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Spring-Apps):
264264

265265
1. Navigate to the sample project directory and run the following command to configure the app in Azure Spring Apps:
266266

@@ -270,12 +270,12 @@ Use the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-
270270

271271
The following list describes the command interactions:
272272

273-
- **OAuth2 login**: You need to authorize the login to Azure based on the OAuth2 protocol.
274-
- **Select subscription**: Select the subscription list number of the Azure Spring Apps instance you created, which defaults to the first subscription in the list. If you use the default number, press <kbd>Enter</kbd> directly.
275-
- **Select Azure Spring Apps for deployment**: Select the number of the Azure Spring Apps instance you created. If you use the default number, press <kbd>Enter</kbd> directly.
276-
- **Input the app name(simple-todo-api)**: Input a name for your application deployment on Azure Spring Apps. If you use the default name, press <kbd>Enter</kbd> directly.
277-
- **Expose public access for this app (RESTful API for SimpleTodo)?**: Enter *y*.
278-
- **Confirm to save all the above configurations (Y/n)**: Enter *y*. If you Enter *n*, the configuration won't be saved.
273+
- **OAuth2 login**: You need to authorize the login to Azure based on the OAuth2 protocol.
274+
- **Select subscription**: Select the subscription list number of the Azure Spring Apps instance you created, which defaults to the first subscription in the list. If you use the default number, press <kbd>Enter</kbd> directly.
275+
- **Select Azure Spring Apps for deployment**: Select the number of the Azure Spring Apps instance you created. If you use the default number, press <kbd>Enter</kbd> directly.
276+
- **Input the app name(simple-todo-api)**: Input a name for your application deployment on Azure Spring Apps. If you use the default name, press <kbd>Enter</kbd> directly.
277+
- **Expose public access for this app (RESTful API for SimpleTodo)?**: Press <kbd>y</kbd>.
278+
- **Confirm to save all the above configurations (Y/n)**: Press <kbd>y</kbd>. If you press <kbd>n</kbd>, the configuration won't be saved.
279279

280280
1. Use the following command to deploy the app:
281281

@@ -285,9 +285,9 @@ Use the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-
285285

286286
The following list describes the command interaction:
287287

288-
- **OAuth2 login**: You need to authorize the login to Azure based on the OAuth2 protocol.
288+
- **OAuth2 login**: You need to authorize the login to Azure based on the OAuth2 protocol.
289289

290-
After the command is executed, you can see the following log signs that the deployment was successful.
290+
After the command is executed, you can see the following log output, indicating that the deployment was successful.
291291

292292
```output
293293
[INFO] App(simple-todo-api) is successfully updated.
@@ -301,7 +301,7 @@ Use the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-
301301

302302
### [Azure Developer CLI](#tab/Azure-Developer-CLI)
303303

304-
Use Azure Developer CLI to package the app, provision the Azure resources required by the web application, and then deploy to Azure Spring Apps.
304+
Use the following steps to package the app, provision the Azure resources required by the web application, and then deploy to Azure Spring Apps.
305305

306306
1. Run the following command to package a deployable copy of your application:
307307

@@ -337,6 +337,6 @@ Use Azure Developer CLI to package the app, provision the Azure resources requir
337337
The output **Endpoint** is the base endpoint to access the ToDo API application.
338338

339339
> [!NOTE]
340-
> You can also use `azd up` to combine the previous three commands: `azd package` (packages a deployable copy of your application), `azd provision` (provisions Azure resources), and `azd deploy` (deploys application code). For more information, see [Azure-Samples/ASA-Samples-API-Application](https://github.com/Azure-Samples/ASA-Samples-API-Application).
340+
> You can also use `azd up` to combine the previous three commands: `azd provision` (provisions Azure resources), `azd package` (packages a deployable copy of your application), and `azd deploy` (deploys application code). For more information, see [Azure-Samples/ASA-Samples-API-Application](https://github.com/Azure-Samples/ASA-Samples-API-Application).
341341
342342
---

articles/spring-apps/includes/quickstart-deploy-restful-api-app/provision-postgresql.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For clarity of structure, a separate markdown file is used to describe how to pr
1313
1414
-->
1515

16-
Use the following steps to create an Azure Database for the PostgreSQL server:
16+
Use the following steps to create an Azure Database for PostgreSQL server:
1717

1818
1. Go to the Azure portal and select **Create a resource**.
1919

@@ -38,17 +38,17 @@ Use the following steps to create an Azure Database for the PostgreSQL server:
3838

3939
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/postgresql-create-server-basics.png" alt-text="Screenshot of the Azure portal that shows the Server details page." lightbox="../../media/quickstart-deploy-restful-api-app/postgresql-create-server-basics.png":::
4040

41-
1. Use the following example to configure the **Networking** tab:
41+
1. Use the following information to configure the **Networking** tab:
4242

4343
- **Connectivity method**: **Public access (allowed IP addresses)**
4444
- **Allow public access from any Azure service within Azure to this server**: selected
4545

4646
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/postgresql-create-server-networking.png" alt-text="Screenshot of the Azure portal that shows the Networking tab." lightbox="../../media/quickstart-deploy-restful-api-app/postgresql-create-server-networking.png":::
4747

48-
1. Select **Review + create** to review your selections, and select **Create** to provision the server. This operation may take a few minutes.
48+
1. Select **Review + create** to review your selections, and select **Create** to provision the server. This operation might take a few minutes.
4949

50-
1. Go to your PostgreSQL server in the Azure portal. On the **Overview** page, look for the **Server name** value, and then record it for later use. You need it to configure environment variables for app in Azure Spring Apps.
50+
1. Go to your PostgreSQL server in the Azure portal. On the **Overview** page, look for the **Server name** value, and then record it for later use. You need it to configure the environment variables for the app in Azure Spring Apps.
5151

5252
1. Select **Databases** from the navigation menu to create a database.
5353

54-
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/postgresql-create-database.png" alt-text="Screenshot of the Azure portal that shows the Databases page with the Create Database menu open." lightbox="../../media/quickstart-deploy-restful-api-app/postgresql-create-database.png":::
54+
:::image type="content" source="../../media/quickstart-deploy-restful-api-app/postgresql-create-database.png" alt-text="Screenshot of the Azure portal that shows the Databases page with the Create Database pane open." lightbox="../../media/quickstart-deploy-restful-api-app/postgresql-create-database.png":::

0 commit comments

Comments
 (0)