Skip to content

Commit 8466b14

Browse files
authored
Merge pull request #234349 from maud-lv/ml-sc-register
Clarify initial set-up
2 parents f1dedca + 97476c7 commit 8466b14

File tree

3 files changed

+43
-27
lines changed

3 files changed

+43
-27
lines changed

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

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 09/15/2022
8+
ms.date: 04/13/2023
99
ms.devlang: azurecli
1010
ms.custom: event-tier1-build-2022, devx-track-azurecli
1111
---
@@ -22,18 +22,27 @@ The [Azure CLI](/cli/azure) is a set of commands used to create and manage Azure
2222

2323
- This quickstart assumes that you already have at least an App Service running on Azure. If you don't have an App Service, [create one](../app-service/quickstart-dotnetcore.md).
2424

25-
## View supported target service types
25+
## Initial set-up
2626

27-
Use the Azure CLI [az webapp connection list](/cli/azure/webapp/connection#az-webapp-connection-list) command to get a list of supported target services for App Service.
27+
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.
2828

29-
```azurecli-interactive
30-
az provider register -n Microsoft.ServiceLinker
31-
az webapp connection list-support-types --output table
32-
```
29+
```azurecli
30+
az provider register -n Microsoft.ServiceLinker
31+
```
32+
33+
> [!TIP]
34+
> You can check if the resource provider has already been registered by running the command `az provider show -n "Microsoft.ServiceLinker" --query registrationState`. If the output is `Registered`, then Service Connector has already been registered.
35+
36+
37+
1. Optionally, use the Azure CLI [az webapp connection list-support-types](/cli/azure/webapp/connection#az-webapp-connection-list-support-types) command to get a list of supported target services for App Service.
3338
39+
```azurecli
40+
az webapp connection list-support-types --output table
41+
```
42+
3443
## Create a service connection
3544
36-
#### [Using Access Key](#tab/Using-access-key)
45+
#### [Using an access key](#tab/Using-access-key)
3746
3847
Use the Azure CLI [az webapp connection create](/cli/azure/webapp/connection/create) command to create a service connection to an Azure Blob Storage with an access key, providing the following information:
3948
@@ -42,14 +51,14 @@ Use the Azure CLI [az webapp connection create](/cli/azure/webapp/connection/cre
4251
- **Target service resource group name:** the resource group name of the Blob Storage.
4352
- **Storage account name:** the account name of your Blob Storage.
4453
45-
```azurecli-interactive
54+
```azurecli
4655
az webapp connection create storage-blob --secret
4756
```
4857

4958
> [!NOTE]
5059
> If you don't have a Blob Storage, you can run `az webapp connection create storage-blob --new --secret` to provision a new one and directly get connected to your app service.
5160
52-
#### [Using Managed Identity](#tab/Using-Managed-Identity)
61+
#### [Using a managed identity](#tab/Using-Managed-Identity)
5362

5463
> [!IMPORTANT]
5564
> Using Managed Identity requires you have the permission to [Azure AD role assignment](../active-directory/managed-identities-azure-resources/howto-assign-access-portal.md). If you don't have the permission, your connection creation would fail. You can ask your subscription owner for the permission or using access key to create the connection.
@@ -61,7 +70,7 @@ Use the Azure CLI [az webapp connection](/cli/azure/webapp/connection) command t
6170
- **Target service resource group name:** the resource group name of the Blob Storage.
6271
- **Storage account name:** the account name of your Blob Storage.
6372

64-
```azurecli-interactive
73+
```azurecli
6574
az webapp connection create storage-blob --system-identity
6675
```
6776

@@ -77,7 +86,7 @@ Use the Azure CLI [az webapp connection](/cli/azure/webapp/connection) command t
7786
- **Source compute service resource group name:** the resource group name of the App Service.
7887
- **App Service name:** the name of your App Service that connects to the target service.
7988

80-
```azurecli-interactive
89+
```azurecli
8190
az webapp connection list -g "<your-app-service-resource-group>" -n "<your-app-service-name>" --output table
8291
```
8392

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: quickstart
8-
ms.date: 08/09/2022
8+
ms.date: 04/13/2023
99
ms.devlang: azurecli
1010
ms.custom: devx-track-azurecli
1111
---
@@ -30,17 +30,20 @@ This quickstart shows you how to connect Azure Container Apps to other Cloud res
3030

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

33-
## Prepare to create a connection
33+
## Initial set-up
3434

35-
1. Run the command [az provider register](/cli/azure/provider#az-provider-register) to start using Service Connector.
35+
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.
3636

37-
```azurecli-interactive
37+
```azurecli
3838
az provider register -n Microsoft.ServiceLinker
3939
```
4040
41-
1. Run the command `az containerapp connection` to get a list of supported target services for Container Apps.
41+
> [!TIP]
42+
> You can check if the resource provider has already been registered by running the command `az provider show -n "Microsoft.ServiceLinker" --query registrationState`. If the output is `Registered`, then Service Connector has already been registered.
4243
43-
```azurecli-interactive
44+
1. Optionally, run the command [az containerapp connection list-support-types](/cli/azure/containerapp/connection#az-containerapp-connection-list-support-types) to get a list of supported target services for Container Apps.
45+
46+
```azurecli
4447
az containerapp connection list-support-types --output table
4548
```
4649
@@ -52,7 +55,7 @@ You can create a connection using an access key or a managed identity.
5255
5356
1. Run the `az containerapp connection create` command to create a service connection between Container Apps and Azure Blob Storage with an access key.
5457
55-
```azurecli-interactive
58+
```azurecli
5659
az containerapp connection create storage-blob --secret
5760
```
5861
@@ -76,7 +79,7 @@ You can create a connection using an access key or a managed identity.
7679
7780
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.
7881
79-
```azurecli-interactive
82+
```azurecli
8083
az containerapp connection create storage-blob --system-identity
8184
```
8285
@@ -99,7 +102,7 @@ You can create a connection using an access key or a managed identity.
99102
100103
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.
101104
102-
```azurecli-interactive
105+
```azurecli
103106
az containerapp connection list -g "<container-app-resource-group>" --name "<container-app-name>" --output table
104107
```
105108

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

Lines changed: 10 additions & 6 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: quickstart
9-
ms.date: 08/09/2022
9+
ms.date: 04/13/2022
1010
ms.devlang: azurecli
1111
ms.custom: event-tier1-build-2022, devx-track-azurecli
1212
---
@@ -29,17 +29,21 @@ Service Connector lets you quickly connect compute services to cloud services, w
2929

3030
- 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`.
3131

32-
## Prepare to create a connection
32+
## Initial set up
3333

3434
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.
3535

36-
```azurecli-interactive
36+
```azurecli
3737
az provider register -n Microsoft.ServiceLinker
3838
```
3939
40-
1. Run the command `az spring connection` to get a list of supported target services for Azure Spring Apps.
40+
> [!TIP]
41+
> You can check if the resource provider has already been registered by running the command `az provider show -n "Microsoft.ServiceLinker" --query registrationState`. If the output is `Registered`, then Service Connector has already been registered.
4142
42-
```azurecli-interactive
43+
44+
1. Optionally, run the command [az spring connection list-support-types](/cli/azure/spring/connection#az-spring-connection-list-support-types) to get a list of supported target services for Azure Spring Apps.
45+
46+
```azurecli
4347
az spring connection list-support-types --output table
4448
```
4549
@@ -54,7 +58,7 @@ You can create a connection from Azure Spring Apps using an access key or a mana
5458
5559
1. Run the `az spring connection create` command to create a service connection between Azure Spring Apps and an Azure Blob Storage with an access key.
5660
57-
```azurecli-interactive
61+
```azurecli
5862
az spring connection create storage-blob --secret
5963
```
6064

0 commit comments

Comments
 (0)