Compartilhar via

Pontos de extensibilidade

Azure DevOps Services | Servidor Azure DevOps | 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 o esquema de manifesto completo, consulte a referência de manifesto de 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 de um hub personalizado adicionado ao Azure Boards.
Azure Repos ms.vss-code-web.code-hub-group Projeto/equipe Captura de tela de um hub personalizado adicionado ao Azure Repos.
Azure Pipelines ms.vss-build-web.build-release-hub-group Projeto/equipe Captura de tela de um hub personalizado adicionado ao Azure Pipelines.
Azure Test Plans ms.vss-test-web.test-hub-group Projeto/equipe Captura de tela de um hub personalizado adicionado aos Planos de Teste do Azure.
Configurações de projeto ms.vss-web.project-admin-hub-group Projeto Captura de tela de um hub personalizado nas configurações do projeto.
Configurações da organização ms.vss-web.collection-admin-hub-group Organização/coleção Captura de tela de um hub personalizado nas configurações da organização.

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 por ms define esse tipo e suas propriedades obrigatórias e opcionais, como name e order.
  • ms.vss-code-web.code-hub-group — a ID completa do grupo de hubs que este hub tem como destino.
  • my-custom-hub — a ID curta dessa contribuição. A ID completa é {publisherId}.{extensionId}.my-custom-hub.

A tabela a seguir lista as propriedades disponíveis para ms.vss-web.hub contribuições:

Propriedade Tipo Obrigatório Descrição
name cadeia Sim Nome de exibição mostrado na navegação do hub
order número No Posição em relação a outros hubs (valores mais baixos aparecem primeiro)
uri cadeia Sim Caminho relativo para a página de conteúdo HTML do hub
icon cadeia No Ícone personalizado usando um asset:// caminho
iconName cadeia No Nome do ícone da interface do usuário fluente
supportsMobile boolean No Se o hub aparece em dispositivos móveis

Dica

Se sua contribuição não aparecer, verifique se a ID de destino corresponde exatamente : as IDs diferenciam maiúsculas de minúsculas. Recarregue a extensão no navegador e verifique se há erros de carregamento de extensão no console de ferramentas do desenvolvedor.

Adicionar um ícone a um menu ou barra de ferramentas

Use a icon propriedade ou iconName a sua contribuição para exibir um ícone. Forneça seu próprio ícone quando possível.

Ícone personalizado:

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

Ícone da interface do usuário fluente:

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

Observação

As icon propriedades e as iconName propriedades funcionam somente para hubs, menus e barras de ferramentas. Eles não funcionam para contribuições de guias.

Configurações para menus e barras de ferramentas

Esses destinos se aplicam a páginas de administração da organização e do projeto, não a hubs específicos do serviço, como o Azure Boards ou o Azure Repos.

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 de uma ação personalizada no 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 de uma ação personalizada no menu da barra de ferramentas de 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 de uma ação personalizada no menu de item de resultados da consulta.
Guia Resultados da consulta de item de trabalho ms.vss-work-web.query-tabs Captura de tela de uma guia personalizada nos resultados da consulta.
Item de trabalho para menu de contexto ms.vss-work-web.work-item-toolbar-menu Captura de tela das ações personalizadas na barra de ferramentas do item de trabalho.
Menu de itens de lista de pendências ms.vss-work-web.backlog-item-menu Captura de tela das ações personalizadas no menu 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 dinâmico da placa sprint.
Menu de filtro dinâmico do quadro ms.vss-work-web.backlog-board-pivot-filter-menu Captura de tela do menu de filtro dinâmico da placa de backlog.
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 de uma guia personalizada na lista de pendências do produto.
Guia Lista de pendências de iteração ms.vss-work-web.iteration-backlog-tabs Captura de tela de uma guia personalizada na lista de pendências de iteração.
Painel de lista de pendências de portfólio ms.vss-work-web.portfolio-backlog-toolpane Captura de tela de um painel personalizado na 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 de um painel personalizado na lista de pendências do produto.
Painel de lista de pendências de iteração ms.vss-work-web.iteration-backlog-toolpane Captura de tela de um painel personalizado na 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 do menu 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 de uma ação personalizada na barra de ferramentas de resultados do teste.
Guia Detalhes do resultado do teste ms.vss-test-web.test-result-details-tab-items Captura de tela de uma guia personalizada nos 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 gerenciador de definição de versão.
Visualização de detalhes do pipeline, botão de cabeçalho ms.vss-build-web.pipelines-header-menu Captura de tela de um botão de cabeçalho na exibição de detalhes do pipeline.
Visualização de detalhes do pipeline, menu de contexto da pasta ms.vss-build-web.pipelines-folder-menu Captura de tela de um menu de contexto de pasta na exibição de detalhes do pipeline.

Tarefas do Azure Pipelines

As tarefas executam o trabalho em um pipeline de build ou lançamento. 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 do menu de grade do item de origem.
Menu de item de origem (árvore) ms.vss-code-web.source-tree-item-menu Captura de tela do menu árvore do item de origem.
Menu de item de origem (grade e árvore) ms.vss-code-web.source-item-menu Captura de tela do menu combinado do item de origem.
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 do menu de árvore de branches do Git.
Menu de ações de solicitação de pull do Git ms.vss-code-web.pull-request-action-menu Captura de tela do menu 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 de uma guia personalizada em uma 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 lista de confirmação 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 de confirmação 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 de 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 menu de contexto de 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 de uma guia dinâmica personalizada no hub de plano de teste.

Outros pontos de extensibilidade

  • Last updated on