Skip to content

Commit 359d1ac

Browse files
authored
Merge pull request #199276 from maud-lv/ml-sc-cliquickstart
Add quickstart and minor text updates
2 parents 0ec2b09 + 554c734 commit 359d1ac

File tree

5 files changed

+128
-22
lines changed

5 files changed

+128
-22
lines changed

articles/service-connector/index.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ metadata:
99
ms.service: service-connector
1010
ms.custom: event-tier1-build-2022
1111
ms.topic: landing-page
12-
author: shizn
13-
ms.author: xshi
14-
ms.date: 10/29/2021
12+
author: maud-lv
13+
ms.author: malev
14+
ms.date: 05/24/2022
1515
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | sample | tutorial | video | whats-new
1616

1717
landingContent:

articles/service-connector/overview.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ ms.author: xshi
66
ms.service: service-connector
77
ms.custom: event-tier1-build-2022
88
ms.topic: overview
9-
ms.date: 05/03/2022
9+
ms.date: 05/24/2022
1010
---
1111

1212
# What is Service Connector?
1313

14-
The Service Connector service helps you connect Azure compute services to other backing services. This service configures the network settings and connection information (for example, generating environment variables) between compute services and target backing services in management plane. Developers use their preferred SDK or library that consumes the connection information to do data plane operations against the target backing service.
14+
Service Connector helps you connect Azure compute services to other backing services. This service configures the network settings and connection information (for example, generating environment variables) between compute services and target backing services in management plane. Developers use their preferred SDK or library that consumes the connection information to do data plane operations against the target backing service.
1515

1616
This article provides an overview of Service Connector.
1717

@@ -26,9 +26,9 @@ Any application that runs on Azure compute services and requires a backing servi
2626

2727
See [what services are supported in Service Connector](#what-services-are-supported-in-service-connector) to see more supported services and application patterns.
2828

29-
## What are the benefits using Service Connector?
29+
## What are the benefits to using Service Connector?
3030

31-
**Connect to target backing service with just a single command or a few clicks:**
31+
**Connect to a target backing service with just a single command or a few clicks:**
3232

3333
Service Connector is designed for your ease of use. To create a connection, you'll need three required parameters: a target service instance, an authentication type between the compute service and the target service, and your application client type. Developers can use the Azure CLI or the guided Azure portal experience to create connections.
3434

@@ -42,6 +42,7 @@ Once a service connection is created, developers can validate and check the heal
4242

4343
* Azure App Service
4444
* Azure Spring Cloud
45+
* Azure Container Apps
4546

4647
**Target Services:**
4748

@@ -62,7 +63,7 @@ Once a service connection is created, developers can validate and check the heal
6263
There are two major ways to use Service Connector for your Azure application:
6364

6465
* **Azure CLI:** Create, list, validate and delete service-to-service connections with connection commands in the Azure CLI.
65-
* **Azure Portal:** Use the guided portal experience to create service-to-service connections and manage connections with a hierarchy list.
66+
* **Azure portal:** Use the guided portal experience to create service-to-service connections and manage connections with a hierarchy list.
6667

6768
## Next steps
6869

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
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
4+
author: maud-lv
5+
ms.author: malev
6+
ms.service: service-connector
7+
ms.topic: quickstart
8+
ms.date: 05/24/2022
9+
ms.devlang: azurecli
10+
---
11+
12+
# Quickstart: Create a service connection in Container Apps with the Azure CLI
13+
14+
This quickstart shows you how to create a service connection in Container Apps with the Azure CLI. The [Azure CLI](/cli/azure) is a set of commands used to create and manage Azure resources. The Azure CLI is available across Azure services and is designed to get you working quickly with Azure, with an emphasis on automation.
15+
16+
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
17+
18+
[!INCLUDE [azure-cli-prepare-your-environment.md](../../includes/azure-cli-prepare-your-environment.md)]
19+
20+
- Version 2.37.0 or higher of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
21+
22+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/dotnet).
23+
24+
- An application deployed to Container Apps in a [region supported by Service Connector](./concept-region-support.md). If you don't have one yet, [create and deploy a container to Container Apps](../container-apps/quickstart-portal.md).
25+
26+
> [!IMPORTANT]
27+
> Service Connector in Container Apps is currently in preview.
28+
> 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.
29+
30+
## View supported target services
31+
32+
Use the following Azure CLI command to create and manage service connections from Container Apps.
33+
34+
```azurecli-interactive
35+
az provider register -n Microsoft.ServiceLinker
36+
az containerapp connection list-support-types --output table
37+
```
38+
39+
## Create a service connection
40+
41+
### [Using an access key](#tab/using-access-key)
42+
43+
1. Use the following Azure CLI command to create a service connection from Container Apps to a Blob Storage with an access key.
44+
45+
```azurecli-interactive
46+
az containerapp connection create storage-blob --secret
47+
```
48+
49+
1. Provide the following information at the Azure CLI's request:
50+
51+
- **The resource group which contains the container app**: the name of the resource group with the container app.
52+
- **Name of the container app**: the name of your container app.
53+
- **The container where the connection information will be saved:** the name of the container, in your container app, that connects to the target service
54+
- **The resource group which contains the storage account:** the name of the resource group name with the storage account. In this guide, we're using a Blob Storage.
55+
- **Name of the storage account:** the name of the storage account that contains your blob.
56+
57+
> [!NOTE]
58+
> If you don't have a Blob Storage, you can run `az containerapp connection create storage-blob --new --secret` to provision a new Blob Storage and directly get connected to your app service.
59+
60+
### [Using a managed identity](#tab/using-managed-identity)
61+
62+
> [!IMPORTANT]
63+
> Using a managed identity requires you have the permission to [Azure AD role assignment](../active-directory/managed-identities-azure-resources/howto-assign-access-portal.md). 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.
64+
65+
1. Use the following Azure CLI command to create a service connection from Container Apps to a Blob Storage with a system-assigned managed identity.
66+
67+
```azurecli-interactive
68+
az containerapp connection create storage-blob --system-identity
69+
```
70+
71+
1. Provide the following information at the Azure CLI's request:
72+
73+
- **The resource group which contains the container app**: the name of the resource group with the container app.
74+
- **Name of the container app**: the name of your container app.
75+
- **The container where the connection information will be saved:** the name of the container, in your container app, that connects to the target service
76+
- **The resource group which contains the storage account:** the name of the resource group name with the storage account. In this guide, we're using a Blob Storage.
77+
- **Name of the storage account:** the name of the storage account that contains your blob.
78+
79+
> [!NOTE]
80+
> If you don't have a Blob Storage, you can run `az containerapp connection create storage-blob --new --system-identity` to provision a new Blob Storage and directly get connected to your app service.
81+
82+
---
83+
84+
## View connections
85+
86+
Use the Azure CLI command `az containerapp connection list` to list all your container app's provisioned connections. Provide the following information:
87+
88+
- **Source compute service resource group name:** the resource group name of the container app.
89+
- **Container app name:** the name of your container app.
90+
91+
```azurecli-interactive
92+
az containerapp connection list -g "<your-container-app-resource-group>" --name "<your-container-app-name>" --output table
93+
```
94+
95+
The output also displays the provisioning state of your connections: failed or succeeded.
96+
97+
## Next steps
98+
99+
> [!div class="nextstepaction"]
100+
> [Service Connector internals](./concept-service-connector-internals.md)

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: shizn
55
ms.author: xshi
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 05/03/2022
8+
ms.date: 03/24/2022
99
ms.devlang: azurecli
1010
ms.custom: event-tier1-build-2022
1111
---
@@ -22,10 +22,9 @@ The [Azure CLI](/cli/azure) is a set of commands used to create and manage Azure
2222

2323
- At least one Spring Cloud application running on Azure. If you don't have a Spring Cloud application, [create one](../spring-cloud/quickstart.md).
2424

25-
2625
## View supported target service types
2726

28-
Use the Azure CLI [[az spring-cloud connection](quickstart-cli-spring-cloud-connection.md)] command to create and manage service connections to your Spring Cloud application.
27+
Use the Azure CLI [[az spring-cloud connection](quickstart-cli-spring-cloud-connection.md)] command to create and manage service connections to your Spring Cloud application.
2928

3029
```azurecli-interactive
3130
az provider register -n Microsoft.ServiceLinker
@@ -34,9 +33,9 @@ az spring-cloud connection list-support-types --output table
3433

3534
## Create a service connection
3635

37-
#### [Using an access key](#tab/Using-access-key)
36+
### [Using an access key](#tab/Using-access-key)
3837

39-
Use the Azure CLI [az spring-cloud connection]() command to create a service connection to an Azure Blob Storage with an access key, providing the following information:
38+
Use the Azure CLI command `az spring-cloud connection` to create a service connection to an Azure Blob Storage with an access key, providing the following information:
4039

4140
- **Spring Cloud resource group name:** the resource group name of the Spring Cloud.
4241
- **Spring Cloud name:** the name of your Spring Cloud.
@@ -51,12 +50,12 @@ az spring-cloud connection create storage-blob --secret
5150
> [!NOTE]
5251
> If you don't have a Blob Storage, you can run `az spring-cloud connection create storage-blob --new --secret` to provision a new one and directly get connected to your app service.
5352
54-
#### [Using Managed Identity](#tab/Using-Managed-Identity)
53+
### [Using Managed Identity](#tab/Using-Managed-Identity)
5554

5655
> [!IMPORTANT]
5756
> To use Managed Identity, you must have permission to manage [role assignments in Azure Active Directory](../active-directory/managed-identities-azure-resources/howto-assign-access-portal.md). If you don't have this permission, your connection creation will fail. You can ask your subscription owner to grant you a role assignment permission or use an access key to create the connection.
5857
59-
Use the Azure CLI [az spring-cloud connection](quickstart-cli-spring-cloud-connection.md) command to create a service connection to a Blob Storage with System-assigned Managed Identity, providing the following information:
58+
Use the Azure CLI command `az spring-cloud connection` to create a service connection to a Blob Storage with System-assigned Managed Identity, providing the following information:
6059

6160
- **Spring Cloud resource group name:** the resource group name of the Spring Cloud.
6261
- **Spring Cloud name:** the name of your Spring Cloud.
@@ -86,5 +85,5 @@ az spring-cloud connection list -g <your-spring-cloud-resource-group> --spring-c
8685
Follow the tutorials listed below to start building your own application with Service Connector.
8786

8887
> [!div class="nextstepaction"]
89-
> - [Tutorial: Spring Cloud + MySQL](./tutorial-java-spring-mysql.md)
90-
> - [Tutorial: Spring Cloud + Apache Kafka on Confluent Cloud](./tutorial-java-spring-confluent-kafka.md)
88+
> [Tutorial: Spring Cloud + MySQL](./tutorial-java-spring-mysql.md)
89+
> [Tutorial: Spring Cloud + Apache Kafka on Confluent Cloud](./tutorial-java-spring-confluent-kafka.md)

articles/service-connector/toc.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,25 @@ items:
99
- name: Service Connector in Azure App Service
1010
expanded: true
1111
items:
12-
- name: Portal
12+
- name: Azure portal
1313
href: quickstart-portal-app-service-connection.md
14-
- name: CLI
14+
- name: Azure CLI
1515
href: quickstart-cli-app-service-connection.md
1616
- name: Service Connector in Azure Spring Cloud
1717
expanded: true
1818
items:
19-
- name: Portal
19+
- name: Azure portal
2020
href: quickstart-portal-spring-cloud-connection.md
21-
- name: CLI
21+
- name: Azure CLI
2222
href: quickstart-cli-spring-cloud-connection.md
2323
- name: Service Connector in Container Apps
24-
href: quickstart-portal-container-apps.md
24+
expanded: true
25+
items:
26+
- name: Azure portal
27+
href: quickstart-portal-container-apps.md
28+
- name: Azure CLI
29+
href: quickstart-cli-container-apps.md
30+
2531
- name: Tutorials
2632
expanded: true
2733
items:

0 commit comments

Comments
 (0)