Skip to content

Commit ff828a9

Browse files
Merge pull request #266277 from seesharprun/cosmos-data-explorer-query-cancellation
Cosmos DB | Revise data explorer article
2 parents f419d7b + cddae5a commit ff828a9

File tree

5 files changed

+85
-26
lines changed

5 files changed

+85
-26
lines changed

articles/cosmos-db/data-explorer.md

Lines changed: 85 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,111 @@
11
---
2-
title: Use Azure Cosmos DB Explorer to manage your data
3-
description: Learn about Azure Cosmos DB Explorer, a standalone web-based interface that allows you to view and manage the data stored in Azure Cosmos DB.
2+
title: Use the Explorer to manage your data
3+
titleSuffix: Azure Cosmos DB
4+
description: Learn about the Azure Cosmos DB Explorer, a standalone web-based interface that allows you to view and manage the data stored in Azure Cosmos DB.
5+
author: seesharprun
6+
ms.author: sidandrews
7+
ms.reviewer: esarroyo
48
ms.service: cosmos-db
59
ms.topic: how-to
6-
ms.date: 03/02/2023
7-
ms.author: esarroyo
8-
author: StefArroyo
10+
ms.date: 02/14/2024
11+
# CustomerIntent: As a database developer, I want to access the Explorer so that I can observe my data and make queries against my data.
912
---
1013

11-
# Work with data using Azure Cosmos DB Explorer
14+
# Use the Azure Cosmos DB Explorer to manage your data
15+
1216
[!INCLUDE[NoSQL, MongoDB, Cassandra, Gremlin, Table](includes/appliesto-nosql-mongodb-cassandra-gremlin-table.md)]
1317

14-
Azure Cosmos DB Explorer is a standalone web-based interface that allows you to view and manage the data stored in Azure Cosmos DB. Azure Cosmos DB Explorer is equivalent to the existing **Data Explorer** tab that is available in Azure portal when you create an Azure Cosmos DB account. The key advantages of Azure Cosmos DB Explorer over the existing Data explorer are:
18+
Azure Cosmos DB Explorer is a standalone web-based interface that allows you to view and manage the data stored in Azure Cosmos DB. Azure Cosmos DB Explorer is equivalent to the existing **Data Explorer** section that is available in Azure portal for Azure Cosmos DB accounts.
1519

16-
- You have a full screen real-estate to view your data, run queries, stored procedures, triggers, and view their results.
17-
- You can provide read or read-write access to your database account and its collections to other users who don't have access to Azure portal or subscription.
18-
- You can share the query results with other users who don't have access to Azure portal or subscription.
20+
The Azure Cosmos DB Explorer has a few key advantages when compared to the Data explorer, including:
1921

20-
## Access Azure Cosmos DB Explorer
22+
- Full screen real-estate to browse data, run queries, and observe query results
23+
- Ability to provide users without access to the Azure portal or an Azure subscription read or read-write capabilities over data in containers
24+
- Ability to share query results with users who don't have an Azure subscription or Azure portal access
2125

22-
1. Sign in to [Azure portal](https://portal.azure.com/).
26+
## Prerequisites
27+
28+
- An existing Azure Cosmos DB account.
29+
- If you don't have an Azure subscription, [Try Azure Cosmos DB free](https://cosmos.azure.com/try/).
30+
31+
## Access the Explorer directly using your Azure subscription
2332

24-
1. From **All resources**, find and navigate to your Azure Cosmos DB account, select **Keys**, and copy the **Primary Connection String**. You can select either:
33+
You can use access the Explorer directly and use your existing credentials to quickly get started with the tool.
2534

26-
- **Read-write Keys**. When you share the Read-write primary connection string other users, they can view and modify the databases, collections, queries, and other resources associated with that specific account.
27-
- **Read-only Keys**. When you share the read-only primary connection string with other users, they can view the databases, collections, queries, and other resources associated with that specific account. For example, if you want to share results of a query with your teammates who don't have access to Azure portal or your Azure Cosmos DB account, you can provide them with this value.
35+
1. Navigate to <https://cosmos.azure.com>.
2836

29-
1. Go to [https://cosmos.azure.com/](https://cosmos.azure.com/).
37+
1. Select **Sign In**. Sign in using your existing credentials that have access to the Azure Cosmos DB account.
3038

31-
1. Select **Connect to your account with connection string**, paste the connection string, and select **Connect**.
39+
1. Next, select your Azure subscription and target account from the **Select a Database Account** menu.
3240

33-
To open Azure Cosmos DB Explorer from the Azure portal:
41+
![Screenshot of the 'Select a Database Account' menu in the Explorer.](media/data-explorer/select-database-account.png)
42+
43+
## Access the Explorer from the Azure portal using your Azure subscription
44+
45+
If you're already comfortable with the Azure portal, you can navigate directly from the in-portal Data Explorer to the standalone Explorer.
46+
47+
1. Sign in to [Azure portal](https://portal.azure.com/).
3448

35-
1. Select the **Data Explorer** in the left menu, then select **Open Full Screen**.
49+
1. Navigate to your existing Azure Cosmos DB account.
3650

37-
:::image type="content" source="./media/data-explorer/open-data-explorer.png" alt-text="Screenshot shows Data Explorer page with Open Full Screen highlighted." lightbox="./media/data-explorer/open-data-explorer.png":::
51+
1. In the resource menu, select **Data Explorer**.
52+
53+
1. Next, select the **Open Full Screen** menu option.
54+
55+
![Screenshot of the Data Explorer page with the 'Open Full Screen' option highlighted.](media/data-explorer/open-full-screen.png)
3856

3957
1. In the **Open Full Screen** dialog, select **Open**.
4058

59+
## Grant someone else access to the Explorer using a connection string
60+
61+
Use either the **read-write** or **read-only** key to give another user access to your Azure Cosmos DB account. This method works even if the user doesn't have access to an Azure subscription or the Azure portal.
62+
63+
1. Sign in to [Azure portal](https://portal.azure.com/).
64+
65+
1. Navigate to your existing Azure Cosmos DB account.
66+
67+
1. In the resource menu, select **Keys**.
68+
69+
1. On the **keys** page, select either the **Read-write Keys** or **Read-only Keys** option. Then, copy the value of the **Primary Connection String** field. You use this value in a later step.
70+
71+
| | Description |
72+
| --- | --- |
73+
| **Read-write key** | Provides access to view and modify the databases, containers, queries, and other resources associated with that specific account |
74+
| **Read-only key** | Provides access to view databases, containers, queries, and other resources associated with that specific account |
75+
76+
> [!TIP]
77+
> If you want to share results of a query with your teammates who don't have access to an Azure Subscription or the Azure portal, you can provide them with the read-only .
78+
79+
1. Now, have the other user navigate to <https://cosmos.azure.com>.
80+
81+
1. Select **Connect to your account with connection string**. Then, have the user enter the connection string copied earlier and select **Connect**.
82+
83+
## Configure request unit threshold
84+
85+
In the Explorer, you can configure a limit to the request units per second (RU/s) that queries use. Use this functionality to control the cost and performance in request units (RU) of your queries. This functionality can also cancel high-cost queries automatically.
86+
87+
1. Start in the Explorer for the target Azure Cosmos DB account.
88+
89+
1. Select the **Settings** menu option.
90+
91+
![Screenshot of an Data Explorer page with the 'Open Settings' option highlighted.](media/data-explorer/open-settings.png)
92+
93+
1. In the **Settings** dialog, configure whether you want to **Enable RU threshold** and the actual **RU threshold** value.
94+
95+
![Screenshot of the individual settings to configure the request unit threshold](media/data-explorer/configure-ru-threshold.png)
96+
97+
> [!TIP]
98+
> The RU threshold is enabled automatically with a default value of **5,000** RUs.
99+
41100
## Known issues
42101

43-
Currently, viewing documents that contain a UUID isn't supported in Data Explorer. This limitation doesn't affect loading collections, only viewing individual documents or queries that include these documents. To view and manage these documents, users should continue to use the tool that was originally used to create these documents.
102+
Here are a few currently known issues:
44103

45-
Customers receiving HTTP-401 errors may be due to insufficient Azure RBAC permissions for your Azure account, particularly if the account has a custom role. Any custom roles must have `Microsoft.DocumentDB/databaseAccounts/listKeys/*` action to use Data Explorer if signing in using their Microsoft Entra credentials.
104+
- Browsing items that contain a UUID isn't supported in Data Explorer. This limitation doesn't affect loading containers, only viewing individual items or queries that include these items. To view and manage these items, users should continue to use the same tooling/SDKs that was originally used to create these items.
46105

47-
## Next steps
106+
- HTTP 401 errors could occur due to insufficient role-based access control permissions for your Microsoft Entra ID account. This condition can be true particularly if the account has a custom role. Any custom roles must have the `Microsoft.DocumentDB/databaseAccounts/listKeys/*` action included to use the Explorer.
48107

49-
Now that you've learned how to get started with Azure Cosmos DB Explorer to manage your data, next you can:
108+
## Next step
50109

51-
- [Getting started with queries](nosql/query/getting-started.md)
52-
- [Stored procedures, triggers, and user-defined functions](stored-procedures-triggers-udfs.md)
110+
> [!div class="nextstepaction"]
111+
> [Getting started with queries](nosql/query/getting-started.md)
15.8 KB
Loading
54.4 KB
Loading
16.7 KB
Loading

0 commit comments

Comments
 (0)