Skip to content

Commit ee905c4

Browse files
authored
Merge pull request #292132 from maud-lv/ml-screfreshdec
Content refresh
2 parents beca54d + be02b9b commit ee905c4

9 files changed

+115
-105
lines changed

articles/service-connector/concept-permission.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
---
22
title: Permission requirement for Service Connector
3-
description: Resource permission requirement
3+
description: Learn about the resource permission requirements for creating connections using Service Connector in Azure.
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: conceptual
8-
ms.date: 08/04/2023
8+
ms.date: 12/18/2024
99
---
1010

11-
# Permission requirement for Service Connector
11+
# Permission requirements for Service Connector
1212

13-
Service Connector creates connections between Azure services using an [on-behalf-of token](../active-directory/develop/v2-oauth2-on-behalf-of-flow.md). Creating a connection to a specific Azure resource requires its corresponding permissions.
13+
When using Service Connector to create connections between Azure services, it's essential to ensure that the necessary permissions are granted. This document outlines the permission requirements for various Azure resources to facilitate seamless connection creation.
14+
15+
Service Connector creates connections between Azure services using an [on-behalf-of tokens](../active-directory/develop/v2-oauth2-on-behalf-of-flow.md).
16+
17+
Creating connections to Azure resources requires appropriate permissions.
1418

1519
### App Service
1620

@@ -318,5 +322,8 @@ Service Connector may need to grant permissions to your identity if a connection
318322
> |`Microsoft.Network/networkSecurityGroups/join/action`|Joins a network security group. Not Alertable.|
319323
> |`Microsoft.Network/routeTables/join/action`|Joins a route table. Not Alertable.|
320324
321-
> [!div class="nextstepaction"]
322-
> [High availability](./concept-availability.md)
325+
## Related links
326+
327+
- [FAQ](./faq.yml)
328+
- [Service internals](./concept-service-connector-internals.md)
329+
- [Microsoft Entra roles assigned by Service Connector](./concept-microsoft-entra-roles.md)

articles/service-connector/how-to-build-connections-with-iac-tools.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
title: Create connections with IaC tools
3-
description: Learn how to translate your infrastructure to an IaC template
3+
description: Learn how to create connections using Infrastructure as Code (IaC) tools and translate your infrastructure configurations into IaC templates for CI/CD pipelines.
44
author: houk-ms
55
ms.service: service-connector
66
ms.topic: how-to
7-
ms.date: 10/20/2023
7+
ms.date: 12/18/2024
88
ms.author: honc
99
---
10-
# How to translate your infrastructure to an IaC template
10+
# How to create connections with IaC tools
1111

12-
Service Connector helps users connect their compute services to target backing services in just a few clicks or commands. When moving from a getting-started to a production stage, users also need to make the transition from using manual configurations to using Infrastructure as Code (IaC) templates in their CI/CD pipelines. In this guide, we show how to translate your connected Azure services to IaC templates.
12+
Service Connector helps users connect their compute services to target backing services in just a few clicks or commands. When moving from a getting-started to a production stage, users also need to make the transition from using manual configurations to using Infrastructure as Code (IaC) templates in their CI/CD pipelines.
13+
14+
In this guide, you learn how to translate your connected Azure services to IaC templates.
1315

1416
## Prerequisites
1517

@@ -114,13 +116,13 @@ resource storageAccount 'Microsoft.Storage/storageAccounts@2023-01-01' = {
114116

115117
If the resources you're provisioning are exactly the same ones as the ones you have in the cloud, exporting the template from Azure might be another option. The two premises of this approach are: the resources exist in Azure and you're using ARM templates for your IaC. The `Export template` button is usually at the bottom of the sidebar on Azure portal. The exported ARM template reflects the resource's current states, including the settings configured by Service Connector. You usually need to know about the resource properties to polish the exported template.
116118

117-
:::image type="content" source="./media/how-to/export-webapp-template.png" alt-text="Screenshot of the Azure portal, exporting arm template of a web app.":::
119+
:::image type="content" source="./media/how-to/export-webapp-template.png" alt-text="Screenshot of the Azure portal, exporting ARM template of a web app.":::
118120

119121
### Build connection logic
120122

121123
#### Using Service Connector and storing configuration in App Configuration
122124

123-
Using the App Configuration to store configuration naturally supports IaC scenarios. We therefore recommend you use this method to build your IaC template if possible.
125+
Using App Configuration to store configuration naturally supports IaC scenarios. We therefore recommend you use this method to build your IaC template if possible.
124126

125127
For simple portal instructions, you can refer to [this App Configuration tutorial](./tutorial-portal-app-configuration-store.md). To add this feature into a bicep file, add the App Configuration ID in the Service Connector payload.
126128

@@ -160,7 +162,7 @@ resource serviceConnector 'Microsoft.ServiceLinker/linkers@2022-05-01' = {
160162

161163
#### Using Service Connector
162164

163-
Creating connections between the source and target service using Service Connector is the preferred and recommended way if the [Service Connector ](./known-limitations.md)[IaC limitation](./known-limitations.md) doesn't matter for your scenario. Service Connector makes the template simpler and also provides additional elements, such as the connection health validation, which you won't have if you're building connections through template logic directly.
165+
Creating connections between the source and target service using Service Connector is the preferred and recommended approach, provided that the [Service Connector ](./known-limitations.md)[IaC limitation](./known-limitations.md) doesn't negatively impact your scenario. Service Connector simplifies the template and provides additional features, such as a connection health validation, which aren't available when building connections directly through template logic.
164166

165167
```bicep
166168
// The template builds a connection between a webapp and a storage account
@@ -200,7 +202,7 @@ resource serviceConnector 'Microsoft.ServiceLinker/linkers@2022-05-01' = {
200202

201203
For the formats of properties and values needed when creating a Service Connector resource, check [how to provide correct parameters](./how-to-provide-correct-parameters.md). You can also preview and download an ARM template for reference when creating a Service Connector resource in the Azure portal.
202204

203-
:::image type="content" source="./media/how-to/export-sc-template.png" alt-text="Screenshot of the Azure portal, exporting arm template of a service connector resource.":::
205+
:::image type="content" source="./media/how-to/export-sc-template.png" alt-text="Screenshot of the Azure portal, exporting ARM template of a service connector resource.":::
204206

205207
#### Using template logic
206208

articles/service-connector/how-to-provide-correct-parameters.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Provide correct parameters to Service Connector
3-
description: Learn how to pass correct parameters to Service Connector.
3+
description: Learn how to pass correct parameters to Service Connector to generate service connections between your Cloud resources.
44
author: houk-ms
55
ms.service: service-connector
66
ms.topic: how-to
7-
ms.date: 09/11/2023
7+
ms.date: 12/18/2024
88
ms.author: honc
99
---
1010
# Provide correct parameters to Service Connector
@@ -83,9 +83,9 @@ Client type refers to your compute service's runtime stack or development framew
8383
* `ruby`
8484
* `springBoot`
8585

86-
A different subset of the client types can be used when specifying a different target service and a different authentication type, check [how to integrate with target services](./how-to-integrate-postgres.md) for their combinations.
86+
A different subset of the client types can be used when specifying a different target service and a different authentication type, check [how to integrate with target services](./how-to-integrate-ai-services.md) for their combinations.
8787

88-
## Next steps
88+
## Related links
8989

90-
> [!div class="nextstepaction"]
91-
> [How to integrate target services](./how-to-integrate-postgres.md)
90+
- [How to integrate target services](./how-to-integrate-ai-services.md)
91+
- [Create connections with IaC tools](./how-to-build-connections-with-iac-tools.md)

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

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
11
---
2-
title: Quickstart - Create a service connection in Container Apps using the Azure CLI
3-
description: Quickstart showing how to create a service connection in Azure Container Apps using the Azure CLI
2+
title: 'Create a service connection in Container Apps - Azure CLI'
3+
description: Learn how to create a service connection in Azure Container Apps using the Azure CLI. This quickstart guides you through the process step-by-step.
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: 12/18/2024
99
ms.devlang: azurecli
1010
ms.custom: devx-track-azurecli, build-2024
1111
---
1212

13-
# Quickstart: Create a service connection in Azure Container Apps with the Azure CLI
13+
# Quickstart: Create a service connection in Azure Container Apps with the Azure CLI (preview)
1414

15-
This quickstart shows you how to connect Azure Container Apps to other Cloud resources using the Azure CLI and Service Connector. Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.
16-
17-
> [!IMPORTANT]
18-
> Service Connector in Container Apps is currently in preview.
19-
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
15+
This quickstart shows you how to connect Azure Container Apps to other Cloud resources using the Azure CLI and Service Connector (preview). Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.
2016

2117
## Prerequisites
2218

23-
- An Azure subscription. [!INCLUDE [quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)]
19+
- An active Azure subscription. [!INCLUDE [quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)]
2420

25-
- At least one application deployed to Container Apps in a [region supported by Service Connector](./concept-region-support.md). If you don't have one, [create and deploy a container to Container Apps](../container-apps/quickstart-portal.md).
21+
- At least one application deployed to Azure Container Apps in a [region supported by Service Connector](./concept-region-support.md). If you don't have one, [create and deploy a container to Container Apps](../container-apps/quickstart-portal.md).
2622

2723
[!INCLUDE [azure-cli-prepare-your-environment-no-header.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)]
2824

2925
- Version 2.37.0 or higher of the Azure CLI must be installed. To upgrade to the latest version, run `az upgrade`. If using Azure Cloud Shell, the latest version is already installed.
3026

3127
- The Container Apps extension must be installed in the Azure CLI or the Cloud Shell. To install it, run `az extension add --name containerapp`.
3228

33-
## Initial set-up
29+
## Set up your environment
3430

3531
1. If you're using Service Connector for the first time, start by running the command [az provider register](/cli/azure/provider#az-provider-register) to register the Service Connector resource provider.
3632

@@ -47,14 +43,14 @@ This quickstart shows you how to connect Azure Container Apps to other Cloud res
4743
az containerapp connection list-support-types --output table
4844
```
4945
50-
## Create a service connection
46+
## Create a service connection (preview)
5147
5248
Create a connection using a managed identity or an access key.
5349
5450
### [Managed identity](#tab/using-managed-identity)
5551
5652
> [!IMPORTANT]
57-
> To use a managed identity, you must have the permission to modify [Microsoft Entra role assignment](/entra/identity/role-based-access-control/manage-roles-portal). Without this permission, your connection creation will fail. Ask your subscription owner to grant you this permission, or use an access key instead to create the connection.
53+
> To use a managed identity, you must have the permission to modify [Microsoft Entra role assignment](/entra/identity/role-based-access-control/manage-roles-portal). Ask your subscription owner to grant you this permission, or use an access key instead to create the connection.
5854
5955
1. Run the `az containerapp connection create` command to create a service connection from Container Apps to a Blob Storage with a system-assigned managed identity.
6056
@@ -111,7 +107,9 @@ az containerapp connection list -g "<container-app-resource-group>" --name "<con
111107

112108
The output also displays the provisioning state of your connections: failed or succeeded.
113109

114-
## Next steps
110+
## Related links
111+
112+
- [Container Apps: Connect Java Quarkus app to PostgreSQL](../container-apps/tutorial-java-quarkus-connect-managed-identity-postgresql-database.md?bc=%2fazure%2fservice-connector%2fbreadcrumb%2ftoc.json&toc=%2fazure%2fservice-connector%2fTOC.json)
113+
- [Container Apps: Connect ASP.NET Core app to App Configuration](../azure-app-configuration/quickstart-container-apps.md?bc=%2fazure%2fservice-connector%2fbreadcrumb%2ftoc.json&toc=%2fazure%2fservice-connector%2fTOC.json)
114+
115115

116-
> [!div class="nextstepaction"]
117-
> [Service Connector internals](./concept-service-connector-internals.md)

articles/service-connector/quickstart-cli-spring-cloud-connection.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Quickstart - Create a service connection in Azure Spring Apps with the Azure CLI
3-
description: Quickstart showing how to create a service connection in Azure Spring Apps with the Azure CLI
3+
description: In this step-by-step guide, learn how to create a service connection in Azure Spring Apps using the Azure CLI.
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 10/31/2022
8+
ms.date: 12/18/2024
99
ms.devlang: azurecli
1010
ms.custom: devx-track-azurecli, build-2024
1111
---
@@ -28,7 +28,7 @@ Service Connector lets you quickly connect compute services to cloud services, w
2828

2929
- The Azure Spring Apps extension must be installed in the Azure CLI or the Cloud Shell. To install it, run `az extension add --name spring`.
3030

31-
## Initial set up
31+
## Initial setup
3232

3333
1. If you're using Service Connector for the first time, start by running the command [az provider register](/cli/azure/provider#az-provider-register) to register the Service Connector resource provider.
3434

@@ -55,9 +55,9 @@ Create a connection from Azure Spring Apps using a managed identity or an access
5555
### [Managed identity](#tab/Using-Managed-Identity)
5656
5757
> [!IMPORTANT]
58-
> To use a managed identity, you must have the permission to modify [role assignments in Microsoft Entra ID](/entra/identity/role-based-access-control/manage-roles-portal). Without this permission, your connection creation will fail. Ask your subscription owner to grant you a role assignment permission or use an access key to create the connection.
58+
> To use a managed identity, you must have the permission to modify [role assignments in Microsoft Entra ID](/entra/identity/role-based-access-control/manage-roles-portal). Ask your subscription owner to grant you a role assignment permission or use an access key to create the connection.
5959
60-
1. Run the `az spring connection create` command to create a service connection to a Blob Storage with a system-assigned managed identity
60+
1. Run the `az spring connection create` command to connect application deployed to Azure Spring Apps to a Blob Storage resource, using a system-assigned managed identity.
6161
6262
1. Provide the following information at the CLI or Cloud Shell's request:
6363

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ 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

12-
# Quickstart: Create a service connection in Azure Container Apps from the Azure portal
12+
# Quickstart: Create a service connection in Azure Container Apps from the Azure portal (preview)
1313

1414
This quickstart shows you how to connect Azure Container Apps to other Cloud resources using the Azure portal and Service Connector. Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.
1515

@@ -30,7 +30,7 @@ This quickstart shows you how to connect Azure Container Apps to other Cloud res
3030

3131
Sign in to the Azure portal at [https://portal.azure.com/](https://portal.azure.com/) with your Azure account.
3232

33-
## Create a new service connection
33+
## Create a new service connection (preview)
3434

3535
Use Service Connector to create a new service connection in Container Apps.
3636

articles/service-connector/tutorial-csharp-webapp-storage-cli.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: 'Tutorial: Deploy a web application connected to Azure Blob Storage with Service Connector'
3-
description: Create a web app connected to Azure Blob Storage with Service Connector.
2+
title: Deploy a webapp connected to Azure Blob Storage
3+
description: This tutorial guides you through creating and deploying a web application that connects to Azure Blob Storage using Service Connector.
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: tutorial
8-
ms.date: 11/20/2023
8+
ms.date: 12/18/2024
99
ms.devlang: azurecli
1010
ms.custom: devx-track-azurecli
1111
---
1212

1313
# Tutorial: Deploy a web application connected to Azure Blob Storage with Service Connector
1414

15-
Learn how to access Azure Blob Storage for a web app (not a signed-in user) running on Azure App Service by using managed identities. In this tutorial, you'll use the Azure CLI to complete the following tasks:
15+
In this tutorial, you learn how to access Azure Blob Storage for a web app (not a signed-in user) running on Azure App Service by using managed identities. In this tutorial, you'll use the Azure CLI to complete the following tasks:
1616

1717
> [!div class="checklist"]
1818
>
@@ -109,7 +109,7 @@ az webapp browse --name <app-name>
109109

110110
The sample code is a web application. Each time you refresh the index page, the application creates or updates a blob with the text `Hello Service Connector! Current is {UTC Time Now}` to the storage container and reads back to show it in the index page.
111111

112-
## Next steps
112+
## Next step
113113

114114
To learn more about Service Connector, read the guide below.
115115

0 commit comments

Comments
 (0)