Skip to content

Commit abda5be

Browse files
authored
Merge pull request #109945 from j-patrick/justipat/AddWarningToKeyVault
adding langauge to guide users to managed ids and cert based key management solutions
2 parents 22ad210 + 4f64dbf commit abda5be

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

articles/cosmos-db/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,13 +1012,13 @@
10121012
href: ../private-link/create-private-endpoint-cosmosdb-portal.md?toc=/azure/cosmos-db/toc.json&bc=/azure/cosmos-db/breadcrumb/toc.json
10131013
- name: Configure Cross Origin Resource Sharing(CORS)
10141014
href: how-to-configure-cross-origin-resource-sharing.md
1015-
- name: Secure keys using Key Vault
1016-
href: access-secrets-from-keyvault.md
10171015
- name: Secure keys using a managed identity
10181016
href: managed-identity-based-authentication.md
10191017
displayName: msi, managed service identity, aad, azure active directory, identity
10201018
- name: Certificate-based authentication with Azure AD
10211019
href: certificate-based-authentication.md
1020+
- name: Secure keys using Key Vault
1021+
href: access-secrets-from-keyvault.md
10221022
- name: Restrict user access to data operations only
10231023
href: how-to-restrict-user-data.md
10241024
- name: Configure customer-managed keys

articles/cosmos-db/access-secrets-from-keyvault.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ ms.reviewer: sngun
1313

1414
# Secure Azure Cosmos keys using Azure Key Vault
1515

16-
When using Azure Cosmos DB for your applications, you can access the database, collections, documents by using the endpoint and the key within the app’s configuration file. However, it’s not safe to put keys and URL directly in the application code because they are available in clear text format to all the users. You want to make sure that the endpoint and keys are available but through a secured mechanism. This is where Azure Key Vault can help you to securely store and manage application secrets.
16+
>[!IMPORTANT]
17+
> The recommended solution to access Azure Cosmos DB keys is to use a [system-assigned managed identity](managed-identity-based-authentication.md). If your service cannot take advantage of managed identities then use the [cert based solution](certificate-based-authentication.md). If both the managed identity solution and cert based solution do not meet your needs, please use the key vault solution below.
18+
19+
When using Azure Cosmos DB for your applications, you can access the database, collections, documents by using the endpoint and the key within the app's configuration file. However, it's not safe to put keys and URL directly in the application code because they are available in clear text format to all the users. You want to make sure that the endpoint and keys are available but through a secured mechanism. This is where Azure Key Vault can help you to securely store and manage application secrets.
1720

1821
The following steps are required to store and read Azure Cosmos DB access keys from Key Vault:
1922

@@ -25,7 +28,7 @@ The following steps are required to store and read Azure Cosmos DB access keys f
2528

2629
## Create a Key Vault
2730

28-
1. Sign in to [Azure Portal](https://portal.azure.com/).
31+
1. Sign in to [Azure portal](https://portal.azure.com/).
2932
2. Select **Create a resource > Security > Key Vault**.
3033
3. On the **Create key vault** section provide the following information:
3134
* **Name:** Provide a unique name for your Key Vault.

0 commit comments

Comments
 (0)