Skip to content

Commit 98590e7

Browse files
Merge pull request #303190 from TimShererWithAquent/us448924-06
Freshness Edit: Service Connectors
2 parents c0e4ac9 + 7c00066 commit 98590e7

File tree

2 files changed

+33
-22
lines changed

2 files changed

+33
-22
lines changed

articles/service-connector/how-to-integrate-key-vault.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
22
title: Integrate Azure Key Vault with Service Connector
3-
description: Integrate Azure Key Vault into your application with Service Connector
3+
description: Use these code samples to integrate Azure Key Vault into your application with Service Connector.
44
author: maud-lv
55
ms.author: malev
66
ms.service: service-connector
77
ms.topic: how-to
8-
ms.date: 02/02/2024
8+
ms.date: 07/24/2025
9+
#customer intent: As a cloud developer, I want to connect my cloud services to Azure Key Vault by using Service Connector.
910
---
1011

1112
# Integrate Azure Key Vault with Service Connector
1213

1314
> [!NOTE]
1415
> When you use Service Connector to connect your Key Vault or manage Key Vault connections, Service Connector uses your token to perform the corresponding operations.
1516
16-
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure Key Vault to other cloud services using Service Connector. You might still be able to connect to Azure Key Vault in other programming languages without using Service Connector. This page also shows default environment variable names and values (or Spring Boot configuration) you get when you create the service connection.
17+
This page shows supported authentication methods and clients. It provides sample code you can use to connect Azure Key Vault to other cloud services using Service Connector. You might be able to connect to Azure Key Vault in other programming languages without using Service Connector. This page also shows default environment variable names and values (or Spring Boot configuration) you get when you create the service connection.
1718

1819
## Supported compute services
1920

@@ -27,7 +28,7 @@ Service Connector can be used to connect the following compute services to Azure
2728

2829
## Supported authentication types and client types
2930

30-
The table below shows which combinations of client types and authentication methods are supported for connecting your compute service to Azure Key Vault using Service Connector. A Yes indicates that the combination is supported, while a “No” indicates that it is not supported.
31+
The following table shows which combinations of client types and authentication methods are supported for connecting your compute service to Azure Key Vault using Service Connector. A "Yes" indicates that the combination is supported, while a "No" indicates that it isn't supported.
3132

3233
| Client type | System-assigned managed identity | User-assigned managed identity | Secret / connection string | Service principal |
3334
|--------------------|----------------------------------|--------------------------------|----------------------------|-------------------|
@@ -38,15 +39,15 @@ The table below shows which combinations of client types and authentication meth
3839
| Python | Yes | Yes | No | Yes |
3940
| None | Yes | Yes | No | Yes |
4041

41-
This table indicates that all combinations of client types and authentication methods in the table are supported, except for the Secret / connection string method, which is not supported for any of the client types. All client types can use any of the other authentication methods to connect to Azure Key Vault using Service Connector.
42+
This table indicates that all combinations of client types and authentication methods in the table are supported, except for **Secret / connection string**. That method isn't supported for any of the client types. All client types can use any of the other authentication methods to connect to Azure Key Vault using Service Connector.
4243

4344
## Default environment variable names or application properties and sample code
4445

45-
Use the connection details below to connect compute services to Azure Key Vault. For each example below, replace the placeholder texts `<vault-name>`, `<client-ID>`, `<client-secret>`, and `<tenant-id>` with your Key Vault name, client-ID, client secret and tenant ID. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
46+
Use the following connection details to connect compute services to Azure Key Vault. For each of these examples, replace the placeholder texts `<vault-name>`, `<client-ID>`, `<client-secret>`, and `<tenant-id>` with your Key Vault name, client-ID, client secret, and tenant ID. For more information, see [Configuration naming convention](concept-service-connector-internals.md#configuration-naming-convention).
4647

4748
### System-assigned managed identity
4849

49-
#### SpringBoot client type
50+
#### Spring Boot client type
5051

5152
| Default environment variable name | Description | Example value |
5253
|-----------------------------------|-----------------------------|-------------------------------------------|
@@ -64,12 +65,12 @@ Use the connection details below to connect compute services to Azure Key Vault.
6465

6566
#### Sample code
6667

67-
Refer to the steps and code below to connect to Azure Key Vault using a system-assigned managed identity.
68+
To connect to Azure Key Vault using a system-assigned managed identity, refer to the following steps and code.
6869
[!INCLUDE [code sample for key vault](./includes/code-keyvault-me-id.md)]
6970

7071
### User-assigned managed identity
7172

72-
#### SpringBoot client type
73+
#### Spring Boot client type
7374

7475
| Default environment variable name | Description | Example value |
7576
|-----------------------------------|-----------------------------|-------------------------------------------|
@@ -90,12 +91,12 @@ Refer to the steps and code below to connect to Azure Key Vault using a system-a
9091

9192
#### Sample code
9293

93-
Refer to the steps and code below to connect to Azure Key Vault using a system-assigned managed identity.
94+
To connect to Azure Key Vault using a system-assigned managed identity, refer to the following steps and code.
9495
[!INCLUDE [code sample for key vault](./includes/code-keyvault-me-id.md)]
9596

9697
### Service principal
9798

98-
#### SpringBoot client type
99+
#### Spring Boot client type
99100

100101
| Default environment variable name | Description | Example value |
101102
|-----------------------------------|-----------------------------|-------------------------------------------|
@@ -121,12 +122,10 @@ Refer to the steps and code below to connect to Azure Key Vault using a system-a
121122

122123
#### Sample code
123124

124-
Refer to the steps and code below to connect to Azure Key Vault using a system-assigned managed identity.
125+
To connect to Azure Key Vault using a system-assigned managed identity, refer to the following steps and code.
125126
[!INCLUDE [code sample for key vault](./includes/code-keyvault-me-id.md)]
126127

127-
## Next steps
128-
129-
Follow the tutorials listed below to learn more about Service Connector.
128+
## Next step
130129

131130
> [!div class="nextstepaction"]
132131
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)

articles/service-connector/includes/code-keyvault-me-id.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
author: wchigit
3-
description: managed identity, code sample
3+
description: Managed identity, code sample
44
ms.service: service-connector
55
ms.topic: include
66
ms.date: 11/02/2023
@@ -10,11 +10,14 @@ ms.author: wchi
1010
### [.NET](#tab/dotnet)
1111

1212
1. Install dependencies.
13+
1314
```bash
1415
dotnet add package Azure.Identity
1516
dotnet add package Azure.Security.KeyVault.Secrets
1617
```
17-
1. Authenticate using `Azure.Identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
18+
19+
1. Authenticate using `Azure.Identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using this code, uncomment the part of the code snippet for the authentication type you want to use.
20+
1821
```csharp
1922
using Azure.Identity;
2023
using Azure.Security.KeyVault.Secrets;
@@ -56,6 +59,7 @@ ms.author: wchi
5659
### [Java](#tab/java)
5760
5861
1. Add the following dependencies in your *pom.xml* file:
62+
5963
```xml
6064
<dependency>
6165
<groupId>com.azure</groupId>
@@ -67,7 +71,9 @@ ms.author: wchi
6771
<version>1.1.5</version>
6872
</dependency>
6973
```
70-
1. Authenticate using `azure-identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
74+
75+
1. Authenticate using `azure-identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using this code, uncomment the part of the code snippet for the authentication type you want to use.
76+
7177
```java
7278
// Uncomment the following lines corresponding to the authentication type you want to use.
7379
// for system-managed identity
@@ -94,15 +100,18 @@ ms.author: wchi
94100
95101
### [SpringBoot](#tab/springBoot)
96102
97-
Refer to [Tutorial: Connect Azure Spring Apps to Key Vault using managed identities](../../spring-apps/basic-standard/tutorial-managed-identities-key-vault.md?tabs=system-assigned-managed-identity) to set up your Spring application. Two sets of configuration properties are added to Spring Apps by Service Connector, according to Spring Cloud Azure version below 4.0 and above 4.0. For more information, check [Migration Guide for 4.0](https://microsoft.github.io/spring-cloud-azure/current/reference/html/appendix.html#configuration-spring-cloud-azure-starter-keyvault-secrets)
103+
To set up your Spring application, see [Connect Azure Spring Apps to Key Vault using managed identities](../../spring-apps/basic-standard/tutorial-managed-identities-key-vault.md?tabs=system-assigned-managed-identity). Two sets of configuration properties are added to Spring Apps by Service Connector, according to Spring Cloud Azure version below 4.0 and above 4.0. For more information, see [Migration Guide for 4.0](https://microsoft.github.io/spring-cloud-azure/current/reference/html/appendix.html#configuration-spring-cloud-azure-starter-keyvault-secrets).
98104
99105
### [Python](#tab/python)
100106
101107
1. Install dependencies.
108+
102109
```bash
103110
pip install azure-keyvault-keys azure-identity
104111
```
105-
1. Authenticate using `azure-identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
112+
113+
1. Authenticate using `azure-identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using this code, uncomment the part of the code snippet for the authentication type you want to use.
114+
106115
```python
107116
import os
108117
from azure.identity import ManagedIdentityCredential, ClientSecretCredential
@@ -126,14 +135,17 @@ Refer to [Tutorial: Connect Azure Spring Apps to Key Vault using managed identit
126135
client = KeyClient(vault_url=VAULT_URL, credential=cred)
127136
```
128137
129-
130138
### [NodeJS](#tab/nodejs)
139+
131140
1. Install dependencies.
141+
132142
```bash
133143
npm install @azure/identity
134144
npm install @azure/keyvault-secrets
135145
```
136-
1. Authenticate using `@azure/identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using the code below, uncomment the part of the code snippet for the authentication type you want to use.
146+
147+
1. Authenticate using `@azure/identity` and get the Azure Key Vault endpoint from the environment variables added by Service Connector. When using this code, uncomment the part of the code snippet for the authentication type you want to use.
148+
137149
```javascript
138150
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
139151
const { SecretClient } = require("@azure/keyvault-secrets");

0 commit comments

Comments
 (0)