機能拡張ポイント

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

拡張機能は、新しい機能を提供することで、Azure DevOps ユーザー エクスペリエンスを強化します。 この記事では、拡張機能がターゲットにできる最も一般的な拡張ポイントについて説明します。 Azure DevOps 拡張機能モデルの詳細については、 Contribution モデルを参照してください。

Contributions Guide 拡張機能はサンプル拡張機能です。 この拡張機能を組織にインストールします。 インストールされると、使用可能な拡張ポイントが表示されます。 この拡張機能は、個人またはテスト組織にインストールすることをお勧めします。 この拡張機能の ソース も使用できます。 また、リポジトリ作成拡張ポイントのサンプル。

詳細については、次の参考資料を参照してください。

• azure-devops-extension-api
• azure-devops-extension-sdk
• azure-devops-extension-sample
• インストールされている拡張機能 API

ハブとハブ グループ

ハブとハブ グループは、Azure DevOps の主要なナビゲーション要素です。 Files、 Releases、 Backlogs、 Queries はハブの例です。 ハブはハブ グループに属しています。 たとえば、 Files ハブは、プロジェクト レベルの Azure Repos ハブ グループに属しています。 ハブ グループは、組織レベルまたはコレクション レベルまたはプロジェクト レベルで存在できます。 ほとんどの拡張機能はプロジェクト レベルに影響します。

次の表では、ハブを提供できる Azure DevOps の最も一般的なハブ グループについて説明します。

Name	ID	Level	プレビュー画像
Azure Boards	ms.vss-work-web.work-hub-group	プロジェクト/チーム
Azure Repos	ms.vss-code-web.code-hub-group	プロジェクト/チーム
Azure Pipelines	ms.vss-build-web.build-release-hub-group	プロジェクト/チーム
Azure Test Plans	ms.vss-test-web.test-hub-group	プロジェクト/チーム
プロジェクト設定	ms.vss-web.project-admin-hub-group	プロジェクト
組織の設定	ms.vss-web.collection-admin-hub-group	組織またはコレクション

例

次の例は、コード ハブ グループにハブを提供する方法を示しています。

{
    ...
    "contributions": [
        {
            "id": "my-custom-hub",
            "type": "ms.vss-web.hub",
            "targets": [
                "ms.vss-code-web.code-hub-group"
            ],
            "properties": {
                "name": "Code Hub",
                "order": 30,
                "uri": "/views/code/custom.html"
            }
        }
    ]
}

• ms.vss-web.hub は、このコントリビューションの種類です。 この型は、ms パブリッシャーの下で発行されたvss-web拡張機能で定義されます。 この型は、この型のコントリビューションに必要な省略可能なプロパティと必須プロパティ (名前、順序など) を宣言します。
• ms.vss-code-web.code-hub-group は、このハブが対象としているハブ グループのコントリビューションの完全な ID です。 このコントリビューションは、ms パブリッシャーで公開されているvss-code-web拡張機能で宣言されています
• my-custom-hub は、このコントリビューションの短い ID です。 {publisherId}.{extensionId}.my-custom-hub は完全な ID です

メニューまたはツール バーにアイコンを追加する

アイコン プロパティを追加して、名前で直接使用できるようにします。

独自のアイコンを指定することをお勧めします。 独自のアイコンの使用例:

           "name": "Sample hub",
           "uri": "dist/Hub/Hub.html",
           "icon": "asset://static/sample-icon.png",
           "supportsMobile": true
       }

Office UI Fabric アイコンの使用例:

            "iconName": "Code",
            "name": "Code Hub",
            "order": 30,
            "uri": "/views/code/custom.html"
        }

メニューとツール バーの設定

Azure Boards のメニューとツール バー

Name	ターゲット ID	プレビュー画像
作業項目のクエリ メニュー	ms.vss-work-web.work-item-query-menu
作業項目のクエリ結果ツール バー メニュー	ms.vss-work-web.work-item-query-results-toolbar-menu
作業項目のクエリ結果メニュー項目	ms.vss-work-web.query-result-work-item-menu
[作業項目のクエリ結果] タブ	ms.vss-work-web.query-tabs
コンテキスト メニューの作業項目	ms.vss-work-web.work-item-toolbar-menu
[バックログ] 項目メニュー	ms.vss-work-web.backlog-item-menu
スプリント ボードのピボット フィルター メニュー	ms.vss-work-web.sprint-board-pivot-filter-menu
ボード ピボット フィルター メニュー	ms.vss-work-web.backlog-board-pivot-filter-menu
カード メニュー	ms.vss-work-web.backlog-board-card-item-menu
[製品バックログ] タブ	ms.vss-work-web.product-backlog-tabs
[イテレーション バックログ] タブ	ms.vss-work-web.iteration-backlog-tabs
[ポートフォリオ バックログ] ウィンドウ	ms.vss-work-web.portfolio-backlog-toolpane
[製品のバックログ] ウィンドウ	ms.vss-work-web.requirement-backlog-toolpane
[イテレーション バックログ] ウィンドウ	ms.vss-work-web.iteration-backlog-toolpane

Azure Pipelines のメニューとツール バー

Name	ターゲット ID	プレビュー
完了したビルド メニュー	ms.vss-build-web.completed-build-menu
[ビルド定義] メニュー	ms.vss-build-web.build-definition-menu
テスト結果ツール バーのアクション	ms.vss-test-web.test-results-actions-menu
[テスト結果の詳細] タブ	ms.vss-test-web.test-result-details-tab-items
リリース パイプライン エクスプローラーのコンテキスト メニュー	ms.vss-releaseManagement-web.release-definition-explorer-context-menu
リリース パイプライン エクスプローラーのツール バー メニュー	ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu
[リリースの概要] ツール バー メニュー	ms.vss-releaseManagement-web.release-editor-tool-bar-menu
[リリースの概要] タブ	ms.vss-releaseManagement-web.release-details-view
リリースの概要セクション	ms.vss-releaseManagement-web.release-details-summary-tab

Azure Pipelines のメニューとツール バー

Name	ターゲット ID	プレビュー
完了したビルド メニュー	ms.vss-build-web.completed-build-menu
テスト結果ツール バーのアクション	ms.vss-test-web.test-results-actions-menu
[テスト結果の詳細] タブ	ms.vss-test-web.test-result-details-tab-items
リリース パイプライン エクスプローラーのコンテキスト メニュー	ms.vss-releaseManagement-web.release-definition-explorer-context-menu
パイプラインの詳細ビュー、ヘッダー ボタン	ms.vss-build-web.pipelines-header-menu
パイプラインの詳細ビュー、フォルダーのコンテキスト メニュー	ms.vss-build-web.pipelines-folder-menu

Azure Pipelines タスク

タスクはビルドまたはリリースで作業を実行します。 詳細については、ビルド タスクまたはリリース タスクを する方法について説明。

Azure Repos のメニューとツール バー

Name	ターゲット ID	プレビュー画像
ソース項目 (グリッド) メニュー	ms.vss-code-web.source-grid-item-menu
ソース項目 (ツリー) メニュー	ms.vss-code-web.source-tree-item-menu
ソース項目 (グリッドとツリー) メニュー	ms.vss-code-web.source-item-menu
リスト 項目の変更メニュー	ms.vss-code-web.change-list-item-menu
[リストの概要項目の変更] メニュー	ms.vss-code-web.change-list-summary-item-menu
Git ブランチ ツリー メニュー	ms.vss-code-web.git-branches-tree-menu
Git pull request actions メニュー	ms.vss-code-web.pull-request-action-menu
Git pull request タブ (ピボット)	ms.vss-code-web.pr-tabs
Git コミットの一覧メニュー	ms.vss-code-web.git-commit-list-menu
Git コミットの詳細メニュー	ms.vss-code-web.git-commit-details-menu

Azure Test Plans のメニューとツール バー

Name	ターゲット ID	プレビュー画像
テスト実行グリッド メニュー	ms.vss-test-web.test-run-grid-menu
テスト プラン スイートのツリー メニュー	ms.vss-test-web.test-plans-suites-context
[Test plan hub pivot]\(テスト計画ハブのピボット\) タブ	ms.vss-test-web.test-plan-pivot-tabs

その他の機能拡張ポイント

• ダッシュボード ウィジェット: 拡張機能は、ユーザーが dashboardに追加できる新しい種類のウィジェットを提供できます。 ダッシュボード ウィジェットを する方法について説明します。
• 作業項目フォーム: 作業項目フォームは、新しいセクション、タブ、アクション、およびユーザー設定フィールド レンダラーを使用して拡張機能によって拡張されます。 詳細については、作業項目フォーム 拡張する方法について説明。
• サービス フック: "コンシューマー" は、サービス フックでイベントが送信されるサービスです。 拡張機能は、コンシューマー サービスを提供できます。 これらのサービスは、そのサービスにイベントを送信するようにユーザー (またはプログラムによって) 構成されます。 詳細については、「 サービスフックコンシューマーを構成する」を参照してください。
• 機能：