az boards work-item
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 work-item command. Learn more about extensions.
Manage work items.
Name | Description | Type | Status |
---|---|---|---|
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 |
Create a work item.
az boards work-item create --title
--type
[--area]
[--assigned-to]
[--description]
[--detect {false, true}]
[--discussion]
[--fields]
[--iteration]
[--open]
[--org]
[--project]
[--reason]
Title of the work item.
Name of the work item type (e.g. Bug).
Area the work item is assigned to (e.g. Demos).
Name of the person the work item is assigned-to (e.g. fabrikam).
Description of the work item.
Automatically detect organization.
Comment to add to a discussion in a work item.
Space separated "field=value" pairs for custom fields you would like to set. In case of multiple fields : "field1=value1" "field2=value2". Refer https://aka.ms/azure-devops-cli-field-api for more details on fields.
Iteration path of the work item (e.g. Demos\Iteration 1).
Open the work item in the default web browser.
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/.
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.
Reason for the state of the work item.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete a work item.
az boards work-item delete --id
[--destroy]
[--detect {false, true}]
[--org]
[--project]
[--yes]
Unique id of the work item.
Permanently delete this work item.
Automatically detect 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/.
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.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Show details for a work item.
az boards work-item show --id
[--as-of]
[--detect {false, true}]
[--expand {all, fields, links, none, relations}]
[--fields]
[--open]
[--org]
The ID of the work item.
Work item details as of a particular date and time. Provide a date or date time string. Assumes local time zone. Example: '2019-01-20', '2019-01-20 00:20:00'. For UTC, append 'UTC' to the date time string, '2019-01-20 00:20:00 UTC'.
Automatically detect organization.
The expand parameters for work item attributes.
Comma-separated list of requested fields. Example:System.Id,System.AreaPath. Refer https://aka.ms/azure-devops-cli-field-api for more details on fields.
Open the work item in the default web browser.
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/.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Update work items.
az boards work-item update --id
[--area]
[--assigned-to]
[--description]
[--detect {false, true}]
[--discussion]
[--fields]
[--iteration]
[--open]
[--org]
[--reason]
[--state]
[--title]
The id of the work item to update.
Area the work item is assigned to (e.g. Demos).
Name of the person the work item is assigned-to (e.g. fabrikam).
Description of the work item.
Automatically detect organization.
Comment to add to a discussion in a work item.
Space separated "field=value" pairs for custom fields you would like to set. Refer https://aka.ms/azure-devops-cli-field-api for more details on fields.
Iteration path of the work item (e.g. Demos\Iteration 1).
Open the work item in the default web browser.
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/.
Reason for the state of the work item.
State of the work item (e.g. active).
Title of the work item.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: