Skip to content

Commit b3fe2ae

Browse files
v-regandownerv-regandowner
authored
Merge pull request #235387 from KarlErickson/doc_04_mysql_issue_17582709
edit "Update cosmos and MySQL doc errors #234624"
2 parents 2722886 + 695d8fe commit b3fe2ae

File tree

3 files changed

+31
-123
lines changed

3 files changed

+31
-123
lines changed

‎articles/spring-apps/how-to-bind-cosmos.md

Lines changed: 14 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Bind an Azure Cosmos DB to your application in Azure Spring Apps
3-
description: Learn how to bind Azure Cosmos DB to your application in Azure Spring Apps
2+
title: Connect an Azure Cosmos DB to your application in Azure Spring Apps
3+
description: Learn how to connect Azure Cosmos DB to your application in Azure Spring Apps
44
author: karlerickson
55
ms.service: spring-apps
66
ms.topic: how-to
@@ -9,7 +9,7 @@ ms.author: karler
99
ms.custom: devx-track-java, event-tier1-build-2022, ignite-2022, service-connector
1010
---
1111

12-
# Bind an Azure Cosmos DB database to your application in Azure Spring Apps
12+
# Connect an Azure Cosmos DB database to your application in Azure Spring Apps
1313

1414
> [!NOTE]
1515
> Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.
@@ -18,27 +18,24 @@ ms.custom: devx-track-java, event-tier1-build-2022, ignite-2022, service-connect
1818

1919
**This article applies to:** ✔️ Basic/Standard ✔️ Enterprise
2020

21-
Instead of manually configuring your Spring Boot applications, you can automatically bind select Azure services to your applications by using Azure Spring Apps. This article demonstrates how to bind your application to an Azure Cosmos DB database.
21+
Instead of manually configuring your Spring Boot applications, you can automatically connect selected Azure services to your applications by using Azure Spring Apps. This article demonstrates how to connect your application to an Azure Cosmos DB database.
2222

2323
## Prerequisites
2424

25-
* A deployed Azure Spring Apps instance.
26-
* An Azure Cosmos DB account and a database.
27-
* The Azure Spring Apps extension for the Azure CLI.
28-
29-
If you don't have a deployed Azure Spring Apps instance, follow the steps in the [Quickstart: Deploy your first application to Azure Spring Apps](./quickstart.md).
25+
* An application deployed to Azure Spring Apps. For more information, see [Quickstart: Deploy your first application to Azure Spring Apps](./quickstart.md).
26+
* An Azure Cosmos DB database instance.
27+
* [Azure CLI](/cli/azure/install-azure-cli) version 2.45.0 or higher.
3028

3129
## Prepare your Java project
3230

33-
1. Add one of the following dependencies to your application's pom.xml pom.xml file. Choose the dependency that is appropriate for your API type.
31+
1. Add one of the following dependencies to your application's *pom.xml* file. Choose the dependency that is appropriate for your API type.
3432

3533
* API type: NoSQL
3634

3735
```xml
3836
<dependency>
3937
<groupId>com.azure.spring</groupId>
4038
<artifactId>spring-cloud-azure-starter-data-cosmos</artifactId>
41-
<version>4.7.0</version>
4239
</dependency>
4340
```
4441

@@ -60,25 +57,15 @@ If you don't have a deployed Azure Spring Apps instance, follow the steps in the
6057
</dependency>
6158
```
6259

63-
* API type: Azure Table
64-
65-
```xml
66-
<dependency>
67-
<groupId>com.azure.spring</groupId>
68-
<artifactId>spring-cloud-azure-starter-storage-blob</artifactId>
69-
<version>4.7.0</version>
70-
</dependency>
71-
```
72-
7360
1. Update the current app by running `az spring app deploy`, or create a new deployment for this change by running `az spring app deployment create`.
7461

75-
## Bind your app to the Azure Cosmos DB
62+
## Connect your app to the Azure Cosmos DB
7663

7764
### [Service Connector](#tab/Service-Connector)
7865

7966
#### Use the Azure CLI
8067

81-
Use the following command to configure your Spring app to connect to a Cosmos SQL Database with a system-assigned managed identity:
68+
Use the Azure CLI to configure your Spring app to connect to a Cosmos SQL Database by using the `az spring connection create` command, as shown in the following example:
8269

8370
> [!NOTE]
8471
> Updating Azure Cosmos DB database settings can take a few minutes to complete.
@@ -92,7 +79,7 @@ az spring connection create cosmos-sql \
9279
--target-resource-group $COSMOSDB_RESOURCE_GROUP \
9380
--account $COSMOSDB_ACCOUNT_NAME \
9481
--database $DATABASE_NAME \
95-
--system-assigned-identity
82+
--secret
9683
```
9784

9885
> [!NOTE]
@@ -121,39 +108,6 @@ Alternately, you can use the Azure portal to configure this connection by comple
121108

122109
1. Once the connection between your Spring apps and your Cosmos DB database has been generated, you can see it in the Service Connector page and select the unfold button to view the configured connection variables.
123110

124-
### [Service Binding](#tab/Service-Binding)
125-
126-
> [!NOTE]
127-
> We recommend using Service Connector instead of Service Binding to connect your app to your database. Service Binding is going to be deprecated in favor of Service Connector. For instructions, see the Service Connector tab.
128-
129-
Azure Cosmos DB has five different API types that support binding. The following procedure shows how to use them:
130-
131-
1. Create an Azure Cosmos DB database. Refer to the quickstart on [creating a database](../cosmos-db/create-cosmosdb-resources-portal.md) for help.
132-
133-
1. Record the name of your database. For this procedure, the database name is **testdb**.
134-
135-
1. Go to your Azure Spring Apps service page in the Azure portal. Go to **Application Dashboard** and select the application to bind to Azure Cosmos DB. This application is the same one you updated or deployed in the previous step.
136-
137-
1. Select **Service binding**, and select **Create service binding**. To fill out the form, select:
138-
139-
* The **Binding type** value **Azure Cosmos DB**.
140-
* The API type.
141-
* Your database name.
142-
* The Azure Cosmos DB account.
143-
144-
> [!NOTE]
145-
> If you are using Cassandra, use a key space for the database name.
146-
147-
1. Restart the application by selecting **Restart** on the application page.
148-
149-
1. To ensure the service is bound correctly, select the binding name and verify its details. The `property` field should be similar to this example:
150-
151-
```properties
152-
spring.cloud.azure.cosmos.endpoint=https://<some account>.documents.azure.com:443
153-
spring.cloud.azure.cosmos.key=abc******
154-
spring.cloud.azure.cosmos.database=testdb
155-
```
156-
157111
### [Terraform](#tab/Terraform)
158112

159113
The following Terraform script shows how to set up an app deployed to Azure Spring Apps with an Azure Cosmos DB account.
@@ -166,7 +120,7 @@ provider "azurerm" {
166120
variable "application_name" {
167121
type = string
168122
description = "The name of your application"
169-
default = "demo-abc"
123+
default = "demo-cosmosdb"
170124
}
171125
172126
resource "azurerm_resource_group" "example" {
@@ -218,7 +172,7 @@ resource "azurerm_spring_cloud_java_deployment" "example" {
218172
cpu = "2"
219173
memory = "4Gi"
220174
}
221-
instance_count = 2
175+
instance_count = 1
222176
jvm_options = "-XX:+PrintGC"
223177
runtime_version = "Java_11"
224178
@@ -239,4 +193,4 @@ resource "azurerm_spring_cloud_active_deployment" "example" {
239193

240194
## Next steps
241195

242-
In this article, you learned how to bind your application in Azure Spring Apps to an Azure Cosmos DB database. To learn more about binding services to your application, see [Bind to an Azure Cache for Redis cache](./how-to-bind-redis.md).
196+
In this article, you learned how to connect your application in Azure Spring Apps to an Azure Cosmos DB database. To learn more about connecting services to your application, see [Connect to an Azure Cache for Redis cache](./how-to-bind-redis.md).

‎articles/spring-apps/how-to-bind-mysql.md

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: How to bind an Azure Database for MySQL instance to your application in Azure Spring Apps
3-
description: Learn how to bind an Azure Database for MySQL instance to your application in Azure Spring Apps
2+
title: How to connect an Azure Database for MySQL instance to your application in Azure Spring Apps
3+
description: Learn how to connect an Azure Database for MySQL instance to your application in Azure Spring Apps
44
author: karlerickson
55
ms.service: spring-apps
66
ms.topic: how-to
@@ -9,16 +9,16 @@ ms.author: karler
99
ms.custom: devx-track-java, event-tier1-build-2022, passwordless-java, service-connector
1010
---
1111

12-
# Bind an Azure Database for MySQL instance to your application in Azure Spring Apps
12+
# Connect an Azure Database for MySQL instance to your application in Azure Spring Apps
1313

1414
> [!NOTE]
1515
> Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.
1616
1717
**This article applies to:** ✔️ Java ❌ C#
1818

19-
**This article applies to:** ✔️ Basic/Standard tier ✔️ Enterprise tier
19+
**This article applies to:** ✔️ Basic/Standard ✔️ Enterprise
2020

21-
With Azure Spring Apps, you can bind select Azure services to your applications automatically, instead of having to configure your Spring Boot application manually. This article shows you how to bind your application to your Azure Database for MySQL instance.
21+
With Azure Spring Apps, you can connect selected Azure services to your applications automatically, instead of having to configure your Spring Boot application manually. This article shows you how to connect your application to your Azure Database for MySQL instance.
2222

2323
## Prerequisites
2424

@@ -45,7 +45,7 @@ With Azure Spring Apps, you can bind select Azure services to your applications
4545

4646
1. Update the current app by running `az spring app deploy`, or create a new deployment for this change by running `az spring app deployment create`.
4747

48-
## Bind your app to the Azure Database for MySQL instance
48+
## Connect your app to the Azure Database for MySQL instance
4949

5050
### [Service Connector](#tab/Service-Connector)
5151

@@ -56,7 +56,7 @@ Follow these steps to configure your Spring app to connect to an Azure Database
5656
```azurecli
5757
az extension add --name serviceconnector-passwordless --upgrade
5858
```
59-
59+
6060
1. Run the `az spring connection create` command, as shown in the following example.
6161

6262
```azurecli
@@ -68,33 +68,7 @@ Follow these steps to configure your Spring app to connect to an Azure Database
6868
--target-resource-group $MYSQL_RESOURCE_GROUP \
6969
--server $MYSQL_SERVER_NAME \
7070
--database $DATABASE_NAME \
71-
--system-assigned-identity
72-
```
73-
74-
### [Service Binding](#tab/Service-Binding)
75-
76-
> [!NOTE]
77-
> We recommend using Service Connector instead of Service Binding to connect your app to your database. Service Binding is going to be deprecated in favor of Service Connector. For instructions, see the Service Connector tab.
78-
79-
1. Note the admin username and password of your Azure Database for MySQL account.
80-
81-
1. Connect to the server, create a database named **testdb** from a MySQL client, and then create a new non-admin account.
82-
83-
1. In the Azure portal, on your **Azure Spring Apps** service page, look for the **Application Dashboard**, and then select the application to bind to your Azure Database for MySQL instance. This is the same application that you updated or deployed in the previous step.
84-
85-
1. Select **Service binding**, and then select the **Create service binding** button.
86-
87-
1. Fill out the form, selecting **Azure MySQL** as the **Binding type**, using the same database name you used earlier, and using the same username and password you noted in the first step.
88-
89-
1. Restart the app, and this binding should now work.
90-
91-
1. To ensure that the service binding is correct, select the binding name, and then verify its detail. The `property` field should look like this:
92-
93-
```properties
94-
spring.datasource.url=jdbc:mysql://some-server.mysql.database.azure.com:3306/testdb?useSSL=true&requireSSL=false&useLegacyDatetimeCode=false&serverTimezone=UTC
95-
spring.datasource.username=admin@some-server
96-
spring.datasource.password=abc******
97-
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
71+
--system-identity mysql-identity-id=$AZ_IDENTITY_RESOURCE_ID
9872
```
9973

10074
### [Terraform](#tab/Terraform)
@@ -209,4 +183,4 @@ resource "azurerm_spring_cloud_active_deployment" "example" {
209183

210184
## Next steps
211185

212-
In this article, you learned how to bind an application in Azure Spring Apps to an Azure Database for MySQL instance. To learn more about binding services to an application, see [Bind an Azure Cosmos DB database to an application in Azure Spring Apps](./how-to-bind-cosmos.md).
186+
In this article, you learned how to connect an application in Azure Spring Apps to an Azure Database for MySQL instance. To learn more about connecting services to an application, see [Connect an Azure Cosmos DB database to an application in Azure Spring Apps](./how-to-bind-cosmos.md).

‎articles/spring-apps/how-to-bind-redis.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Bind Azure Cache for Redis to your application in Azure Spring Apps
3-
description: Learn how to bind Azure Cache for Redis to your application in Azure Spring Apps
2+
title: Connect Azure Cache for Redis to your application in Azure Spring Apps
3+
description: Learn how to connect Azure Cache for Redis to your application in Azure Spring Apps
44
author: karlerickson
55
ms.service: spring-apps
66
ms.topic: how-to
@@ -9,16 +9,16 @@ ms.author: karler
99
ms.custom: devx-track-java, event-tier1-build-2022, service-connector
1010
---
1111

12-
# Bind Azure Cache for Redis to your application in Azure Spring Apps
12+
# Connect Azure Cache for Redis to your application in Azure Spring Apps
1313

1414
> [!NOTE]
1515
> Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.
1616
1717
**This article applies to:** ✔️ Java ❌ C#
1818

19-
**This article applies to:** ✔️ Basic/Standard tier ✔️ Enterprise tier
19+
**This article applies to:** ✔️ Basic/Standard ✔️ Enterprise
2020

21-
Instead of manually configuring your Spring Boot applications, you can automatically bind select Azure services to your applications by using Azure Spring Apps. This article shows how to bind your application to Azure Cache for Redis.
21+
Instead of manually configuring your Spring Boot applications, you can automatically connect selected Azure services to your applications by using Azure Spring Apps. This article shows how to connect your application to Azure Cache for Redis.
2222

2323
## Prerequisites
2424

@@ -43,7 +43,7 @@ If you don't have a deployed Azure Spring Apps instance, follow the steps in the
4343

4444
1. Update the current deployment using `az spring app update` or create a new deployment using `az spring app deployment create`.
4545

46-
## Bind your app to the Azure Cache for Redis
46+
## Connect your app to the Azure Cache for Redis
4747

4848
### [Service Connector](#tab/Service-Connector)
4949

@@ -77,34 +77,14 @@ If you don't have a deployed Azure Spring Apps instance, follow the steps in the
7777

7878
1. On the **Basics** tab, for service type, select Cache for Redis. Choose a subscription and a Redis cache server. Fill in the Redis database name ("0" in this example) and under client type, select Java. Select **Next: Authentication**.
7979

80-
1. On the **Authentication** tab, choose **Connection string**. Service Connector will automatically retrieve the access key from your Redis database account. Select **Next: Networking**.
80+
1. On the **Authentication** tab, choose **Connection string**. Service Connector automatically retrieves the access key from your Redis database account. Select **Next: Networking**.
8181

8282
1. On the **Networking** tab, select **Configure firewall rules to enable access to target service**, then select **Review + Create**.
8383

8484
1. On the **Review + Create** tab, wait for the validation to pass and then select **Create**. The creation can take a few minutes to complete.
8585

8686
1. Once the connection between your Spring app your Redis database has been generated, you can see it in the Service Connector page and select the unfold button to view the configured connection variables.
8787

88-
### [Service Binding](#tab/Service-Binding)
89-
90-
> [!NOTE]
91-
> We recommend using Service Connector instead of Service Binding to connect your app to your database. Service Binding is going to be deprecated in favor of Service Connector. For instructions, see the Service Connector tab.
92-
93-
1. Go to your Azure Spring Apps service page in the Azure portal. Go to **Application Dashboard** and select the application to bind to Azure Cache for Redis. This application is the same one you updated or deployed in the previous step.
94-
95-
1. Select **Service binding** and select **Create service binding**. Fill out the form, being sure to select the **Binding type** value **Azure Cache for Redis**, your Azure Cache for Redis server, and the **Primary** key option.
96-
97-
1. Restart the app. The binding should now work.
98-
99-
1. To ensure the service binding is correct, select the binding name and verify its details. The `property` field should look like this:
100-
101-
```properties
102-
spring.redis.host=some-redis.redis.cache.windows.net
103-
spring.redis.port=6380
104-
spring.redis.password=abc******
105-
spring.redis.ssl=true
106-
```
107-
10888
### [Terraform](#tab/Terraform)
10989

11090
The following Terraform script shows how to set up an Azure Spring Apps app with Azure Cache for Redis.
@@ -179,4 +159,4 @@ resource "azurerm_spring_cloud_active_deployment" "example" {
179159

180160
## Next steps
181161

182-
In this article, you learned how to bind your application in Azure Spring Apps to Azure Cache for Redis. To learn more about binding services to your application, see [Bind to an Azure Database for MySQL instance](./how-to-bind-mysql.md).
162+
In this article, you learned how to connect your application in Azure Spring Apps to Azure Cache for Redis. To learn more about connecting services to your application, see [Connect to an Azure Database for MySQL instance](./how-to-bind-mysql.md).

0 commit comments

Comments
 (0)