Freigeben über


Erweiterungspunkte

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Erweiterungen fügen funktionen zur Azure DevOps UI und REST-Oberfläche hinzu. In diesem Artikel werden die am häufigsten verwendeten Erweiterbarkeitspunkte aufgeführt, auf die Sie abzielen können, und die IDs angezeigt, die Sie in Ihrem Erweiterungsmanifest verwenden. Das vollständige Manifestschema finden Sie in der Erweiterungsmanifestreferenz. Eine Übersicht über das Erweiterungsmodell und die Beitragsmuster finden Sie im Beitragsmodell.

Tipp

Wenn Sie eine neue Azure DevOps-Erweiterung starten, probieren Sie diese verwalteten Beispielsammlungen zuerst aus – sie arbeiten mit aktuellen Produktbuilds und behandeln moderne Szenarien (z. B. Hinzufügen von Registerkarten auf Pullanforderungsseiten).

Wenn ein Beispiel in Ihrer Organisation nicht funktioniert, installieren Sie es in einer persönlichen oder Testorganisation und vergleichen Sie die Ziel-IDs und API-Versionen des Erweiterungsmanifests mit den aktuellen Dokumenten. Weitere Informationen und APIs finden Sie unter:

Hubs und Hub-Gruppen

Hubs und Hubgruppen bieten primäre Navigation in Azure DevOps (z. B. Dateien, Bereitstellungen, Backlogs, Abfragen). Ein Hub gehört zu einer Hubgruppe; Beispielsweise gehört der Dateien-Hub zur Azure Repos-Hubgruppe auf Projektebene. Hubgruppen können auf Organisation/Sammlungsebene oder auf Projektebene vorhanden sein. Die meisten Erweiterungen tragen auf Projektebene bei.

In der folgenden Tabelle sind allgemeine Hubgruppen und deren Beitrags-IDs aufgeführt.

Name Identifikationsnummer Ebene Vorschaubild
Azure Boards ms.vss-work-web.work-hub-group Projekt/Team Screenshot eines benutzerdefinierten Hubs, der Azure Boards hinzugefügt wurde.
Azure Repos ms.vss-code-web.code-hub-group Projekt/Team Screenshot eines benutzerdefinierten Hubs, der Azure Repos hinzugefügt wurde.
Azure-Pipelines ms.vss-build-web.build-release-hub-group Projekt/Team Screenshot eines benutzerdefinierten Hubs, der Azure-Pipelines hinzugefügt wurde.
Azure Testpläne ms.vss-test-web.test-hub-group Projekt/Team Screenshot eines benutzerdefinierten Hubs, der Azure-Testpläne hinzugefügt wurde.
Projekteinstellungen ms.vss-web.project-admin-hub-group Projekt Screenshot eines benutzerdefinierten Hubs in den Projekteinstellungen.
Organisationseinstellungen ms.vss-web.collection-admin-hub-group Organisation/Sammlung Screenshot eines benutzerdefinierten Hubs in den Organisationseinstellungen.

Einen Hub beitragen

Dieses Beispiel zeigt einen Hubbeitrag, der auf die Code-Hubgruppe ausgerichtet ist:

{
  "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 — der Beitragstyp. Die vss-web durch ms diese Eigenschaft veröffentlichte Erweiterung definiert diesen Typ sowie die erforderlichen und optionalen Eigenschaften, z name . B. und order.
  • ms.vss-code-web.code-hub-group — die vollständige ID der Hubgruppe, auf die dieser Hub ausgerichtet ist.
  • my-custom-hub — die kurze ID dieses Beitrags. Die vollständige ID lautet {publisherId}.{extensionId}.my-custom-hub.

In der folgenden Tabelle sind die für ms.vss-web.hub Beiträge verfügbaren Eigenschaften aufgeführt:

Eigentum Typ Erforderlich Beschreibung
name Schnur Ja Anzeigename in der Hubnavigation
order Zahl No Position relativ zu anderen Hubs (niedrigere Werte werden zuerst angezeigt)
uri Schnur Ja Relativer Pfad zur HTML-Inhaltsseite des Hubs
icon Schnur No Benutzerdefiniertes Symbol mithilfe eines Pfads asset://
iconName Schnur No Fluent UI-Symbolname
supportsMobile boolean No Gibt an, ob der Hub auf mobilen Geräten angezeigt wird.

Tipp

Wenn Ihr Beitrag nicht angezeigt wird, überprüfen Sie, ob die Ziel-ID exakt übereinstimmt . Bei IDs wird die Groß-/Kleinschreibung beachtet. Laden Sie die Erweiterung in Ihrem Browser neu, und überprüfen Sie die Konsole der Entwicklertools auf Fehler beim Laden von Erweiterungen.

Hinzufügen eines Symbols zu einem Menü oder einer Symbolleiste

Verwenden Sie die icon Eigenschaft in iconName Ihrem Beitrag, um ein Symbol anzuzeigen. Geben Sie nach Möglichkeit Ihr eigenes Symbol an.

Benutzerdefiniertes Symbol:

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

Fluent UI-Symbol:

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

Hinweis

Die icon Eigenschaften iconName funktionieren nur für Hubs, Menüs und Symbolleisten. Sie funktionieren nicht für Registerkartenbeiträge.

Einstellungen für Menüs und Symbolleisten

Diese Ziele gelten für Organisations- und Projektverwaltungsseiten, nicht für dienstspezifische Hubs wie Azure Boards oder Azure Repos.

Name Ziel-ID
Symbolleiste Organisations-/Sammlungsübersicht ms.vss-admin-web.collection-overview-toolbar-menu
Sammlung Übersicht Projekte Raster ms.vss-admin-web.projects-grid-menu
Symbolleiste für Projektübersicht ms.vss-admin-web.project-overview-toolbar-menu
Projektübersicht Teams Grid ms.vss-admin-web.teams-grid-menu

Azure Boards-Menü und Symbolleiste

Name Ziel-ID Vorschaubild
Arbeitselementabfragemenü ms.vss-work-web.work-item-query-menu Screenshot einer benutzerdefinierten Aktion im Abfragemenü.
Menü der Symbolleiste für die Ergebnisse von Arbeitselementabfragen ms.vss-work-web.work-item-query-results-toolbar-menu Screenshot einer benutzerdefinierten Aktion im Menü
Arbeitselement Abfrageergebnisse Menüelement ms.vss-work-web.query-result-work-item-menu Screenshot einer benutzerdefinierten Aktion im Menü
Registerkarte Arbeitselementabfrageergebnisse ms.vss-work-web.query-tabs Screenshot einer benutzerdefinierten Registerkarte in Abfrageergebnissen.
Arbeitsaufgabe für Kontextmenü ms.vss-work-web.work-item-toolbar-menu Screenshot der benutzerdefinierten Aktionen in der Arbeitsaufgabensymbolleiste.
Menü Backlog-Element ms.vss-work-web.backlog-item-menu Screenshot der benutzerdefinierten Aktionen im Menü
SPRINTBOARD-DREHFIL ms.vss-work-web.sprint-board-pivot-filter-menu Screenshot des Pivotfiltermenüs des Sprintboards.
Menü Board-Pivot-Filter ms.vss-work-web.backlog-board-pivot-filter-menu Screenshot des Pivotfiltermenüs des Backlogboards.
Kartenmenü ms.vss-work-web.backlog-board-card-item-menu
Registerkarte Product Backlog ms.vss-work-web.product-backlog-tabs Screenshot einer benutzerdefinierten Registerkarte im Produktrücklog.
Registerkarte Iterationsrückstand ms.vss-work-web.iteration-backlog-tabs Screenshot einer benutzerdefinierten Registerkarte im Iterationsbacklog.
Portfoliobacklogbereich ms.vss-work-web.portfolio-backlog-toolpane Screenshot eines benutzerdefinierten Bereichs im Portfolio-Backlog.
Produkt-Backlog-Bereich ms.vss-work-web.requirement-backlog-toolpane Screenshot eines benutzerdefinierten Bereichs im Produktrücklog.
Iterationsrückstandsbereich ms.vss-work-web.iteration-backlog-toolpane Screenshot eines benutzerdefinierten Bereichs im Iterationsbacklog.

Azure Pipelines-Menü und Symbolleiste

Name Ziel-ID Vorschau
Erstellungsmenü abgeschlossen ms.vss-build-web.completed-build-menu Screenshot des Menüs
Aktion der Testergebnis-Symbolleiste ms.vss-test-web.test-results-actions-menu Screenshot einer benutzerdefinierten Aktion in der Symbolleiste für Testergebnisse.
Registerkarte Testergebnisdetails ms.vss-test-web.test-result-details-tab-items Screenshot einer benutzerdefinierten Registerkarte in Testergebnisdetails.
Kontextmenü des Pipeline-Explorers freigeben ms.vss-releaseManagement-web.release-definition-explorer-context-menu Screenshot des Kontextmenüs des Versionsdefinitions-Explorers.
Pipeline-Detailansicht, Kopfzeilenknopf ms.vss-build-web.pipelines-header-menu Screenshot einer Kopfzeilenschaltfläche in der Ansicht
Pipelinedetailansicht, Ordnerkontextmenü ms.vss-build-web.pipelines-folder-menu Screenshot eines Ordnerkontextmenüs in der Ansicht

Azure Pipelines-Aufgaben

Aufgaben führen Arbeit in einer Build- oder Releasepipeline aus. Weitere Informationen finden Sie unter Hinzufügen einer Aufgaben-Erweiterung für benutzerdefinierte Pipelines.

Azure Repos-Menü und Symbolleiste

Name Ziel-ID Vorschaubild
Menü des Quellitems (Raster) ms.vss-code-web.source-grid-item-menu Screenshot des Rastermenüs des Quellelements.
Quell-Element (Baum) Menü ms.vss-code-web.source-tree-item-menu Screenshot des Menüs
Quellenitem-Menü (Raster und Baum) ms.vss-code-web.source-item-menu Screenshot des kombinierten Menüs des Quellelements.
Menü zum Ändern von Listenelementen ms.vss-code-web.change-list-item-menu
Listenzusammenfassungsmenü ändern ms.vss-code-web.change-list-summary-item-menu
Git-Zweige Baummenü ms.vss-code-web.git-branches-tree-menu Screenshot des Git-Verzweigungsstrukturmenüs.
Menü 'Git-Pullanforderungsaktionen' ms.vss-code-web.pull-request-action-menu Screenshot des Menüs
Git Pull Request Tabs (Pivots) ms.vss-code-web.pr-tabs Screenshot einer benutzerdefinierten Registerkarte in einer Git-Pull-Anforderung.
Git Commit Listing-Menü ms.vss-code-web.git-commit-list-menu Screenshot des Git Commit-Listenmenüs.
Git Commit-Detailmenü ms.vss-code-web.git-commit-details-menu Screenshot des Git Commit-Detailmenüs.

Menü und Symbolleiste für Azure-Testpläne

Name Ziel-ID Vorschaubild
Menü Testlaufraster ms.vss-test-web.test-run-grid-menu Screenshot des Rastermenüs
Testplan Suites Baummenü ms.vss-test-web.test-plans-suites-context Screenshot des Kontextmenüs der Testplänesammlungen.
Prüfplan Hub Pivot Tab ms.vss-test-web.test-plan-pivot-tabs Screenshot einer benutzerdefinierten Pivotregisterkarte auf dem Testplanhub.

Andere Erweiterungspunkte