You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/spring-apps/includes/quickstart-deploy-restful-api-app/deploy-restful-api-app-with-consumption-plan.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ For clarity of structure, a separate markdown file is used to describe how to de
17
17
18
18
To deploy the RESTful API app, the first step is to prepare the Spring project to run locally.
19
19
20
-
####[Azure portal](#tab/Azure-portal)
20
+
### [Azure portal](#tab/Azure-portal)
21
21
22
22
Use the following steps to clone and run the app locally.
23
23
@@ -34,7 +34,7 @@ Use the following steps to clone and run the app locally.
The following list describes the different options to create resources and deploy applications in Azure Spring Apps:
15
+
The following list describes the different options of creating resources and deploying applications in Azure Spring Apps:
16
16
17
-
- Azure portal: Use the Azure portal to create resources and deploy applications step by step. The Azure portal is suitable for developers who are using the Azure Cloud Services for the first time.
18
-
- Azure Developer CLI: Use the Azure Developer CLI to create resources and deploy applications through simple commands, and to cover application code and infrastructure as code files needed to provision the Azure resources. The Azure Developer CLI is suitable for developers who are familiar with the Azure Cloud Services.
17
+
- Azure portal: Use the Azure portal to create resources and deploy applications step by step. The Azure portal is suitable for developers who are using Azure Cloud Services for the first time.
18
+
- Azure Developer CLI: Use the Azure Developer CLI to create resources and deploy applications through simple commands, and to cover application code and infrastructure as code files needed to provision the Azure resources. The Azure Developer CLI is suitable for developers who are familiar with Azure Cloud Services.
Copy file name to clipboardExpand all lines: articles/spring-apps/quickstart-deploy-restful-api-app.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,15 +44,15 @@ The following diagram shows the architecture of the system:
44
44
- An Azure subscription. If you don't have a subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
45
45
-[Git](https://git-scm.com/downloads).
46
46
-[Java Development Kit (JDK)](/java/azure/jdk/), version 17.
47
-
- A Microsoft Entra ID tenant. For instructions on creating one, see [Quickstart: Create a new tenant in Azure AD](../active-directory/fundamentals/create-new-tenant.md).
47
+
- A Microsoft Entra ID tenant. For instructions on creating one, see [Quickstart: Create a new tenant in Microsoft Entra ID](../active-directory/fundamentals/create-new-tenant.md).
- An Azure subscription. If you don't have a subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
53
53
-[Git](https://git-scm.com/downloads).
54
54
-[Java Development Kit (JDK)](/java/azure/jdk/), version 17.
55
-
- A Microsoft Entra ID tenant. For instructions on creating one, see [Quickstart: Create a new tenant in Azure AD](../active-directory/fundamentals/create-new-tenant.md).
55
+
- A Microsoft Entra ID tenant. For instructions on creating one, see [Quickstart: Create a new tenant in Microsoft Entra ID](../active-directory/fundamentals/create-new-tenant.md).
56
56
-[Azure Developer CLI (AZD)](https://aka.ms/azd-install), version 1.0.2 or higher.
57
57
-[curl](https://curl.se/download.html).
58
58
@@ -76,7 +76,7 @@ Use the following steps to register an application in Microsoft Entra ID, which
76
76
77
77
1. If you have access to multiple tenants, use the **Directory + subscription** filter (:::image type="icon" source="media/quickstart-deploy-restful-api-app/portal-directory-subscription-filter.png" border="false":::) to select the tenant in which you want to register an application.
78
78
79
-
1. Search for and select **Azure Active Directory**.
79
+
1. Search for and select **Microsoft Entra ID**.
80
80
81
81
1. Under **Manage**, select **App registrations** > **New registration**.
82
82
@@ -88,15 +88,15 @@ Use the following steps to register an application in Microsoft Entra ID, which
88
88
89
89
1. On the app **Overview** page, look for the **Application (client) ID** value, and then record it for later use. You need it to acquire access token.
90
90
91
-
1. Select **API permissions** > **Add a permission** > **My APIs**. Select the **ToDo** application that you registered earlier, and then select the permissions **ToDo.Read**, **ToDo.Write**, and **ToDo.Delete**. Select **Add permissions**.
91
+
1. Select **API permissions** > **Add a permission** > **My APIs**. Select the `ToDo` application that you registered earlier, and then select the permissions **ToDo.Read**, **ToDo.Write**, and **ToDo.Delete**. Select **Add permissions**.
92
92
93
93
1. Select **Grant admin consent for {your-tenant-name}** to grant admin consent for the permissions you added.
94
94
95
95
:::image type="content" source="media/quickstart-deploy-restful-api-app/api-permissions.png" alt-text="Image that shows the API permissions of a web application." lightbox="media/quickstart-deploy-restful-api-app/api-permissions.png":::
96
96
97
97
#### Add user to access the RESTful APIs
98
98
99
-
Use the following steps to create a member user in your Microsoft Entra ID, then the user can manage the data of the ToDo application through RESTful APIs.
99
+
Use the following steps to create a member user in your Microsoft Entra ID, then the user can manage the data of the `ToDo` application through RESTful APIs.
100
100
101
101
1. Under **Manage**, select **Users** > **New user** > **Create new user**.
102
102
@@ -109,7 +109,7 @@ Use the following steps to create a member user in your Microsoft Entra ID, then
109
109
> [!NOTE]
110
110
>
111
111
> - New users must complete the first login authentication and update their passwords, otherwise, you receive an `AADSTS50055: The password is expired` error when you get the access token.
112
-
> - When a new user logs in, they will receive an **Action Required** prompt. You may choose to **Ask later** to skip the validation.
112
+
> - When a new user logs in, they will receive an **Action Required** prompt. You may choose **Ask later** to skip the validation.
113
113
114
114
1. Select **Review + create** to review your selections. Select **Create** to create the user.
115
115
@@ -119,11 +119,11 @@ Use the following steps to update the OAuth2 configuration for Swagger UI author
119
119
120
120
1. Open the Azure Spring Apps instance in the Azure portal.
121
121
122
-
1. Open your **Azure Active Directory** tenant in the Azure portal, go to the registered app `ToDoWeb`.
122
+
1. Open your **Microsoft Entra ID** tenant in the Azure portal, and go to the registered app `ToDoWeb`.
123
123
124
124
1. Under **Manage**, select **Authentication**, select **Add a platform**, and then select **Single-page application**.
125
125
126
-
1. Use this format `<your-app-exposed-application-url-or-endpoint>/swagger-ui/oauth2-redirect.html` as the OAuth2 redirect url in the **Redirect URIs** field, such as `https://simple-todo-api.xxxxxxxx-xxxxxxxx.xxxxxx.azurecontainerapps.io/swagger-ui/oauth2-redirect.html`, and then select **Configure**.
126
+
1. Use the format `<your-app-exposed-application-url-or-endpoint>/swagger-ui/oauth2-redirect.html` as the OAuth2 redirect url in the **Redirect URIs** field, such as `https://simple-todo-api.xxxxxxxx-xxxxxxxx.xxxxxx.azurecontainerapps.io/swagger-ui/oauth2-redirect.html`, and then select **Configure**.
127
127
128
128
:::image type="content" source="media/quickstart-deploy-restful-api-app/aad-spa-auth.png" alt-text="Image that shows the SPA authentication in Microsoft Entra ID." lightbox="media/quickstart-deploy-restful-api-app/aad-spa-auth.png":::
129
129
@@ -133,21 +133,21 @@ Use the following steps to use [OAuth 2.0 authorization code flow](../active-dir
133
133
134
134
1. Open the URL exposed by the app, then select **Authorize** to prepare the OAuth2 authentication.
135
135
136
-
1. In the **Available authorizations** window, enter the client ID of the app `ToDoWeb` in the **client_id** field, and select all the scopes for **Scopes** field, ignore the **client_secret** field, then select **Authorize** to redirect to the Microsoft Entra ID login page.
136
+
1. In the **Available authorizations** window, enter the client ID of the app `ToDoWeb` in the **client_id** field, select all the scopes for **Scopes** field, ignore the **client_secret** field, and then select **Authorize** to redirect to the Microsoft Entra ID login page.
137
137
138
138
1. After completing the login with the previous user, you'll return to the following pop-up window:
139
139
140
-
:::image type="content" source="media/quickstart-deploy-restful-api-app/swagger-ui-logged.png" alt-text="Image that shows the logged of Swagger UI authorization." lightbox="media/quickstart-deploy-restful-api-app/swagger-ui-logged.png":::
140
+
:::image type="content" source="media/quickstart-deploy-restful-api-app/swagger-ui-logged.png" alt-text="Image that shows the logged in window of Swagger UI authorization." lightbox="media/quickstart-deploy-restful-api-app/swagger-ui-logged.png":::
141
141
142
142
### Access the RESTful APIs
143
143
144
144
Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger UI.
145
145
146
-
1. Select the API **POST /api/simple-todo/lists** and select **Try it out**. Enter the following request body, then select **Execute** to create a ToDo list.
146
+
1. Select the API **POST /api/simple-todo/lists** and select **Try it out**. Enter the following request body, and then select **Execute** to create a ToDo list.
147
147
148
148
```json
149
149
{
150
-
"name": "My List"
150
+
"name": "My List"
151
151
}
152
152
```
153
153
@@ -160,8 +160,8 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
160
160
"description": null
161
161
}
162
162
```
163
-
164
-
1. Select the API **POST /api/simple-todo/lists/{listId}/items** and select **Try it out**. Enter the ToDo list ID you created in previous step for **listId** field, enter the following request body, then select **Execute** to create a ToDo item.
163
+
164
+
1. Select the API **POST /api/simple-todo/lists/{listId}/items** and select **Try it out**. For **listId**, enter the ToDo list ID you created previously, enter the following request body, and then select **Execute** to create a ToDo item.
165
165
166
166
```json
167
167
{
@@ -170,8 +170,8 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
170
170
"state": "todo"
171
171
}
172
172
```
173
-
174
-
Return the ToDo item:
173
+
174
+
Enter the following command to return the ToDo item:
175
175
176
176
```json
177
177
{
@@ -187,7 +187,7 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
187
187
188
188
1. Select the API **GET /api/simple-todo/lists** and select **Execute** to query ToDo lists.
189
189
190
-
Return the ToDo lists:
190
+
Enter the following command to return the ToDo lists:
191
191
192
192
```json
193
193
[
@@ -199,9 +199,9 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
199
199
]
200
200
```
201
201
202
-
1. Select the API **GET /api/simple-todo/lists/{listId}/items** and select **Try it out**. Enter the ToDo list ID you created in previous step for **listId** field, then select **Execute** to query ToDo items.
202
+
1. Select the API **GET /api/simple-todo/lists/{listId}/items** and select **Try it out**. For **listId**, enter the ToDo list ID you created previously, and then select **Execute** to query ToDo items.
203
203
204
-
Return the ToDo item:
204
+
Enter the following command to return the ToDo item:
205
205
206
206
```json
207
207
[
@@ -217,7 +217,7 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
217
217
]
218
218
```
219
219
220
-
1. Select the API **PUT /api/simple-todo/lists/{listId}/items/{itemId}** and select **Try it out**. Enter the ToDo list ID for**listId** field and ToDo item ID for **itemId** field, enter the following request body, and then select **Execute** to update the ToDo item.
220
+
1. Select the API **PUT /api/simple-todo/lists/{listId}/items/{itemId}** and select **Try it out**. For **listId**, enter the ToDo list ID. For**itemId**, enter the ToDo item ID, enter the following request body, and then select **Execute** to update the ToDo item.
221
221
222
222
```json
223
223
{
@@ -230,7 +230,7 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
230
230
}
231
231
```
232
232
233
-
Return the new ToDo item:
233
+
Enter the following command to return the new ToDo item:
234
234
235
235
```json
236
236
{
@@ -244,7 +244,7 @@ Use the following steps to access the RESTful APIs of the app `ToDo` in Swagger
244
244
}
245
245
```
246
246
247
-
1. Select the API **DELETE /api/simple-todo/lists/{listId}/items/{itemId}** and select **Try it out**. Enter the ToDo list ID for**listId** field and ToDo item ID for **itemId** field, then select **Execute** to delete the ToDo item. You should see that the server response code is `204`.
247
+
1. Select the API **DELETE /api/simple-todo/lists/{listId}/items/{itemId}** and select **Try it out**. For **listId**, enter the ToDo list ID. For**itemId**, enter the ToDo item ID, and then select **Execute** to delete the ToDo item. You should see that the server response code is `204`.
Copy file name to clipboardExpand all lines: articles/spring-apps/quickstart-deploy-web-app.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,10 +36,10 @@ The following diagram shows the architecture of the system:
36
36
37
37
::: zone pivot="sc-consumption-plan,sc-standard"
38
38
39
-
The following list describes the different options to create resources and deploy applications in Azure Spring Apps:
39
+
The following list describes the different options of creating resources and deploying applications in Azure Spring Apps:
40
40
41
-
- Azure portal: Use the Azure portal to create resources and deploy applications step by step. The Azure portal is suitable for developers who are using the Azure Cloud Services for the first time.
42
-
- Azure Developer CLI: Use the Azure Developer CLI to create resources and deploy applications through simple commands, and to cover application code and infrastructure as code files needed to provision the Azure resources. The Azure Developer CLI is suitable for developers who are familiar with the Azure Cloud Services.
41
+
- Azure portal: Use the Azure portal to create resources and deploy applications step by step. The Azure portal is suitable for developers who are using Azure Cloud Services for the first time.
42
+
- Azure Developer CLI: Use the Azure Developer CLI to create resources and deploy applications through simple commands, and to cover application code and infrastructure as code files needed to provision the Azure resources. The Azure Developer CLI is suitable for developers who are familiar with Azure Cloud Services.
0 commit comments