機能拡張ポイント

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
• azuredevops-extension-sample
• インストールされている拡張機能 API

ハブとハブ グループ

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

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

名前	身分証明書	レベル	プレビュー画像
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 テストプラン	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 はコントリビューションの種類です。 この型は、vss-web パブリッシャーの下で発行されたms拡張機能で定義されます。 この型は、この型のコントリビューションに必要な省略可能なプロパティと必須プロパティ (名前、順序など) を宣言します。
• ms.vss-code-web.code-hub-group は、このハブがターゲットとするハブ グループコントリビューションの完全な ID です。 このコントリビューションは、vss-code-web パブリッシャーの下で公開されたms拡張機能で宣言されます。
• 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 のメニューとツール バー

名前	ターゲット 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 のメニューとツール バー

名前	ターゲット 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 のメニューとツール バー

名前	ターゲット 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 のメニューとツール バー

名前	ターゲット 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 プルリクエスト操作メニュー	ms.vss-code-web.pull-request-action-menu
Git プル リクエスト タブ (ピボット)	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 のメニューとツール バー

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

その他の拡張ポイント

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