Compartilhar via

Pontos de extensibilidade

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

As extensões adicionam recursos à interface do usuário do Azure DevOps e à superfície REST. Este artigo lista os pontos de extensão mais comuns a serem abordados e mostra as IDs que você usa no manifesto da extensão. Para obter uma visão geral do modelo de extensão e dos padrões de contribuição, consulte o modelo de Contribuição.

Dica

Se você estiver iniciando uma nova extensão do Azure DevOps, experimente essas coleções de exemplo mantidas primeiro— elas funcionam com builds de produtos atuais e abrangem cenários modernos (por exemplo, adicionando guias em páginas de solicitação pull).

Se um exemplo não funcionar em sua organização, instale-o em uma organização pessoal ou de teste e compare as IDs de destino do manifesto de extensão e as versões da API com as documentações atuais. Para referência e APIs, consulte:

Hubs e grupos de hubs

Hubs e grupos de hubs fornecem navegação primária no Azure DevOps (por exemplo, Arquivos, Versões, Backlogs, Consultas). Um hub pertence a um grupo de hubs; por exemplo, o Hub de Arquivos pertence ao grupo de hubs do Azure Repos no nível do projeto. Os grupos de hubs podem existir no nível da organização/coleção ou no nível do projeto. A maioria das extensões contribui no nível do projeto.

A tabela a seguir lista grupos de hub comuns e suas IDs de contribuição.

Nome ID Nível Visualizar a imagem
Azure Boards ms.vss-work-web.work-hub-group Projeto/equipe Captura de tela do hub de trabalho personalizado adicionado ao Azure Boards.
Azure Repos ms.vss-code-web.code-hub-group Projeto/equipe Captura de tela do hub de trabalho personalizado adicionado ao Azure Repos.
Azure Pipelines ms.vss-build-web.build-release-hub-group Projeto/equipe Captura de tela do hub personalizado adicionado ao Azure Pipelines.
Azure Test Plans ms.vss-test-web.test-hub-group Projeto/equipe Captura de tela do hub personalizado adicionado aos Planos de Teste do Azure.
Configurações de projeto ms.vss-web.project-admin-hub-group Projeto Captura de tela do hub de administração de projeto personalizado.
Configurações da organização ms.vss-web.collection-admin-hub-group Organização/coleção Captura de tela do hub de administração da organização personalizada.

Contribuir para um hub

Este exemplo mostra uma contribuição de hub direcionada ao grupo de hubs de código:

{
  "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 é o tipo de contribuição. A vss-web extensão publicada no ms publicador define esse tipo. Esse tipo define as propriedades opcionais e necessárias para contribuições desse tipo (por exemplo, nome, ordem).
  • ms.vss-code-web.code-hub-group é a ID completa da contribuição do grupo de hubs que esse hub tem como destino. A vss-code-web extensão publicada no ms publicador declara essa contribuição.
  • my-custom-hub é o ID abreviado desta contribuição; {publisherId}.{extensionId}.my-custom-hub é o ID completo.

Adicionar um ícone ao menu ou à barra de ferramentas

Adicione uma propriedade de ícone para que você possa referenciá-la diretamente pelo nome.

Recomendamos fornecer seu próprio ícone. Usando seu próprio exemplo de ícone:

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

Usando o exemplo de ícones do Office UI Fabric:

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

Observação

Ícones, icon e propriedades iconName, não dão suporte a contribuições de aba. Eles só funcionam para hubs, menus e barras de ferramentas.

Configurações para menus e barras de ferramentas

Nome ID de destino
Barra de ferramentas de visão geral da organização/coleção ms.vss-admin-web.collection-overview-toolbar-menu
Grade de projetos de visão geral da coleção ms.vss-admin-web.projects-grid-menu
Barra de ferramentas de visão geral do projeto ms.vss-admin-web.project-overview-toolbar-menu
Grade de equipes de visão geral do projeto ms.vss-admin-web.teams-grid-menu

Menu e barra de ferramentas do Azure Boards

Nome ID de destino Visualizar a imagem
Menu de consulta de item de trabalho ms.vss-work-web.work-item-query-menu Captura de tela da ação de consulta personalizada adicionada ao menu de consulta.
Menu da barra de ferramentas de resultados da consulta de item de trabalho ms.vss-work-web.work-item-query-results-toolbar-menu Captura de tela da ação do menu personalizado da barra de ferramentas Resultados da consulta.
Item de menu Resultados da consulta de item de trabalho ms.vss-work-web.query-result-work-item-menu Captura de tela da ação personalizada do Menu do Item de Resultados da Consulta.
Guia Resultados da consulta de item de trabalho ms.vss-work-web.query-tabs Captura de tela da guia dinâmica personalizada da barra de ferramentas de consulta.
Item de trabalho para menu de contexto ms.vss-work-web.work-item-toolbar-menu Captura de tela das ações da barra de ferramentas do item de trabalho personalizado.
Menu de itens de lista de pendências ms.vss-work-web.backlog-item-menu Captura de tela das opções de menu personalizado de ações de item de lista de pendências.
Menu de filtro dinâmico do quadro de sprint ms.vss-work-web.sprint-board-pivot-filter-menu Captura de tela do menu de filtro pivô do sprint board.
Menu de filtro dinâmico do quadro ms.vss-work-web.backlog-board-pivot-filter-menu Captura de tela das ações de filtro dinâmico do quadro de pendências.
Menu de cartões ms.vss-work-web.backlog-board-card-item-menu
Guia Lista de pendências do produto ms.vss-work-web.product-backlog-tabs Captura de tela da guia personalizada do Backlog do produto.
Guia Lista de pendências de iteração ms.vss-work-web.iteration-backlog-tabs Captura de tela das iterações Backlog Custom Tab.
Painel de lista de pendências de portfólio ms.vss-work-web.portfolio-backlog-toolpane Captura de tela do painel personalizado da lista de pendências do portfólio.
Painel de lista de pendências do produto ms.vss-work-web.requirement-backlog-toolpane Captura de tela do painel personalizado do Product Backlog.
Painel de lista de pendências de iteração ms.vss-work-web.iteration-backlog-toolpane Captura de tela do painel personalizado da lista de pendências de iteração.

Menu e barra de ferramentas do Azure Pipelines

Nome ID de destino Visualizar
Menu de construção concluído ms.vss-build-web.completed-build-menu Captura de tela das ações de build concluídas.
Ação da barra de ferramentas de resultados do teste ms.vss-test-web.test-results-actions-menu Captura de tela da ação da barra de ferramentas dos resultados do teste.
Guia Detalhes do resultado do teste ms.vss-test-web.test-result-details-tab-items Captura de tela da guia de detalhes do resultado do teste.
Menu de contexto do gerenciador de pipeline de lançamento ms.vss-releaseManagement-web.release-definition-explorer-context-menu Captura de tela do menu de contexto do explorador de definições.
Visualização de detalhes do pipeline, botão de cabeçalho ms.vss-build-web.pipelines-header-menu Captura de tela da visualização de detalhes do pipeline, menu de cabeçalho.
Visualização de detalhes do pipeline, menu de contexto da pasta ms.vss-build-web.pipelines-folder-menu Captura de tela da exibição de detalhes do pipeline, menu de contexto da pasta.

Tarefas do Azure Pipelines

As tarefas executam o trabalho em uma compilação ou versão. Para obter mais informações, consulte Adicionar uma extensão de tarefa de pipelines personalizada.

Menu e barra de ferramentas do Azure Repos

Nome ID de destino Visualizar a imagem
Menu de item de origem (grade) ms.vss-code-web.source-grid-item-menu Captura de tela das ações da grade de itens de repos.
Menu de item de origem (árvore) ms.vss-code-web.source-tree-item-menu Captura de tela das ações da árvore de itens repos.
Menu de item de origem (grade e árvore) ms.vss-code-web.source-item-menu Captura de tela das ações do item de repositórios.
Alterar menu de item de lista ms.vss-code-web.change-list-item-menu
Alterar menu de itens de resumo da lista ms.vss-code-web.change-list-summary-item-menu
Menu de árvore de ramificações do Git ms.vss-code-web.git-branches-tree-menu Captura de tela da árvore git branches.
Menu de ações de solicitação de pull do Git ms.vss-code-web.pull-request-action-menu Captura de tela das ações de solicitação de pull do git.
Guias de solicitação de pull do Git (pivôs) ms.vss-code-web.pr-tabs Captura de tela da guia de solicitação de pull do git.
Menu de listagem de commit do Git ms.vss-code-web.git-commit-list-menu Captura de tela do menu da lista de commit do git.
Menu de detalhes de confirmação do Git ms.vss-code-web.git-commit-details-menu Captura de tela do menu de detalhes do commit do git.

Menu e barra de ferramentas do Azure Test Plans

Nome ID de destino Visualizar a imagem
Menu de grade de execução de teste ms.vss-test-web.test-run-grid-menu Captura de tela do menu da grade de execução de teste.
Menu de árvore de conjuntos de planos de teste ms.vss-test-web.test-plans-suites-context Captura de tela do contexto dos conjuntos de planos de teste.
Guia dinâmica do hub do plano de teste ms.vss-test-web.test-plan-pivot-tabs Captura de tela da guia dinâmica do hub de teste.

Outros pontos de extensibilidade

  • Widget do painel: uma extensão pode contribuir com um novo tipo de widget que os usuários podem adicionar a um painel. Saiba como contribuir com um widget de painel.
  • Formulário do item de trabalho: as extensões aprimoram o formulário de item de trabalho com novas seções, guias, ações e renderizadores de campo personalizados. Para obter mais informações, saiba como estender o formulário de item de trabalho.
  • Ganchos de Serviço: um consumidor é o serviço para o qual o Service Hooks envia eventos. Uma extensão pode contribuir com serviços ao consumidor. Um usuário (ou programaticamente) configura esses serviços para enviar eventos para esse serviço. Para obter mais informações, consulte Criar um consumidor personalizado para ganchos de serviço.
  • Last updated on