az boards work-item

Note

このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-devops 拡張機能の一部です。 拡張機能は、az boards work-item コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

作業項目を管理します。

コマンド

名前 説明 Status
az boards work-item create

作業項目を作成します。

拡張 GA
az boards work-item delete

作業項目を削除します。

拡張 GA
az boards work-item relation

作業項目の関係を管理します。

拡張 GA
az boards work-item relation add

作業項目にリレーションを追加します。

拡張 GA
az boards work-item relation list-type

組織でサポートされている作業項目の関係を一覧表示します。

拡張 GA
az boards work-item relation remove

作業項目からリレーションを削除します。

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

作業項目の種類の名前 (バグなど)。

省略可能のパラメーター

--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 config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 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

サブスクリプションの名前または ID。 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

作業項目の一意の ID。

省略可能のパラメーター

--destroy

この作業項目を完全に削除します。

既定値: False
--detect

組織を自動的に検出します。

承認された値: false, true
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 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

サブスクリプションの名前または ID。 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

作業項目の ID。

省略可能のパラメーター

--as-of

特定の日付と時刻の作業項目の詳細。 日付または日付時刻の文字列を指定します。 ローカル タイム ゾーンを想定します。 例: '2019-01-20'、'2019-01-20 00:20:00'。 UTC の場合、日付時刻文字列 '2019-01-20 00:20:00 UTC' に '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

作業項目を既定の Web ブラウザーで開きます。

既定値: False
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: 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

サブスクリプションの名前または ID。 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

更新する作業項目の 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

作業項目を既定の Web ブラウザーで開きます。

既定値: False
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。