| title | titleSuffix | description | ms.custom | ms.technology | ms.author | author | ms.topic | monikerRange | ms.date |
|---|---|---|---|---|---|---|---|---|---|
View or run a query in Azure Boards and Azure DevOps |
Azure Boards |
Learn how to view, run, or favorite a query in Azure Boards and Azure DevOps. |
boards-queries |
devops-agile |
kaelli |
KathrynEE |
quickstart |
<= azure-devops |
04/01/2022 |
[!INCLUDE version-lt-eq-azure-devops] [!INCLUDE version-vs-gt-2013.md]
To find work items assigned to you or your team, run a query. Many work item queries are predefined with your process. Members of your team may have created shared queries that you can view and run. Often, it's easier to define a new query by building on the query definition that's already available to you.
[!INCLUDE temp]
[!INCLUDE temp]
To run any query, expand a folder and choose the title of the query. The view opens to display the query Results. ::: moniker range=">= azure-devops-2020" You can also run a query by using the Azure DevOps command line interface. ::: moniker-end
Tip
The Queries page, as with other web portal pages, remembers the view you last navigated to and returns you to that view.
::: moniker range=">= azure-devops-2019"
-
Choose All to open the page where you can view all queries you've defined or that are shared within your project.
[!div class="mx-imgBorder"]
-
Choose My Queries as needed.
- To view all work items assigned to you, choose Assigned to me. This query uses the @Me macro to list all work items assigned to you.
- To view all work items you're following, choose Followed work items. This query uses the @Follows macro (ID in @Follows) to list all work items you've chosen to follow. To learn more, see Follow a work item or pull request.
-
Choose Shared Queries to expand the folder and access queries saved as shared queries.
-
Choose a folder within a breadcrumb to open a query folder.
[!div class="mx-imgBorder"]
::: moniker-end
-
From the Team Explorer Work Items, page, open the context menu for the query (right-click with your mouse), and choose View Results. Or, double-click the query to open it.
:::image type="content" source="../media/team-explorer/open-query-from-team-explorer.png" alt-text="Screenshot of Team Explorer, open context menu for a query, choose View Results.":::
::: moniker range="azure-devops"
You can run a query in the CLI with the az boards query command. To get started, see Get started with Azure DevOps CLI.
az boards query [--id]
[--org]
[--path]
[--project]
[--wiql]
- id: The ID of an existing query. Required unless--path or--wiql is specified.
- wiql: The query in Work Item Query Language format. Ignored if--id or--path is specified.
- path: The path of an existing query. Ignored if--id is specified.
- org: Azure DevOps organization URL. You can configure the default organization using
az devops configure -d organization=ORG_URL. Required if not configured as default or picked up usinggit config. Example:--org https://dev.azure.com/MyOrganizationName/. - project: Name or ID of the project. You can configure the default project using
az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up usinggit config.
The following command runs a query with the specified ID and shows the result in table format.
az boards query --id 6c286d74-26a5-4cce-bfcf-bf9123495bfe --output table
Priority Node Name Work Item Type Title Remaining Work
---------- ---------------- ---------------- -------------------------------- ----------------
1 Voice Bug Apply fix elsewhere as needed
2 CMMI Bug Slow response on form
1 Fiber Bug Check issues with permissions 0
2 Fiber Bug Voicemail hang issue 0
2 FabrikamBB Bug Research slow response time
1 FabrikamBB Bug Fix performance issues 0
The following command runs a query with the specified WIQL and shows the result in table format.
az boards query --wiql "SELECT [Microsoft.VSTS.Common.Priority], [System.NodeName], [System.WorkItemType], [System.Title], [Microsoft.VSTS.Scheduling.RemainingWork], [System.AssignedTo], [System.State], [System.Tags], [System.AreaPath] FROM workitems WHERE [System.WorkItemType] = 'Bug' AND [System.AreaPath] = 'Fabrikam Fiber' ORDER BY [System.WorkItemType]" --output table
Priority Node Name Work Item Type Title Remaining Work
---------- -------------- ---------------- ---------------- ----------------
2 Fabrikam Fiber Bug Slow response on form
2 Fabrikam Fiber Bug Check permissions
2 Fabrikam Fiber Bug Fix performance issue
2 Fabrikam Fiber Bug Secure Sign-in
::: moniker-end
::: moniker range=">= azure-devops-2019"
::: moniker-end
::: moniker range="< azure-devops-2019"
::: moniker-end
Note
You can't add folders to My Favorites or Team Favorites.
::: moniker range=">= azure-devops-2019"
The Queries page contains a directory-focused view that you can filter to find specific queries of interest. When working in the Queries pages, you can navigate to a subfolder, folder, or page.
Also, you can choose a query that you've favorited from the selector menu, Or, you can choose to browse all queries, which returns you to the All Queries page.
[!div class="mx-imgBorder"]
::: moniker-end
::: moniker range="< azure-devops-2019"
The Queries page displays the folder structure in the left pane. You can expand and collapse folders, rename folders, and drag and drop queries from one folder to another. To learn more, see Manage and organize queries.
:::image type="content" source="media/organize-queries/query-folders-tfs.png" alt-text="Screenshot of Queries page, TFS 2018 and earlier versions.":::
::: moniker-end
The Work Items page displays the same folder structure as defined in the web portal. Changes you make through Visual Studio are reflected in the web portal.
:::image type="content" source="media/organize-queries/query-folders-visual-studio.png" alt-text="Screenshot of Work Items page, Visual Studio showing query folders.":::
You can expand and collapse folders, rename folders, and drag and drop queries from one folder to another. To learn more, see Manage and organize queries
For more information, see Query FAQs, Navigate, and Folders.
::: moniker range=">= azure-devops-2019"
You can do most tasks for viewing and running queries from each of the queries list pages as indicated in the following table. Only queries you save under My Queries and have favorited show up under My Favorites. Only queries saved under Shared Queries can be favorited by a team.
[!div class="mx-tdCol2BreakAll"] |
Task |Favorites
(Browser) |All
(Browser) | Work Items
(Team Explorer) |-------------|----------|---------| |View all favorited queries, yours or a team you belong to | ✔️ | | ✔️ |
|View all your queries or shared queries for the current project | | ✔️ |✔️|
|Run a query, open the context menu for a query |✔️ |✔️|✔️|
|Expand or collapse container folders or query folders |✔️ |✔️|✔️|
|Filter the list of queries |✔️ |✔️ | | |Favorite a query (for web portal, choose) | |✔️ | |
|Unfavorite a query (for web portal, choose :::image type="icon" source="../../media/icons/icon-favorited.png" border="false":::) |✔️ |✔️ | ✔️ |
|Add a new query: Choose :::image type="icon" source="/azure/devops/boards/media/icons/add-new-query.png" border="false"::: |✔️ |✔️ | ✔️|
::: moniker-end
::: moniker range=">= azure-devops-2019"
Enter a keyword into the filter box to filter the set of queries displayed on either the Favorites or All pages. To learn more about filtering, see Filter backlogs, boards, queries, and plans.
[!div class="mx-imgBorder"]
For more information, see Query FAQs, Navigate, and Folders.
::: moniker-end
From the Query Editor or Results view, you can email a formatted list of query items or copy the query URL.
::: moniker range=">= azure-devops-2019"
Choose the :::image type="icon" source="../media/icons/actions-icon.png" border="false"::: actions icon to open the menu and select from the options listed, Email query or Copy query URL.
[!div class="mx-imgBorder"]
You can only send the email to individual address for a project member that is recognized by the system. Adding a team group or security group to the to line isn't supported. If you add an email account that the system doesn't recognize, you receive a message that one or more recipients of your email don't have permissions to read the mailed work items.
Note
To email a formatted list to people who aren't project members, you'll need to use the Copy as HTML option described in Copy a list of work items. For on-premises Azure DevOps, all email actions require an SMTP server to be configured. If you don't have an SMTP server configured, you can work around this by using Copy as HTML.
::: moniker-end
::: moniker range="tfs-2018"
Choose Copy query URL. To email query items, see Copy a list of work items.
Note
With Email query, the system will email the formatted list to those teammates you select. To email a formatted list to people not part of the project, you'll need to use the Copy as HTML option described in Copy a list of work items. All email actions require an SMTP server to be configured. If you don't have an SMTP server configured, you can work around this by using Copy as HTML.
::: moniker-end
You can email a formatted query list by choosing the Send to Microsoft Outlook option from the context menu.
:::image type="content" source="media/view-run-queries/send-to-outlook-team-explorer.png" alt-text="Screenshot of Team Explorer, choose Send to Microsoft Outlook query option.":::
Note
This feature requires you to have Microsoft Outlook installed. For on-premises Azure DevOps, all email actions require an SMTP server to be configured. If you don't have an SMTP server configured, you can work around this by using Copy as HTML from the web portal.
[!div class="nextstepaction"] Define a query