Skip to content

Commit 5d1d77a

Browse files
committed
added boilerplate notes to mitigate SFI issues
1 parent cd4abe7 commit 5d1d77a

File tree

9 files changed

+72
-1
lines changed

9 files changed

+72
-1
lines changed

articles/azure-functions/functions-event-hub-cosmos-db.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,9 @@ Your function app will need to access the other resources to work correctly. The
244244

245245
Use the following commands to retrieve the storage, event hub, and Azure Cosmos DB connection strings and save them in environment variables:
246246

247+
> [!NOTE]
248+
> Microsoft recommends using the most secure authentication flow available. The authentication flow described in this procedure, such as for databases, caches, messaging, or AI services, requires a very high degree of trust in the application and carries risks not present in other flows. Use this flow only when more secure options, like managed identities for passwordless or keyless connections, are not viable. For local machine operations, prefer user identities for passwordless or keyless connections.
249+
247250
# [Bash](#tab/bash)
248251

249252
```azurecli-interactive
@@ -417,6 +420,9 @@ rmdir /s /q src\test
417420

418421
For local testing, your function project will need the connection strings that you added to your function app in Azure earlier in this tutorial. Use the following Azure Functions Core Tools command, which retrieves all the function app settings stored in the cloud and adds them to your `local.settings.json` file:
419422

423+
> [!NOTE]
424+
> Microsoft recommends using the most secure authentication flow available. The authentication flow described in this procedure, such as for databases, caches, messaging, or AI services, requires a very high degree of trust in the application and carries risks not present in other flows. Use this flow only when more secure options, like managed identities for passwordless or keyless connections, are not viable. For local machine operations, prefer user identities for passwordless or keyless connections.
425+
420426
# [Bash](#tab/bash)
421427

422428
```Bash
@@ -662,6 +668,9 @@ In this tutorial, you learned how to create an Azure Function that handles Event
662668

663669
This tutorial used environment variables and application settings to store secrets such as connection strings. For information on storing these secrets in Azure Key Vault, see [Use Key Vault references for App Service and Azure Functions](../app-service/app-service-key-vault-references.md).
664670

671+
> [!NOTE]
672+
> Microsoft recommends using the most secure authentication flow available. The authentication flow described in this procedure, such as for databases, caches, messaging, or AI services, requires a very high degree of trust in the application and carries risks not present in other flows. Use this flow only when more secure options, like managed identities for passwordless or keyless connections, are not viable. For local machine operations, prefer user identities for passwordless or keyless connections.
673+
665674
Next, learn how to use Azure Pipelines CI/CD for automated deployment:
666675

667676
> [!div class="nextstepaction"]

articles/spring-apps/basic-standard/how-to-use-grpc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,8 @@ You can now configure the server and deploy the application.
266266

267267
Use the following command to deploy the newly built JAR file to your Azure Spring Apps instance.
268268

269+
[!INCLUDE [security-note](../includes/security-note.md)]
270+
269271
```azurecli
270272
az spring app deploy \
271273
--name ${CUSTOMERS_SERVICE} \

articles/spring-apps/basic-standard/includes/quickstart-deploy-event-driven-app/deploy-event-driven-app-enterprise-plan.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ Use the following steps to connect your service instances:
8686

8787
1. Configure the **Next: Authentication** tab with the following information:
8888

89+
[!INCLUDE [security-note](../../../includes/security-note.md)]
90+
8991
- **Select the authentication type you'd like to use between your compute service and target service.**: Select **Connection string**.
9092

9193
1. Select **Next: Networking**. Use the default option **Configure firewall rules to enable access to target service**.
@@ -200,6 +202,8 @@ You've now created both the Service Bus and the app in Azure Spring Apps, but th
200202

201203
1. Get the Service Bus's connection string by using the following command:
202204

205+
[!INCLUDE [security-note](../../../includes/security-note.md)]
206+
203207
```azurecli
204208
export SERVICE_BUS_CONNECTION_STRING=$( \
205209
az servicebus namespace authorization-rule keys list \

articles/spring-apps/basic-standard/includes/quickstart-deploy-web-app/deploy-enterprise-plan.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ Use the following steps to connect your service instances:
8585

8686
1. Configure the **Next: Authentication** tab with the following information:
8787

88+
[!INCLUDE [security-note](../../../includes/security-note.md)]
89+
8890
- **Select the authentication type you'd like to use between your compute service and target service.**: Select **Connection string**.
8991
- **Continue with...**: Select **Database credentials**
9092
- **Username**: *myadmin*
@@ -102,6 +104,8 @@ Use the following steps to connect your service instances:
102104

103105
Create variables to hold the resource names by using the following commands. Be sure to replace the placeholders with your own values.
104106

107+
[!INCLUDE [security-note](../../../includes/security-note.md)]
108+
105109
```azurecli
106110
export RESOURCE_GROUP=<resource-group-name>
107111
export LOCATION=<location>
@@ -178,6 +182,8 @@ The Spring web app uses H2 for the database in localhost, and Azure Database for
178182

179183
Use the following command to create a PostgreSQL instance:
180184

185+
[!INCLUDE [security-note](../../../includes/security-note.md)]
186+
181187
```azurecli
182188
az postgres flexible-server create \
183189
--name ${POSTGRESQL_SERVER} \
@@ -204,6 +210,8 @@ After the application instance and the PostgreSQL instance are created, the appl
204210

205211
1. Use the following command to provide the `spring.datasource.` properties to the app through environment variables:
206212

213+
[!INCLUDE [security-note](../../../includes/security-note.md)]
214+
207215
```azurecli
208216
az spring app update \
209217
--service ${AZURE_SPRING_APPS_NAME} \

articles/spring-apps/consumption-dedicated/quickstart-apps-autoscale-standard-consumption.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ Use the following steps to define autoscale settings and rules.
7171

7272
### [Azure CLI](#tab/azure-cli)
7373

74-
Use the following commands to create an application in Azure Spring Apps with an autoscaling rule, based on [Keda Azure Service Bus Scaler](https://keda.sh/docs/2.8/scalers/azure-service-bus/).
74+
Use the following commands to create an application in Azure Spring Apps with an autoscaling rule, based on [Keda Azure Service Bus Scaler](https://keda.sh/docs/2.8/scalers/azure-service-bus/).
75+
76+
[!INCLUDE [security-note](../includes/security-note.md)]
7577

7678
```azurecli-interactive
7779
az spring app create \
@@ -101,6 +103,8 @@ For information on defining custom rules, see [Keda scalers](https://keda.sh/doc
101103

102104
The following CLI commands show you how to autoscale your Spring application based on [Keda MySQL Scaler](https://keda.sh/docs/2.8/scalers/mysql/). First, create a secret to store your SQL connection string. This secret is used for your scale rule authentication. Then, set up a rule which scales the app based on the rows count of a table.
103105

106+
[!INCLUDE [security-note](../includes/security-note.md)]
107+
104108
```azurecli-interactive
105109
az spring app update \
106110
--resource-group <resource-group-name> \

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ Use the following steps to connect your service instances:
8282

8383
1. Configure the **Next: Authentication** tab with the following information:
8484

85+
[!INCLUDE [security-note](../../../includes/security-note.md)]
86+
8587
- **Select the authentication type you'd like to use between your compute service and target service.**: Select **Connection string**.
8688
- **Continue with...**: Select **Database credentials**
8789
- **Username**: *myadmin*
@@ -107,6 +109,8 @@ Use the following steps to connect your service instances:
107109

108110
Create variables to hold the resource names by using the following commands. Be sure to replace the placeholders with your own values.
109111

112+
[!INCLUDE [security-note](../../../includes/security-note.md)]
113+
110114
```azurecli
111115
export RESOURCE_GROUP=myresourcegroup
112116
export LOCATION=<location>
@@ -211,6 +215,8 @@ The Spring web app uses H2 for the database in localhost and Azure Database for
211215

212216
Use the following command to create a PostgreSQL instance:
213217

218+
[!INCLUDE [security-note](../../../includes/security-note.md)]
219+
214220
```azurecli
215221
az postgres flexible-server create \
216222
--name ${POSTGRESQL_SERVER} \
@@ -237,6 +243,8 @@ After the application instance and the PostgreSQL instance are created, the appl
237243

238244
1. Use the following command to provide the `spring.datasource.` properties to the app through environment variables:
239245

246+
[!INCLUDE [security-note](../../../includes/security-note.md)]
247+
240248
```azurecli
241249
az spring app update \
242250
--service ${AZURE_SPRING_APPS_NAME} \
@@ -424,6 +432,8 @@ Use the following steps to register the client application:
424432

425433
Use the following command to create a member user in your Microsoft Entra tenant. Then, the user can manage the data of the `ToDo` application through RESTful APIs:
426434

435+
[!INCLUDE [security-note](../../../includes/security-note.md)]
436+
427437
```azurecli
428438
az ad user create \
429439
--display-name ${NEW_MEMBER_USERNAME} \

articles/spring-apps/enterprise/quickstart-integrate-azure-database-and-redis-enterprise.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ To add persistence to the application, create an Azure Cache for Redis and an Az
3838

3939
The following steps describe how to provision an Azure Cache for Redis instance and an Azure Database for PostgreSQL Flexible Server by using the Azure CLI.
4040

41+
[!INCLUDE [security-note](../includes/security-note.md)]
42+
4143
1. Create variables to hold the resource names by using the following commands. Be sure to replace the placeholders with your own values.
4244

4345
```azurecli
@@ -66,6 +68,8 @@ The following steps describe how to provision an Azure Cache for Redis instance
6668
6769
1. Use the following command to create an Azure Database for PostgreSQL Flexible Server instance:
6870

71+
[!INCLUDE [security-note](../includes/security-note.md)]
72+
6973
```azurecli
7074
az postgres flexible-server create \
7175
--resource-group ${RESOURCE_GROUP} \
@@ -131,6 +135,8 @@ To deploy this template, follow these steps:
131135

132136
1. Enter values for the following fields:
133137

138+
[!INCLUDE [security-note](../includes/security-note.md)]
139+
134140
- **Resource Group:** Select **Create new**, enter a unique name for the **resource group**, and then select **OK**.
135141
- **cacheName:** Enter the name for the Azure Cache for Redis Server.
136142
- **dbServerName:** Enter the name for the Azure Database for PostgreSQL Flexible Server.
@@ -148,6 +154,8 @@ The following steps show how to bind applications running in the Azure Spring Ap
148154

149155
1. Use the following command to create a service connector to Azure Database for PostgreSQL for the Order Service application:
150156

157+
[!INCLUDE [security-note](../includes/security-note.md)]
158+
151159
```azurecli
152160
az spring connection create postgres-flexible \
153161
--resource-group ${RESOURCE_GROUP} \
@@ -164,6 +172,8 @@ The following steps show how to bind applications running in the Azure Spring Ap
164172

165173
1. Use the following command to create a service connector to Azure Database for PostgreSQL for the Catalog Service application:
166174

175+
[!INCLUDE [security-note](../includes/security-note.md)]
176+
167177
```azurecli
168178
az spring connection create postgres-flexible \
169179
--resource-group ${RESOURCE_GROUP} \
@@ -219,6 +229,8 @@ The following steps show how to bind applications running in the Azure Spring Ap
219229
220230
1. Use the following command to update the Order Service application:
221231

232+
[!INCLUDE [security-note](../includes/security-note.md)]
233+
222234
```azurecli
223235
az spring app update \
224236
--resource-group ${RESOURCE_GROUP} \
@@ -229,6 +241,8 @@ The following steps show how to bind applications running in the Azure Spring Ap
229241

230242
1. Use the following commands to retrieve Redis connection information and update the Cart Service application:
231243

244+
[!INCLUDE [security-note](../includes/security-note.md)]
245+
232246
```azurecli
233247
export REDIS_CONN_STR=$(az spring connection show \
234248
--resource-group ${RESOURCE_GROUP} \

articles/spring-apps/enterprise/quickstart-key-vault-enterprise.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ The following instructions describe how to create a Key Vault and securely save
3838

3939
1. Create variables to hold the resource names by using the following commands. Be sure to replace the placeholders with your own values.
4040

41+
[!INCLUDE [security-note](../includes/security-note.md)]
42+
4143
```azurecli
4244
export RESOURCE_GROUP=<resource-group-name>
4345
export KEY_VAULT_NAME=<key-vault-name>
@@ -76,6 +78,8 @@ The following instructions describe how to create a Key Vault and securely save
7678

7779
1. Use the following commands to store the database login credentials in Key Vault:
7880

81+
[!INCLUDE [security-note](../includes/security-note.md)]
82+
7983
```azurecli
8084
az keyvault secret set \
8185
--vault-name ${KEY_VAULT_NAME} \
@@ -90,6 +94,8 @@ The following instructions describe how to create a Key Vault and securely save
9094

9195
1. Use the following command to store the database connection string in Key Vault for the Order Service application:
9296

97+
[!INCLUDE [security-note](../includes/security-note.md)]
98+
9399
```azurecli
94100
az keyvault secret set \
95101
--vault-name ${KEY_VAULT_NAME} \
@@ -99,6 +105,8 @@ The following instructions describe how to create a Key Vault and securely save
99105

100106
1. Use the following commands to retrieve Redis connection properties and store them in Key Vault:
101107

108+
[!INCLUDE [security-note](../includes/security-note.md)]
109+
102110
```azurecli
103111
export REDIS_HOST=$(az redis show \
104112
--resource-group ${RESOURCE_GROUP} \
@@ -259,6 +267,8 @@ After granting access to read secrets from Key Vault, use the following steps to
259267

260268
1. Use the following command to update the Order Service environment with the URI to access Key Vault:
261269

270+
[!INCLUDE [security-note](../includes/security-note.md)]
271+
262272
```azurecli
263273
az spring app update \
264274
--resource-group ${RESOURCE_GROUP} \
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
author: KarlErickson
3+
ms.author: karler
4+
ms.service: azure-spring-apps
5+
ms.topic: include
6+
ms.date: 11/21/2024
7+
---
8+
9+
> [!NOTE]
10+
> Microsoft recommends using the most secure authentication flow available. The authentication flow described in this procedure, such as for databases, caches, messaging, or AI services, requires a very high degree of trust in the application and carries risks not present in other flows. Use this flow only when more secure options, like managed identities for passwordless or keyless connections, are not viable. For local machine operations, prefer user identities for passwordless or keyless connections.

0 commit comments

Comments
 (0)