Skip to content

Commit 14e58f9

Browse files
authored
Merge pull request #206937 from maud-lv/ml-sc-CA-screen
Update Container Apps quickstart
2 parents a30a628 + 58428c6 commit 14e58f9

File tree

8 files changed

+124
-65
lines changed

8 files changed

+124
-65
lines changed
81.6 KB
Loading
92.7 KB
Loading
98.3 KB
Loading
85.2 KB
Loading
56.2 KB
Loading
70.3 KB
Loading

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

Lines changed: 49 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,91 +5,101 @@ author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 05/24/2022
8+
ms.date: 08/09/2022
99
ms.devlang: azurecli
1010
---
1111

1212
# Quickstart: Create a service connection in Container Apps with the Azure CLI
1313

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.
14+
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.
1515

16-
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
16+
> [!IMPORTANT]
17+
> Service Connector in Container Apps is currently in preview.
18+
> 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.
1719
18-
[!INCLUDE [azure-cli-prepare-your-environment.md](../../includes/azure-cli-prepare-your-environment.md)]
20+
## Prerequisites
1921

20-
- Version 2.37.0 or higher of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
22+
- An Azure subscription. [!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
2123

22-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free).
24+
- 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).
2325

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).
26+
[!INCLUDE [azure-cli-prepare-your-environment-no-header.md](../../includes/azure-cli-prepare-your-environment-no-header.md)]
2527

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.
28+
- 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.
2929

30-
## View supported target services
30+
- The Container Apps extension must be installed in the Azure CLI or the Cloud Shell. To install it, run `az extension add --name containerapp`.
3131

32-
Use the following Azure CLI command to create and manage service connections from Container Apps.
32+
## Prepare to create a connection
3333

34-
```azurecli-interactive
35-
az provider register -n Microsoft.ServiceLinker
36-
az containerapp connection list-support-types --output table
37-
```
34+
1. Run the command [az provider register](/cli/azure/provider#az-provider-register) to start using Service Connector.
35+
36+
```azurecli-interactive
37+
az provider register -n Microsoft.ServiceLinker
38+
```
39+
40+
1. Run the command `az containerapp connection` to get a list of supported target services for Container Apps.
41+
42+
```azurecli-interactive
43+
az containerapp connection list-support-types --output table
44+
```
3845
3946
## Create a service connection
4047
41-
### [Using an access key](#tab/using-access-key)
48+
You can create a connection using an access key or a managed identity.
49+
50+
### [Access key](#tab/using-access-key)
4251
43-
1. Use the following Azure CLI command to create a service connection from Container Apps to a Blob Storage with an access key.
52+
1. Run the `az containerapp connection create` command to create a service connection between Container Apps and Azure Blob Storage with an access key.
4453
4554
```azurecli-interactive
4655
az containerapp connection create storage-blob --secret
4756
```
4857
4958
1. Provide the following information at the Azure CLI's request:
5059
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.
60+
| Setting | Description |
61+
|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
62+
| `The resource group that contains the container app` | The name of the resource group with the container app. |
63+
| `Name of the container app` | The name of the container app. |
64+
| `The container where the connection information will be saved` | The name of the container app's container. |
65+
| `The resource group which contains the storage account` | The name of the resource group with the storage account. |
66+
| `Name of the storage account` | The name of the storage account you want to connect to. In this guide, we're using a Blob Storage. |
5667
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.
68+
> [!TIP]
69+
> 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 connect it to your container app using a connection string.
5970
60-
### [Using a managed identity](#tab/using-managed-identity)
71+
### [Managed identity](#tab/using-managed-identity)
6172
6273
> [!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.
74+
> To use a managed identity, you must have the permission to modify [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.
6475
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.
76+
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.
6677
6778
```azurecli-interactive
6879
az containerapp connection create storage-blob --system-identity
6980
```
7081
7182
1. Provide the following information at the Azure CLI's request:
7283
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.
84+
| Setting | Description |
85+
|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
86+
| `The resource group that contains the container app` | The name of the resource group with the container app. |
87+
| `Name of the container app` | The name of the container app. |
88+
| `The container where the connection information will be saved` | The name of the container app's container. |
89+
| `The resource group which contains the storage account` | The name of the resource group with the storage account. |
90+
| `Name of the storage account` | The name of the storage account you want to connect to. In this guide, we're using a Blob Storage. |
7891
7992
> [!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.
93+
> 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 connect it to your container app using a managed identity.
8194
8295
---
8396
8497
## View connections
8598
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.
99+
Use the Azure CLI command `az containerapp connection list` to list all your container app's provisioned connections. Replace the placeholders `<container-app-resource-group>` and `<container-app-name>` from the command below with the resource group and name of your container app. You can also remove the `--output table` option to view more information about your connections.
90100
91101
```azurecli-interactive
92-
az containerapp connection list -g "<your-container-app-resource-group>" --name "<your-container-app-name>" --output table
102+
az containerapp connection list -g "<container-app-resource-group>" --name "<container-app-name>" --output table
93103
```
94104

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

0 commit comments

Comments
 (0)