Skip to content

Commit 046a980

Browse files
authored
Merge pull request #288964 from maud-lv/ml-scfreshness
Review service connector docs
2 parents e088356 + d3fa1f3 commit 046a980

9 files changed

+37
-35
lines changed

articles/service-connector/concept-service-connector-internals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: malev
66
ms.service: service-connector
77
ms.custom: engagement-fy23
88
ms.topic: conceptual
9-
ms.date: 01/17/2023
9+
ms.date: 10/22/2024
1010
---
1111
# Service Connector internals
1212

articles/service-connector/known-limitations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Service Connector limitations
3-
description: Learn about current limitations in Service Connector.
3+
description: Learn about current limitations in Service Connector used to connect apps and Cloud services in Azure.
44
titleSuffix: Service Connector
55
ms.service: service-connector
66
ms.topic: troubleshooting
7-
ms.date: 03/02/2023
7+
ms.date: 10/22/2024
88
ms.author: malev
99
author: maud-lv
1010
---
@@ -14,9 +14,9 @@ In this article, learn about Service Connector's existing limitations and how to
1414

1515
## Limitations to Infrastructure as Code (IaC)
1616

17-
Service Connector has been designed to bring the benefits of easy, secure, and consistent backing service connections to as many Azure services as possible. To do so, Service Connector has been developed as an extension resource provider.
17+
Service Connector is designed to bring the benefits of easy, secure, and consistent backing service connections to as many Azure services as possible. To do so, Service Connector is developed as an extension resource provider.
1818

19-
Unfortunately, there are some limitations with IaC support as Service Connector modifies infrastructure on users' behalf. In this scenario, users would begin by using Azure Resource Manager (ARM), Bicep, Terraform, or other IaC templates to create resources. Afterwards, they would use Service Connector to set up resource connections. During this step, Service Connector modifies resource configurations on behalf of the user. If the user reruns their IaC template at a later time, modifications made by Service Connector would disappear as they were not reflected in the original IaC templates. An example of this behavior is Azure Container Apps deployed with ARM templates usually have Managed Identity (MI) disabled by default, Service Connector enables MI when setting up connections on users' behalf. If users trigger the same ARM templates without updating MI settings, the redeployed container apps will have MI disabled again.
19+
IaC support comes with some limitations, as Service Connector modifies the infrastructure on the users' behalf. In this scenario, users begin by using Azure Resource Manager (ARM), Bicep, Terraform, or other IaC templates to create resources. Afterwards, they use Service Connector to set up resource connections. During this step, Service Connector modifies resource configurations on behalf of the user. If the user reruns their IaC template at a later time, modifications made by Service Connector disappear as they weren't reflected in the original IaC templates. As an example of this behavior, Azure Container Apps resources deployed with ARM templates usually have the managed identity authentication disabled by default. Service Connector enables the managed identity when setting up connections on the users' behalf. If users trigger the same ARM templates without updating the managed identity settings, the managed identity will be disabled once again in the redeployed Azure Container Apps resource.
2020

2121
If you run into any issues when using Service Connector, [file an issue with us](https://github.com/Azure/ServiceConnector/issues/new).
2222

@@ -25,9 +25,9 @@ If you run into any issues when using Service Connector, [file an issue with us]
2525
We suggest the following solutions:
2626

2727
- Reference [how to build connections with IaC tools](how-to-build-connections-with-iac-tools.md) to build your infrastructure or translate your existing infrastructure to IaC templates.
28-
- If your CI/CD pipelines contain templates of source compute or backing services, suggested flow is: reapplying the templates, adding sanity check or smoke tests to make sure the application is up and running, then allowing live traffic to the application. The flow adds a verification step before allowing live traffic.
28+
- If your CI/CD pipelines contain templates of source compute or backing services, we suggested reapplying the templates, adding a sanity check or smoke tests to make sure the application is up and running, then allowing live traffic to the application. The flow adds a verification step before allowing live traffic.
2929
- When automating Azure Container App code deployments with Service Connector, we recommend the use of [multiple revision mode](../container-apps/revisions.md#revision-modes) to avoid routing traffic to a temporarily nonfunctional app before Service connector can reapply connections.
30-
- The order in which automation operations are performed matters greatly. Ensure your connection endpoints are there before the connection itself is created. Ideally, create the backing service, then the compute service, and then the connection between the two. This way, Service Connector can configure both the compute service and the backing service appropriately.
30+
- The order in which automation operations are performed matters. Ensure your connection endpoints are there before the connection itself is created. Ideally, create the backing service, then the compute service, and then the connection between the two. This way, Service Connector can configure both the compute service and the backing service appropriately.
3131

3232
## Next steps
3333

articles/service-connector/quickstart-portal-app-service-connection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Quickstart - Create a service connection in App Service from the Azure portal
2+
title: 'Quickstart: Create a service connection in App Service'
33
description: Quickstart showing how to create a service connection in App Service from the Azure portal
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 10/05/2023
8+
ms.date: 10/22/2024
99
#Customer intent: As an app developer, I want to connect several services together so that I can ensure I have the right connectivity to access my Azure resources.
1010
---
1111

@@ -45,7 +45,7 @@ Sign in to the Azure portal at [https://portal.azure.com/](https://portal.azure.
4545

4646
1. Select **Next: Authentication** to choose an authentication method.
4747

48-
### [System-assigned managed identity](#tab/SMI)
48+
### [System-assigned managed identity (recommended)](#tab/SMI)
4949

5050
System-assigned managed identity is the recommended authentication option. Select **System-assigned managed identity** to connect through an identity that's generated in Microsoft Entra ID and tied to the lifecycle of the service instance.
5151

articles/service-connector/quickstart-portal-container-apps.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Quickstart - Create a service connection in Container Apps from the Azure portal
2+
title: 'Quickstart: Create a service connection in Container Apps'
33
description: This quickstart shows how to create a service connection in Azure Container Apps from the Azure portal
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 10/31/2023
8+
ms.date: 10/22/2024
99
#Customer intent: As an app developer, I want to connect Azure Container Apps to a storage account in the Azure portal using Service Connector.
1010
---
1111

@@ -57,11 +57,11 @@ Use Service Connector to create a new service connection in Container Apps.
5757

5858
1. Select **Next: Authentication** to choose an authentication method: system-assigned managed identity (SMI), user-assigned managed identity (UMI), connection string, or service principal.
5959

60-
### [SMI](#tab/SMI)
60+
### [System-assigned managed identity (recommended)](#tab/SMI)
6161

6262
System-assigned managed identity is the recommended authentication option. Select **System-assigned managed identity** to connect through an identity that's automatically generated in Microsoft Entra ID and tied to the lifecycle of the service instance.
6363

64-
### [UMI](#tab/UMI)
64+
### [User-assigned managed identity](#tab/UMI)
6565

6666
Select **User-assigned managed identity** to authenticate through a standalone identity assigned to one or more instances of an Azure service. Select a subscription that contains a user-assigned managed identity, and select the identity.
6767

articles/service-connector/quickstart-portal-functions-connection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: houk-ms
55
ms.author: honc
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 10/25/2023
8+
ms.date: 10/22/2024
99
---
1010
# Quickstart: Create a service connection in a function app from the Azure portal
1111

articles/service-connector/tutorial-passwordless.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: maud-lv
66
ms.author: malev
77
ms.service: service-connector
88
ms.topic: tutorial
9-
ms.date: 09/28/2023
9+
ms.date: 10/22/2024
1010
ms.devlang: azurecli
1111
ms.custom: passwordless-dotnet, passwordless-java, devx-track-azurecli
1212
zone_pivot_group_filename: service-connector/zone-pivot-groups.json
@@ -66,7 +66,7 @@ Then you can check the log or call the application to see if it can connect to t
6666

6767
#### Permission
6868

69-
If you encounter any permission-related errors, confirm the Azure CLI signed-in user with the command `az account show`. Make sure you log in with the correct account. Next, confirm that you have the following permissions that might be required to create a passwordless connection with Service Connector.
69+
If you encounter any permission-related errors, confirm the Azure CLI signed-in user with the command `az account show`. Make sure you sign in with the correct account. Next, confirm that you have the following permissions that might be required to create a passwordless connection with Service Connector.
7070

7171
::: zone pivot="postgresql"
7272

articles/service-connector/tutorial-portal-key-vault.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
2-
title: Tutorial - Connect Azure services and store secrets in Key Vault
3-
description: Tutorial showing how to store your web app's secrets in Azure Key Vault using Service Connector
2+
title: 'Tutorial: Connect Azure services and store secrets in Key Vault'
3+
description: Tutorial showing how to store your web application's secrets in Azure Key Vault using Service Connector.
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: tutorial
8-
ms.date: 10/31/2023
8+
ms.date: 10/22/2024
9+
#customer intent: As a web developer, I want store my app's secrets in Azure Key Vault so they can be managed and protected by Azure's security features.
910
---
1011

1112
# Quickstart: Connect Azure services and store secrets in Azure Key Vault
1213

13-
Azure Key Vault is a cloud service that provides a secure store for secrets. You can securely store keys, passwords, certificates, and other secrets. When you create a service connection, you can securely store access keys and secrets into connected Key Vault. In this tutorial, you'll complete the following tasks using the Azure portal. Both methods are explained in the following procedures.
14+
Azure Key Vault is a cloud service that provides a secure store for secrets. You can securely store keys, passwords, certificates, and other secrets. When you create a service connection, you can securely store access keys and secrets into connected Key Vault. In this tutorial, you complete the following tasks using the Azure portal. Both methods are explained in the following procedures.
1415

1516
> [!div class="checklist"]
1617
> * Create a service connection to Azure Key Vault in Azure App Service
@@ -25,8 +26,8 @@ To create a service connection and store secrets in Key Vault with Service Conne
2526
* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free).
2627
* An app hosted on App Service. If you don't have one yet, [create and deploy an app to App Service](../app-service/quickstart-dotnetcore.md)
2728
* An Azure Key Vault. If you don't have one, [create an Azure Key Vault](/azure/key-vault/general/quick-create-portal)
28-
* Another target service instance supported by Service Connector. In this tutorial, you'll use [Azure Blob Storage](../storage/blobs/storage-quickstart-blobs-portal.md)
29-
* Read and write access to the App Service, Key Vault and the target service.
29+
* Another target service instance supported by Service Connector. In this tutorial, you use [Azure Blob Storage](../storage/blobs/storage-quickstart-blobs-portal.md)
30+
* Read and write access to the App Service, Key Vault, and the target service.
3031

3132
## Create a Key Vault connection in App Service
3233

@@ -52,7 +53,7 @@ To store your connection access keys and secrets into a key vault, start by conn
5253

5354
## Create a Blob Storage connection in App Service and store access keys into Key Vault
5455

55-
Now you can create a service connection to another target service and directly store access keys into a connected Key Vault when using a connection string/access key or a Service Principal for authentication. We'll use Blob Storage as an example below. Follow the same process for other target services.
56+
Now you can create a service connection to another target service and directly store access keys into a connected Key Vault when using a connection string/access key or a service principal for authentication. We use Blob Storage as an example below. Follow the same process for other target services.
5657

5758
1. In the Azure portal, type **App Service** in the search menu and select the name of the App Service you want to use from the list.
5859
1. Select **Service Connector** from the left table of contents. Then select **Create**.
@@ -83,11 +84,11 @@ Now you can create a service connection to another target service and directly s
8384

8485
### [Service principal](#tab/serviceprincipal)
8586

86-
Select **Next: Authentication** to select the authentication type and select **Service Principal** to use Service Principal to connect your storage account.
87+
Select **Next: Authentication** to select the authentication type and select **Service Principal** to use a service principal to connect your storage account.
8788

8889
| Setting | Suggested value | Description |
8990
| ------------ | ------- | -------------------------------------------------- |
90-
| **Service Principal object ID or name** | Choose the Service Principal you want to use to connect to Blob Storage from the list | The Service Principal in your subscription that is used to connect to target service. |
91+
| **Service Principal object ID or name** | Choose the service principal you want to use to connect to Blob Storage from the list | The service principal in your subscription that is used to connect to target service. |
9192
| **Store Secret to Key Vault** | Check | This option lets Service Connector store the service principal ID and secret into Key Vault. |
9293
| **Key Vault connection** | One of your key vault connections | Select the Key Vault in which you want to store your service principal ID and secret. |
9394

@@ -103,7 +104,7 @@ Now you can create a service connection to another target service and directly s
103104

104105
1. Expand the Blob Storage connection, select **Hidden value. Click to show value**. You can see that the value is a Key Vault reference.
105106

106-
1. Select the **Key Vault** in the Service Type column of your Key Vault connection. You will be redirected to the Key Vault portal page.
107+
1. Select the **Key Vault** in the Service Type column of your Key Vault connection. You'll be redirected to the Key Vault portal page.
107108

108109
1. Select **Secrets** in the Key Vault left ToC, and select the blob storage secret name.
109110

articles/service-connector/tutorial-python-functions-storage-blob-as-input.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
title: 'Tutorial: Python function with Azure Blob Storage as input'
3-
description: Learn how you can connect a Python function to a storage blob as input using Service Connector
3+
description: Learn how you can connect a Python function to a storage blob as input using Service Connector in Azure.
44
author: houk-ms
55
ms.author: honc
66
ms.service: service-connector
77
ms.custom: devx-track-python
88
ms.topic: tutorial
9-
ms.date: 10/25/2023
9+
ms.date: 10/22/2024
10+
#customer intent: As a developer, I want to configure a Python function with Storage Blob as input function binding so that I can process and manage large volumes of data stored in Azure Blob Storage.
1011
---
1112
# Tutorial: Python function with Azure Blob Storage as input
1213

13-
In this tutorial, you learn how to configure a Python function with Storage Blob as input by completing the following tasks:
14+
In this tutorial, you learn how to configure a Python function with Azure Blob storage as input by completing the following tasks:
1415

1516
> [!div class="checklist"]
1617
> * Use Visual Studio Code to create a Python function project.

0 commit comments

Comments
 (0)