Partilhar via

Pontos de extensibilidade

Serviços de DevOps do Azure | 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 extensibilidade mais comuns que você pode direcionar e mostra as IDs usadas 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.

Sugestão

Se você estiver iniciando uma nova extensão do Azure DevOps, experimente essas coleções de exemplo mantidas primeiro — elas funcionam com compilações 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 e as versões de API do manifesto de extensão com os documentos atuais. Para referência e APIs, consulte:

Hubs e grupos de hubs

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

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

Nome ID Nível Imagem de pré-visualização
Azure Boards ms.vss-work-web.work-hub-group Projeto/equipa Captura de ecrã do hub de trabalho personalizado adicionado aos Painéis do Azure.
Azure Repos ms.vss-code-web.code-hub-group Projeto/equipa Captura de ecrã do hub de trabalho personalizado adicionado aos repositórios do Azure.
Azure Pipelines (Pipelines do Azure) ms.vss-build-web.build-release-hub-group Projeto/equipa Captura de ecrã do hub personalizado adicionado aos Pipelines do Azure.
Planos de Teste do Azure ms.vss-test-web.test-hub-group Projeto/equipa Captura de ecrã do hub personalizado adicionado aos Planos de Teste do Azure.
Definições do projeto ms.vss-web.project-admin-hub-group Projeto Captura de tela do hub de administração do projeto personalizado.
Definições da organização ms.vss-web.collection-admin-hub-group Organização/recolha Captura de tela do hub de administração da organização personalizada.

Adicionar um hub

Este exemplo mostra uma contribuição de hub destinada ao grupo de hub 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 pela ms editora define este tipo. Este tipo define as propriedades opcionais e obrigatórias para contribuições deste tipo (por exemplo, nome, ordem).
  • ms.vss-code-web.code-hub-group é a ID completa da contribuição do grupo de hub a que este hub se destina. A extensão vss-code-web publicada pelo editor ms indica esta 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 possa referenciá-lo diretamente pelo nome.

Recomendamos que forneça o 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 e propriedades icon e iconName não suportam contribuições de tabulação. Só funcionam para hubs, menus e barras de ferramentas.

Configurações para menus e barras de ferramentas

Nome Identificação de destino
Barra de ferramentas de visão geral da organização/coleção ms.vss-admin-web.collection-overview-toolbar-menu
Grelha de projetos na 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
Grelha das equipas para a visão geral do projeto ms.vss-admin-web.teams-grid-menu

Menu e barra de ferramentas Azure Boards

Nome Identificação de destino Imagem de pré-visualização
Menu de pesquisa de itens de trabalho ms.vss-work-web.work-item-query-menu Captura de ecrã 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 ecrã da ação do menu personalizado da barra de ferramentas Resultados da Consulta.
Item de menu de resultados da consulta de item de trabalho ms.vss-work-web.query-result-work-item-menu Captura de ecrã da ação personalizada do Menu de Itens de Resultados da Consulta.
Guia Resultados da consulta de item de trabalho ms.vss-work-web.query-tabs Captura de ecrã do separador dinâmico personalizado da barra de ferramentas Consulta.
Item de trabalho para o menu de contexto ms.vss-work-web.work-item-toolbar-menu Captura de ecrã das ações da barra de ferramentas do item de trabalho personalizado.
Menu de itens da lista de pendências ms.vss-work-web.backlog-item-menu Captura de tela das opções do menu personalizado de ações do item de lista de pendências.
Menu de filtro pivô da placa de sprint ms.vss-work-web.sprint-board-pivot-filter-menu Captura de ecrã do menu de filtro dinâmico da placa de sprint.
Menu de filtro pivô da placa ms.vss-work-web.backlog-board-pivot-filter-menu Captura de tela das ações do filtro pivô da placa de lista 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 ecrã do separador personalizado Backlog do produto.
Aba de pendências de iteração ms.vss-work-web.iteration-backlog-tabs Captura de ecrã do separador personalizado do backlog de iterações.
Painel de lista de pendências do portfólio ms.vss-work-web.portfolio-backlog-toolpane Captura de ecrã 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 ecrã do Painel Personalizado da Lista de pendências do produto.
Painel de lista de pendências de iteração ms.vss-work-web.iteration-backlog-toolpane Captura de ecrã do Painel Personalizado do Backlog de Iteração.

Menu e barra de ferramentas do Azure Pipelines

Nome Identificação de destino Pré-visualização
Menu de compilação concluída ms.vss-build-web.completed-build-menu Captura de tela de ações de compilação concluídas.
Ação na barra de ferramentas dos resultados de teste ms.vss-test-web.test-results-actions-menu Captura de ecrã da ação da barra de ferramentas dos resultados do teste.
Aba de detalhes do resultado do teste ms.vss-test-web.test-result-details-tab-items Captura de ecrã do separador de detalhes do resultado do teste.
Liberar menu de contexto do explorador de pipeline ms.vss-releaseManagement-web.release-definition-explorer-context-menu Captura de ecrã do menu de contexto do explorador de definições.
Visualização de detalhes do pipeline, botão no cabeçalho ms.vss-build-web.pipelines-header-menu Captura de tela da exibição de detalhes do pipeline, menu de cabeçalho.
Vista 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 Identificação de destino Imagem de pré-visualização
Menu do item de origem (grade) ms.vss-code-web.source-grid-item-menu Captura de tela das ações da grade de itens de repositório.
Menu do item de origem (árvore) ms.vss-code-web.source-tree-item-menu Captura de tela das ações da árvore de itens de repositório.
Menu do item de fonte (grelha e árvore) ms.vss-code-web.source-item-menu Captura de tela das ações do item de repositório.
Alterar menu do item da lista ms.vss-code-web.change-list-item-menu
Alterar menu do item de resumo da lista ms.vss-code-web.change-list-summary-item-menu
Menu da árvore de branches do Git ms.vss-code-web.git-branches-tree-menu Captura de tela da árvore de galhos do git.
Menu de ações de pull request do Git ms.vss-code-web.pull-request-action-menu Captura de tela das ações de solicitação de pull do git.
Abas de Pull Request do Git (pivôs) ms.vss-code-web.pr-tabs Captura de tela da guia git pull request.
Menu de listagem de commits do Git ms.vss-code-web.git-commit-list-menu Captura de tela do menu da 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 do git commit.

Menu e barra de ferramentas Planos de Teste do Azure

Nome Identificação de destino Imagem de pré-visualização
Menu de grelha 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 pacotes de planos de teste ms.vss-test-web.test-plans-suites-context Captura de tela do contexto dos pacotes de planos de teste.
Aba central do hub do plano de teste ms.vss-test-web.test-plan-pivot-tabs Captura de ecrã do separador dinâmico do hub de teste.

Outros pontos de extensibilidade

  • Widget de dashboard: Uma extensão pode contribuir com um novo tipo de widget que os utilizadores podem adicionar a um dashboard. Saiba como contribuir com um widget de painel.
  • Formulário do item de trabalho: As extensões melhoram o formulário do item de trabalho com novas secções, separadores, ações e renderizadores de campos personalizados. Para obter mais informações, saiba como estender o formulário de item de trabalho.
  • Service Hooks: Um consumidor é o serviço para o qual o Service Hooks envia eventos. Uma extensão pode contribuir com serviços ao consumidor. Um utilizador (ou programaticamente) configura estes 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