az boards work-item

Manage work items.

Commands

az boards work-item create Create a work item.
az boards work-item delete Delete a work item.
az boards work-item relation Manage work item relations.
az boards work-item relation add Add relation(s) to work item.
az boards work-item relation list-type List work item relations supported in the organization.
az boards work-item relation remove Remove relation(s) from work item.
az boards work-item relation show Get work item, fill relations with friendly name.
az boards work-item show Show details for a work item.
az boards work-item update Update work items.

az boards work-item create

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]

Required Parameters

--title

Title of the work item.

--type

Name of the work item type (e.g. Bug).

Optional Parameters

--area

Area the work item is assigned to (e.g. Demos).

--assigned-to

Name of the person the work item is assigned-to (e.g. fabrikam).

--description -d

Description of the work item.

--detect

Automatically detect organization.

accepted values: false, true
--discussion

Comment to add to a discussion in a work item.

--fields -f

Space separated "field=value" pairs for custom fields you would like to set.

--iteration

Iteration path of the work item (e.g. DemosIteration 1).

--open

Open the work item in the default web browser.

--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/.

--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.

--reason

Reason for the state of the work item.

az boards work-item delete

Delete a work item.

az boards work-item delete --id
[--destroy]
[--detect {false, true}]
[--org]
[--project]
[--yes]

Required Parameters

--id

Unique id of the work item.

Optional Parameters

--destroy

Permanently delete this work item.

--detect

Automatically detect organization.

accepted values: false, true
--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/.

--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.

--yes -y

Do not prompt for confirmation.

az boards work-item show

Show details for a work item.

az boards work-item show --id
[--detect {false, true}]
[--open]
[--org]

Required Parameters

--id

The ID of the work item.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--open

Open the work item in the default web browser.

--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/.

az boards work-item update

Update work items.

az boards work-item update --id
[--area]
[--assigned-to]
[--description]
[--detect {false, true}]
[--discussion]
[--fields]
[--iteration]
[--open]
[--org]
[--reason]
[--state]
[--title]

Required Parameters

--id

The id of the work item to update.

Optional Parameters

--area

Area the work item is assigned to (e.g. Demos).

--assigned-to

Name of the person the work item is assigned-to (e.g. fabrikam).

--description -d

Description of the work item.

--detect

Automatically detect organization.

accepted values: false, true
--discussion

Comment to add to a discussion in a work item.

--fields -f

Space separated "field=value" pairs for custom fields you would like to set.

--iteration

Iteration path of the work item (e.g. DemosIteration 1).

--open

Open the work item in the default web browser.

--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/.

--reason

Reason for the state of the work item.

--state

State of the work item (e.g. active).

--title

Title of the work item.