az boards work-item

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). 该扩展将在首次运行 az boards work-item 命令时自动安装。 Learn more about extensions.

管理工作项。

命令

名称	说明	类型	Status
az boards work-item create	创建工作项。	Extension	GA
az boards work-item delete	删除工作项。	Extension	GA
az boards work-item relation	管理工作项关系。	Extension	GA
az boards work-item relation add	将 relation（s） 添加到工作项。	Extension	GA
az boards work-item relation list-type	列出组织中支持的工作项关系。	Extension	GA
az boards work-item relation remove	从工作项中删除关系。	Extension	GA
az boards work-item relation show	获取工作项，用友好名称填充关系。	Extension	GA
az boards work-item show	显示工作项的详细信息。	Extension	GA
az boards work-item update	更新工作项。	Extension	GA

az boards work-item create

创建工作项。

az boards work-item create --title
                           --type
                           [--area]
                           [--assigned-to]
                           [--description]
                           [--detect {false, true}]
                           [--discussion]
                           [--fields]
                           [--iteration]
                           [--open]
                           [--org --organization]
                           [--project]
                           [--reason]

必需参数

--title

工作项的标题。

--type

工作项类型的名称（例如 Bug）。

可选参数

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

--area

工作项分配给的区域（例如演示）。

--assigned-to

工作项被分配到的人员的名称（例如 fabrikam）。

--description -d

工作项的说明。

--detect

自动检测组织。

属性	值
接受的值:	false, true

--discussion

要添加到工作项中的讨论的注释。

--fields -f

要设置的自定义字段的空格分隔的“field=value”对。 如果有多个字段：“field1=value1”“field2=value2”。 有关字段的更多详细信息，请参阅 https://aka.ms/azure-devops-cli-field-api。

--iteration

工作项的迭代路径（例如 Demos\Iteration 1）。

--open

在默认 Web 浏览器中打开工作项。

属性	值
默认值:	False

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--reason

工作项状态的原因。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az boards work-item delete

删除工作项。

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

必需参数

--id

工作项的唯一 ID。

可选参数

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

--destroy

永久删除此工作项。

属性	值
默认值:	False

--detect

自动检测组织。

属性	值
接受的值:	false, true

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az boards work-item show

显示工作项的详细信息。

az boards work-item show --id
                         [--as-of]
                         [--detect {false, true}]
                         [--expand {all, fields, links, none, relations}]
                         [--fields]
                         [--open]
                         [--org --organization]

必需参数

--id

工作项的 ID。

可选参数

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

--as-of

在特定日期和时间的工作项详细信息。 提供日期或日期时间字符串。 假定本地时区。 示例：“2019-01-20”、“2019-01-20 00：20：00”。 对于 UTC，请将“UTC”追加到日期时间字符串“2019-01-20 00：20：00 UTC”。

--detect

自动检测组织。

属性	值
接受的值:	false, true

--expand

工作项属性的展开参数。

属性	值
默认值:	all
接受的值:	all, fields, links, none, relations

--fields -f

请求字段的逗号分隔列表。 Example:System.Id,System.AreaPath. 有关字段的更多详细信息，请参阅 https://aka.ms/azure-devops-cli-field-api。

--open

在默认 Web 浏览器中打开工作项。

属性	值
默认值:	False

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az boards work-item update

更新工作项。

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

必需参数

--id

要更新的工作项的 ID。

可选参数

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

--area

工作项分配给的区域（例如演示）。

--assigned-to

工作项被分配到的人员的名称（例如 fabrikam）。

--description -d

工作项的说明。

--detect

自动检测组织。

属性	值
接受的值:	false, true

--discussion

要添加到工作项中的讨论的注释。

--fields -f

要设置的自定义字段的空格分隔的“field=value”对。 有关字段的更多详细信息，请参阅 https://aka.ms/azure-devops-cli-field-api。

--iteration

工作项的迭代路径（例如 Demos\Iteration 1）。

--open

在默认 Web 浏览器中打开工作项。

属性	值
默认值:	False

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--reason

工作项状态的原因。

--state

工作项的状态（例如活动）。

--title

工作项的标题。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False