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.

Commands

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

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 --organization]
                           [--project]
                           [--reason]

Required Parameters

--title

Title of the work item.

--type

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
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. In case of multiple fields : "field1=value1" "field2=value2". Refer https://aka.ms/azure-devops-cli-field-api for more details on fields.

--iteration

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

--open

Open the work item in the default web browser.

Property	Value
Default value:	False

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az boards work-item delete

Delete a work item.

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

Required Parameters

--id

Unique id of the work item.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--destroy

Permanently delete this work item.

Property	Value
Default value:	False

--detect

Automatically detect organization.

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

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az boards work-item show

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 --organization]

Required Parameters

--id

The ID of the work item.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--as-of

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

--detect

Automatically detect organization.

Property	Value
Accepted values:	false, true

--expand

The expand parameters for work item attributes.

Property	Value
Default value:	all
Accepted values:	all, fields, links, none, relations

--fields -f

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

Open the work item in the default web browser.

Property	Value
Default value:	False

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --organization]
                           [--reason]
                           [--state]
                           [--title]

Required Parameters

--id

The id of the work item to update.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
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. Refer https://aka.ms/azure-devops-cli-field-api for more details on fields.

--iteration

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

--open

Open the work item in the default web browser.

Property	Value
Default value:	False

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False