az boards work-item relation

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 relation command. Learn more about extensions.

Manage work item relations.

Commands

Name	Description	Type	Status
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 relation add

Add relation(s) to work item.

az boards work-item relation add --id
                                 --relation-type
                                 [--detect {false, true}]
                                 [--org]
                                 [--target-id]
                                 [--target-url]

Required Parameters

--id

The ID of the work item.

--relation-type

Relation type to create. Example: parent, child.

Optional Parameters

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

--target-id

ID(s) of work-items to create relation with. Multiple values can be passed comma separated. Example: 1,2.

--target-url

URL(s) of work-items to create relation with. Multiple values can be passed comma separated.

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.

az boards work-item relation list-type

List work item relations supported in the organization.

az boards work-item relation list-type [--detect {false, true}]
                                       [--org]

Optional Parameters

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

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.

az boards work-item relation remove

Remove relation(s) from work item.

az boards work-item relation remove --id
                                    --relation-type
                                    --target-id
                                    [--detect {false, true}]
                                    [--org]
                                    [--yes]

Required Parameters

--id

The ID of the work item.

--relation-type

Relation type to remove. Example: parent, child.

--target-id

ID(s) of work-items to remove relation from. Multiple values can be passed comma separated. Example: 1,2.

Optional Parameters

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

--yes -y

Do not prompt for confirmation.

default value: False

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.

az boards work-item relation show

Get work item, fill relations with friendly name.

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

Required Parameters

--id

The ID of the work item.

Optional Parameters

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

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.