diff --git a/data-explorer/add-cluster-connection.md b/data-explorer/add-cluster-connection.md index 25a16c6d3b..7c442a8c18 100644 --- a/data-explorer/add-cluster-connection.md +++ b/data-explorer/add-cluster-connection.md @@ -3,7 +3,7 @@ title: Add a cluster connection in the Azure Data Explorer web UI description: Learn how to add cluster connections for multiple user accounts or Microsoft Entra directories in the Azure Data Explorer web UI. ms.reviewer: mibar ms.topic: reference -ms.date: 04/02/2024 +ms.date: 01/20/2025 --- # Add a cluster connection in the Azure Data Explorer web UI @@ -22,25 +22,68 @@ To add a connection to your Azure Data Explorer cluster: 1. From the main left menu, select **Query**. - :::image type="content" source="media/web-ui-add-cluster/query-widget.png" alt-text="Screenshot of the query widget in the main menu of the web UI." lightbox="media/web-ui-add-cluster/query-widget.png"::: + :::image type="content" source="media/web-ui-add-cluster/query-widget.png" alt-text="Screenshot of the query widget in the main menu of the web UI."::: 1. In the upper left corner, select **Add**. From the dropdown menu, select **Connection**. 1. In the **Add connection** dialog box, enter the cluster **Connection URI** and **Display name**. To find the connection URI, go to your cluster resource in the [Azure portal](https://ms.portal.azure.com/). The connection URI is the **URI** found in the **Overview**. To add a free sample cluster, specify "help" as the **Connection URI**. - :::image type="content" source="media/web-ui-add-cluster/add-connection-dialog.png" alt-text="Screenshot of add cluster connection dialog box." lightbox="media/web-ui-add-cluster/add-connection-dialog.png"::: + :::image type="content" source="media/web-ui-add-cluster/add-connection-dialog.png" alt-text="Screenshot of add cluster connection dialog box."::: -1. (Optional) If you have multiple user accounts and want to authenticate with a different account, select **Connect as another user** and proceed to add or select the appropriate account. +1. (Optional) If you have multiple user accounts and want to authenticate with a different account, select **Connect as another user**, and proceed to add or select the appropriate account. 1. (Optional) If your account is linked to multiple Microsoft Entra directories, select **Switch directory** and choose the relevant directory for this connection. - :::image type="content" source="media/web-ui-add-cluster/switch-directories.png" alt-text="Screenshot of option to switch directory." lightbox="media/web-ui-add-cluster/switch-directories.png"::: + :::image type="content" source="media/web-ui-add-cluster/switch-directories.png" alt-text="Screenshot of option to switch directory."::: 1. Select **Add** to add the connection. Your cluster and databases should now be visible in the left panel. - For example, the following image shows a cluster connection pane that contains three clusters: `help`, `FreeCluster`, and `HomeCluster`. The `HomeCluster` connection uses different credentials from those of the signed-in user, as indicated by the small icon of a person in the upper-left corner. + For example, the following image shows a cluster connection pane that contains three clusters: `HomeCluster`, `help`, and `TestCluster`. - :::image type="content" source="media/web-ui-add-cluster/cluster-pane-with-various-accounts.png" alt-text="Screenshot of the help cluster and databases." lightbox="media/web-ui-add-cluster/cluster-pane-with-various-accounts.png"::: + :::image type="content" source="media/web-ui-add-cluster/cluster-pane-with-various-accounts.png" alt-text="Screenshot of the help cluster and databases."::: + +## Manage cluster connections + +To organize and manage your clusters, you can add clusters to **Favorites** or to groups. + +### Manage cluster connections using Favorites + +To add your cluster to **Favorites**: + +1. From the **More [...]** menu next to your cluster, select **Add to favorites**. + +1. Verify that your cluster appears under **Favorites** in the **Cluster connection** pane. + +To remove a cluster from **Favorites**: + +1. Select the **More [...]** menu next to the cluster and then **Remove from favorites**. + +1. Verify that your cluster doesn't appear under **Favorites** in the **Cluster connection** pane. + + :::image type="content" source="media/web-ui-add-cluster/cluster-pane-remove-from-favorites.png" alt-text="Screenshot of the Remove from favorites selection."::: + +### Manage cluster connections using groups + +**Before you start**: If the group you wish to assign the cluster to doesn't exist, we recommend you create it first. In the **Cluster connection** pane, select **Add** > **Group**, enter a group name, and then select the check mark. + +To add your cluster to a group: + +1. From the **More [...]** menu next to your cluster, select **Add to group**, and then select a group name. + + :::image type="content" source="media/web-ui-add-cluster/add-groups-favorites.png" alt-text="Screenshot of the add to group options. The add to group dropdown includes the New Group selection and an existing group."::: + +1. Verify that your cluster appears under the selected group in the **Cluster connection** pane. + +To remove a cluster from a group: + +1. Select the **More [...]** menu next to the cluster, then **Add to group**. Under the **Remove from group** heading, select the group name. + + :::image type="content" source="media/web-ui-add-cluster/cluster-pane-remove-from-groups.png" alt-text="Screenshot of the Remove from group option." ::: + +1. Verify that your cluster doesn't appear under the selected group in the **Cluster connection** pane. + +> [!NOTE] +> Clusters can be included in groups and **Favorites** at the same time. ## Related content diff --git a/data-explorer/kusto/management/retention-policy.md b/data-explorer/kusto/management/retention-policy.md index 431a0905fb..d664ae70c8 100644 --- a/data-explorer/kusto/management/retention-policy.md +++ b/data-explorer/kusto/management/retention-policy.md @@ -43,6 +43,10 @@ A retention policy includes the following properties: * If set to `Enabled`, the data will be recoverable for 14 days after it's been soft-deleted. * It is not possible to configure the recoverability period. +> [!NOTE] +> +> Data that is deleted using [soft delete](../concepts/data-soft-delete.md) or [purge](../concepts/data-purge.md) is not recoverable regardless of any retention or recoverability settings. + ## Management commands * Use [`.show policy retention`](show-table-retention-policy-command.md) to show the current retention policy for a database, table, or [materialized view](materialized-views/materialized-view-overview.md). diff --git a/data-explorer/media/web-ui-add-cluster/add-groups-favorites.png b/data-explorer/media/web-ui-add-cluster/add-groups-favorites.png new file mode 100644 index 0000000000..48c5027f0a Binary files /dev/null and b/data-explorer/media/web-ui-add-cluster/add-groups-favorites.png differ diff --git a/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-favorites.png b/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-favorites.png new file mode 100644 index 0000000000..60091f0256 Binary files /dev/null and b/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-favorites.png differ diff --git a/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-groups.png b/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-groups.png new file mode 100644 index 0000000000..baa9102eda Binary files /dev/null and b/data-explorer/media/web-ui-add-cluster/cluster-pane-remove-from-groups.png differ diff --git a/data-explorer/media/web-ui-add-cluster/cluster-pane-with-various-accounts.png b/data-explorer/media/web-ui-add-cluster/cluster-pane-with-various-accounts.png index 094c96c7f9..b637ce89b6 100644 Binary files a/data-explorer/media/web-ui-add-cluster/cluster-pane-with-various-accounts.png and b/data-explorer/media/web-ui-add-cluster/cluster-pane-with-various-accounts.png differ diff --git a/data-explorer/troubleshoot-connect-cluster.md b/data-explorer/troubleshoot-connect-cluster.md index f0b7c1f490..362f24c7b9 100644 --- a/data-explorer/troubleshoot-connect-cluster.md +++ b/data-explorer/troubleshoot-connect-cluster.md @@ -3,7 +3,7 @@ title: Troubleshoot Azure Data Explorer cluster connection failures description: This article describes troubleshooting steps for connecting to a cluster in Azure Data Explorer. ms.reviewer: mblythe ms.topic: how-to -ms.date: 09/24/2018 +ms.date: 01/21/2025 --- # Troubleshoot: Failure to connect to a cluster in Azure Data Explorer @@ -12,18 +12,26 @@ If you're not able to connect to a cluster in Azure Data Explorer, follow these 1. Ensure the connection string is correct. It should be in the form: `https://..kusto.windows.net`, such as the following example: `https://docscluster.westus.kusto.windows.net`. -1. Ensure you have adequate permissions. If you don't, you'll get a response of *unauthorized*. +1. Ensure you have adequate permissions. Otherwise, you get a response of *unauthorized*. For more information about permissions, see [Manage database permissions](manage-database-permissions.md). If necessary, work with your cluster administrator so they can add you to the appropriate role. - -1. If you are connecting from an external tenant, ensure the cluster has correct permissions. + +1. If you're connecting from an external tenant, ensure the cluster has correct permissions. For more information about cross tenant scenarios, see [Allow cross-tenant queries and commands](cross-tenant-query-and-commands.md). -1. Verify that the cluster hasn't been deleted: review the activity log in your subscription. +1. Ensure your cluster is active. Clusters can automatically stop due to [auto-stop settings](auto-stop-clusters.md). + + 1. From the [Azure portal](https://ms.portal.azure.com/), navigate to **Azure Data Explorer Clusters** and view your cluster. + + 1. If the value in the **State** column is **Stopped**, select your cluster to open the overview page. + + 1. From the **Command bar**, select **Start**. Then try reconnecting. + +1. Verify that the cluster wasn't deleted by reviewing your subscription activity log. 1. Check the [Azure service health dashboard](https://azure.microsoft.com/status/). Look for the status of Azure Data Explorer in the region where you're trying to connect to a cluster. If the status isn't **Good** (green check mark), try connecting to the cluster after the status improves. -1. If you still need assistance solving your issue, please open a support request in the [Azure portal](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview). +1. If you still need assistance solving your issue, open a support request in the [Azure portal](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview). diff --git a/data-explorer/web-ui-query-overview.md b/data-explorer/web-ui-query-overview.md index 2ff6f6e4eb..2c6b227fb7 100644 --- a/data-explorer/web-ui-query-overview.md +++ b/data-explorer/web-ui-query-overview.md @@ -3,7 +3,7 @@ title: Azure Data Explorer web UI query overview description: This article describes the query page in Azure Data Explorer web UI. ms.reviewer: mibar ms.topic: reference -ms.date: 12/18/2023 +ms.date: 01/16/2025 --- # Azure Data Explorer web UI query overview @@ -36,7 +36,8 @@ From the connection pane, right-click on a database to open a menu with options To learn how to add a connection, see [Add a cluster connection in the Azure Data Explorer web UI](add-cluster-connection.md). > [!TIP] -> Add clusters and databases to your favorites list with the star icon next to the resource name. To view only your favorite resources, select the star icon next to the filter text box. +> * Add clusters and databases to your favorites list with the star icon next to the resource name. To view only your favorite resources, select the star icon next to the filter text box. +> * Add clusters to groups for easier management. Groups display below favorites. ## Gain quick insights into table data @@ -58,7 +59,7 @@ The editor offers [Kusto Query Language (KQL)](/kusto/query/index?view=azure-dat ## Manage queries in multiple contexts -With the use of query tabs, you can work on multiple queries simultaneously, all with their own query context. The query tabs allow you to switch between different databases and clusters without losing your work. To rename a query tab, double-click on the tab title or click the pencil icon on the tab. To get a comprehensive view of all existing tabs, use the tabs list located in the top right corner. +With the use of query tabs, you can work on multiple queries simultaneously, all with their own query context. The query tabs allow you to switch between different databases and clusters without losing your work. To rename a query tab, double-click on the tab title or select the pencil icon on the tab. To get a comprehensive view of all existing tabs, use the tabs list located in the top right corner. :::image type="content" source="media/web-ui-query/tabs-management.gif" alt-text="Moving screenshot of multiple tabs." lightbox="media/web-ui-query/tabs-management.gif":::