az boards work-item

注意

此參考是 Azure CLI 的 azure-devops 延伸模組的一部分 （2.30.0 版或更高版本）。 擴充功能會在您第一次執行 az boards work-item 命令時自動安裝。 深入了解擴充功能。

管理工作項目。

命令

名稱	Description	類型	狀態
az boards work-item create	建立工作專案。	擴充	GA
az boards work-item delete	刪除工作專案。	擴充	GA
az boards work-item relation	管理工作專案關聯性。	擴充	GA
az boards work-item relation add	將 relation（s） 新增至工作專案。	擴充	GA
az boards work-item relation list-type	列出組織中支援的工作專案關聯性。	擴充	GA
az boards work-item relation remove	從工作專案移除 relation（s）。	擴充	GA
az boards work-item relation show	取得工作專案，以易記名稱填入關聯。	擴充	GA
az boards work-item show	顯示工作專案的詳細資料。	擴充	GA
az boards work-item update	更新工作專案。	擴充	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]
                           [--project]
                           [--reason]

必要參數

--title

工作專案的標題。

--type

工作專案類型的名稱（例如 Bug）。

選擇性參數

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

在預設網頁瀏覽器中開啟工作專案。

預設值: False

--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

--project -p

專案的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。

--reason

工作專案狀態的原因。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az boards work-item delete

刪除工作專案。

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

必要參數

--id

工作專案的唯一識別碼。

選擇性參數

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

專案的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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]

必要參數

--id

工作專案的識別碼。

選擇性參數

--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, fields, links, none, relations

預設值: all

--fields -f

要求的欄位逗號分隔清單。 範例：System.Id、System.AreaPath。 如需欄位的詳細資訊，請參閱 https://aka.ms/azure-devops-cli-field-api 。

--open

在預設網頁瀏覽器中開啟工作專案。

預設值: False

--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az boards work-item update

更新工作專案。

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

必要參數

--id

要更新的工作專案識別碼。

選擇性參數

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

在預設網頁瀏覽器中開啟工作專案。

預設值: False

--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

--reason

工作專案狀態的原因。

--state

工作專案的狀態（例如使用中）。

--title

工作專案的標題。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。