az boards

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az boards command. Learn more about extensions.

Manage Azure Boards.

This command group is a part of the azure-devops extension.

Commands

Name	Description	Type	Status
az boards area	Manage area paths.	Extension	GA
az boards area project	Manage areas for a project.	Extension	GA
az boards area project create	Create area.	Extension	GA
az boards area project delete	Delete area.	Extension	GA
az boards area project list	List areas for a project.	Extension	GA
az boards area project show	Show area details for a project.	Extension	GA
az boards area project update	Update area.	Extension	GA
az boards area team	Manage areas for a team.	Extension	GA
az boards area team add	Add area to a team.	Extension	GA
az boards area team list	List areas for a team.	Extension	GA
az boards area team remove	Remove area from a team.	Extension	GA
az boards area team update	Update team area.	Extension	GA
az boards iteration	Manage iterations.	Extension	GA
az boards iteration project	Manage iterations for a project.	Extension	GA
az boards iteration project create	Create iteration.	Extension	GA
az boards iteration project delete	Delete iteration.	Extension	GA
az boards iteration project list	List iterations for a project.	Extension	GA
az boards iteration project show	Show iteration details for a project.	Extension	GA
az boards iteration project update	Update project iteration.	Extension	GA
az boards iteration team	Manage iterations for a team.	Extension	GA
az boards iteration team add	Add iteration to a team.	Extension	GA
az boards iteration team list	List iterations for a team.	Extension	GA
az boards iteration team list-work-items	List work-items for an iteration.	Extension	GA
az boards iteration team remove	Remove iteration from a team.	Extension	GA
az boards iteration team set-backlog-iteration	Set backlog iteration for a team.	Extension	GA
az boards iteration team set-default-iteration	Set default iteration for a team.	Extension	GA
az boards iteration team show-backlog-iteration	Show backlog iteration for a team.	Extension	GA
az boards iteration team show-default-iteration	Show default iteration for a team.	Extension	GA
az boards query	Query for a list of work items.	Extension	GA
az boards work-item	Manage work items.	Extension	GA
az boards work-item create	Create a work item.	Extension	GA
az boards work-item delete	Delete a work item.	Extension	GA
az boards work-item relation	Manage work item relations.	Extension	GA
az boards work-item relation add	Add relation(s) to work item.	Extension	GA
az boards work-item relation list-type	List work item relations supported in the organization.	Extension	GA
az boards work-item relation remove	Remove relation(s) from work item.	Extension	GA
az boards work-item relation show	Get work item, fill relations with friendly name.	Extension	GA
az boards work-item show	Show details for a work item.	Extension	GA
az boards work-item update	Update work items.	Extension	GA

az boards query

Query for a list of work items.

Only supports flat queries.

az boards query [--detect {false, true}]
                [--id]
                [--org]
                [--path]
                [--project]
                [--wiql]

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true

--id

The ID of an existing query. Required unless --path or --wiql are specified.

--org --organization

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 via git config. Example: https://dev.azure.com/MyOrganizationName/.

--path

The path of an existing query. Ignored if --id is specified.

--project -p

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 via git config.

--wiql

The query in Work Item Query Language format. Ignored if --id or --path is specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.