Poin perluasan

Layanan Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022

Ekstensi menambahkan kemampuan ke antarmuka pengguna Azure DevOps dan permukaan REST. Artikel ini mencantumkan titik ekstensibilitas paling umum yang dapat Anda targetkan dan menampilkan ID yang Anda gunakan dalam manifes ekstensi Anda. Untuk gambaran umum model ekstensi dan pola kontribusi, lihat model Kontribusi.

Petunjuk / Saran

Jika Anda memulai ekstensi Azure DevOps baru, coba koleksi sampel yang dikelola ini terlebih dahulu—mereka bekerja dengan build produk saat ini dan mencakup skenario modern (misalnya, menambahkan tab pada halaman permintaan pull).

• Sampel ekstensi Azure DevOps (GitHub)—sampel starter ringkas yang menunjukkan pola ekstensi umum: https://github.com/microsoft/azure-devops-extension-sample
• Sampel ekstensi Azure DevOps (panduan pengumpulan dan kontribusi warisan)—instal untuk memeriksa target UI, atau lihat sumbernya: https://marketplace.visualstudio.com/items/ms-samples.samples-contributions-guide dan https://github.com/Microsoft/vso-extension-samples/tree/master/contributions-guide
• Sampel Microsoft Learn (jelajahi sampel Azure DevOps)—sampel yang telah diseleksi, terbaru di seluruh dokumentasi Microsoft: /samples/browse/?terms=azure%20devops%20extension

Jika sampel tidak berfungsi di organisasi Anda, instal ke organisasi pribadi atau pengujian dan bandingkan ID target manifes ekstensi dan versi API dengan dokumen saat ini. Untuk referensi dan API, lihat:

• azure-devops-extension-api
• azure-devops-extension-sdk
• API ekstensi yang diinstal

Hubs dan himpunan hub

Hub dan grup hub menyediakan navigasi utama di Azure DevOps (misalnya, File, Rilis, Backlog, Kueri). Hub milik grup hub; misalnya, hub File milik grup hub Azure Repos tingkat proyek. Grup hub dapat ada di tingkat organisasi/koleksi atau di tingkat proyek. Sebagian besar ekstensi berkontribusi pada level proyek.

Tabel berikut mencantumkan grup hub umum dan ID kontribusinya.

Nama	ID	Tingkat	Pratinjau gambar
Papan Azure	ms.vss-work-web.work-hub-group	Proyek/tim
Azure Repos	ms.vss-code-web.code-hub-group	Proyek/tim
Azure Pipelines (Alat otomatisasi alur kerja pengembangan perangkat lunak dari Microsoft)	ms.vss-build-web.build-release-hub-group	Proyek/tim
Rencana Uji Azure	ms.vss-test-web.test-hub-group	Proyek/tim
pengaturan proyek	ms.vss-web.project-admin-hub-group	Proyek
Pengaturan organisasi	ms.vss-web.collection-admin-hub-group	Organisasi/koleksi

Menyumbangkan hub

Contoh ini menunjukkan kontribusi hub yang menargetkan grup hub Kode:

{
  "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 adalah jenis kontribusi. Ekstensi vss-web yang diterbitkan oleh penerbit ms mendefinisikan jenis ini. Jenis ini menentukan properti opsional dan diperlukan untuk kontribusi jenis ini (misalnya, nama, urutan).
• ms.vss-code-web.code-hub-group adalah ID lengkap kontribusi grup hub yang ditargetkan hub ini. Ekstensi vss-code-web yang diterbitkan oleh penerbit ms menyatakan kontribusi ini.
• my-custom-hub adalah ID pendek dari kontribusi ini; {publisherId}.{extensionId}.my-custom-hub adalah ID lengkap.

Menambahkan ikon ke menu atau bilah alat Anda

Tambahkan properti ikon sehingga Anda dapat mereferensikannya secara langsung berdasarkan nama.

Sebaiknya berikan ikon Anda sendiri. Menggunakan contoh ikon Anda sendiri:

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

Menggunakan contoh Office UI Fabric Icons:

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

Nota

Ikon dan properti icon serta iconName tidak mendukung kontribusi tab. Mereka hanya berfungsi untuk hub, menu, dan toolbar.

Pengaturan untuk menu dan toolbar

Nama	ID Sasaran
Toolbar gambaran umum dari organisasi/koleksi	ms.vss-admin-web.collection-overview-toolbar-menu
Gambaran umum koleksi kisi proyek	ms.vss-admin-web.projects-grid-menu
Toolbar gambaran umum proyek	ms.vss-admin-web.project-overview-toolbar-menu
Ikhtisar proyek kisi tim	ms.vss-admin-web.teams-grid-menu

Menu dan toolbar Azure Boards

Nama	ID Sasaran	Pratinjau gambar
Menu kueri item kerja	ms.vss-work-web.work-item-query-menu
Menu toolbar hasil pencarian item kerja	ms.vss-work-web.work-item-query-results-toolbar-menu
Menu hasil kueri item kerja	ms.vss-work-web.query-result-work-item-menu
Tab hasil kueri item kerja	ms.vss-work-web.query-tabs
Elemen tugas untuk menu konteks	ms.vss-work-web.work-item-toolbar-menu
Menu item backlog	ms.vss-work-web.backlog-item-menu
Menu filter pivot untuk papan sprint	ms.vss-work-web.sprint-board-pivot-filter-menu
Menu filter pivot papan pengarah	ms.vss-work-web.backlog-board-pivot-filter-menu
Menu kartu	ms.vss-work-web.backlog-board-card-item-menu
Tab backlog produk	ms.vss-work-web.product-backlog-tabs
Tab perulangan backlog	ms.vss-work-web.iteration-backlog-tabs
Jendela portofolio backlog	ms.vss-work-web.portfolio-backlog-toolpane
Panel produk backlog	ms.vss-work-web.requirement-backlog-toolpane
Jendela backlog iterasi	ms.vss-work-web.iteration-backlog-toolpane

Menu dan toolbar Azure Pipelines

Nama	ID Sasaran	Pratinjau
Menu selesai dibangun	ms.vss-build-web.completed-build-menu
Aksi toolbar hasil tes	ms.vss-test-web.test-results-actions-menu
Tab detail hasil pengujian	ms.vss-test-web.test-result-details-tab-items
Merilis menu konteks penjelajah alur	ms.vss-releaseManagement-web.release-definition-explorer-context-menu
Tampilan detail pipeline, tombol judul	ms.vss-build-web.pipelines-header-menu
Tampilan detail alur, menu konteks folder	ms.vss-build-web.pipelines-folder-menu

Ketugas Azure Pipelines

Tugas melakukan pekerjaan dalam build atau rilis. Untuk informasi selengkapnya, lihat Menambahkan ekstensi tugas alur kustom.

Menu dan toolbar Azure Repos

Nama	ID Sasaran	Pratinjau gambar
Menu item sumber (grid)	ms.vss-code-web.source-grid-item-menu
Menu item sumber (pohon)	ms.vss-code-web.source-tree-item-menu
Menu elemen sumber (kisi dan pohon)	ms.vss-code-web.source-item-menu
Menu untuk mengubah elemen daftar	ms.vss-code-web.change-list-item-menu
Mengubah menu ringkasan item daftar	ms.vss-code-web.change-list-summary-item-menu
Menu pohon cabang Git	ms.vss-code-web.git-branches-tree-menu
Menu tindakan permintaan pull Git	ms.vss-code-web.pull-request-action-menu
Tab permintaan tarik Git (penyaring)	ms.vss-code-web.pr-tabs
Menu daftar penerapan Git	ms.vss-code-web.git-commit-list-menu
Menu detail penerapan Git	ms.vss-code-web.git-commit-details-menu

Menu dan toolbar Paket Pengujian Azure

Nama	ID Sasaran	Pratinjau gambar
Menu kisi uji coba	ms.vss-test-web.test-run-grid-menu
Menu pohon rencana pengujian suite	ms.vss-test-web.test-plans-suites-context
Tab pivot hub rencana pengujian	ms.vss-test-web.test-plan-pivot-tabs

Titik ekstensibilitas lainnya

• Widget dasbor: Ekstensi dapat berkontribusi jenis widget baru yang dapat ditambahkan pengguna ke dasbor. Pelajari cara menyumbangkan widget dasbor.
• Formulir item kerja: Ekstensi meningkatkan formulir ini dengan menambahkan bagian baru, tab, tindakan, dan pengatur bidang kustom. Untuk informasi selengkapnya, pelajari cara memperluas formulir item kerja.
• Kait layanan: Konsumen adalah layanan tempat Service Hooks mengirim peristiwa. Ekstensi dapat berkontribusi pada layanan konsumen. Pengguna (atau secara terprogram) mengonfigurasi layanan ini untuk mengirim peristiwa ke layanan tersebut. Untuk informasi selengkapnya, lihat Membuat konsumen kustom untuk kait layanan.