Integrar com ganchos de serviço

Serviços do Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018

Os hooks de serviço permitem-lhe executar tarefas noutros serviços quando ocorrem eventos no projeto no Azure DevOps.

Por exemplo, pode criar um cartão no Trello quando um item de trabalho é criado ou enviar uma notificação push para os dispositivos móveis da sua equipa quando uma compilação falha. Também pode utilizar os service hooks em aplicações e serviços personalizados como uma forma mais eficiente de impulsionar atividades quando ocorrem eventos nos seus projetos.

Como funcionam os ganchos de serviço?

Os fabricantes de service hook definem um conjunto de eventos aos quais pode subscrever. As subscrições escutam estes eventos e definem as ações a tomar com base no evento.

As subscrições também visam os consumidores, que são serviços externos que podem executar as suas próprias ações quando ocorrem eventos.

Diagrama de ganchos de serviço.

Nota

Os hooks de serviço necessitam de permitir intervalos DE IP para ligação de entrada a pontos finais de serviço. O ponto final de serviço é o conjunto de propriedades fornecidas a um service hook. Para obter mais informações, veja Listas de endereços permitidas e ligações de rede, endereços IP e restrições de intervalo.

Serviços disponíveis

Os seguintes serviços estão disponíveis como o destino dos ganchos de serviço. Para obter mais informações sobre outras aplicações e serviços que se integram no Azure DevOps, aceda ao Visual Studio Marketplace.

Serviço Eventos suportados Ações suportadas
App Center Item de trabalho atualizado Enviar notificação
AppVeyor Código emitido Acionar uma compilação do AppVeyor
Azuqua Todos Publicar evento no FLO
Serviço de Aplicações do Azure Código emitido Implementar aplicação Web
Azure Service Bus Todos Enviar uma mensagem para um Hub de Notificação, Fila do Service Bus ou Tópico do Service Bus
Armazenamento do Azure Todos Inserir uma mensagem numa Fila de Armazenamento
Bambu Compilação concluída, Código emitido Colocar uma compilação em fila
Campfire Todos Publicar uma mensagem numa sala
Datadog Todos Publicar um evento no Datadog
Grafana Implementação da versão concluída Adicionar anotação à base de dados do Grafana
HipChat (Já não é suportado)
HockeyApp Item de trabalho atualizado Enviar notificação
Jenkins Compilação concluída, código emitido, intercalação pr tentada, implementação de versão concluída Acionar compilação genérica ou git
Equipas da Microsoft Todos Publicar uma mensagem num canal
MyGet Compilação concluída, código emitido Publicar o pacote NuGet no MyGet, acionar uma compilação MyGet
Office 365 Todos Publicar uma mensagem num grupo
Slack Todos Publicar uma mensagem num canal
Trello Todos Criar um cartão ou lista
UserVoice Item de trabalho criado ou atualizado Enviar evento de item de trabalho ligado
Web Hooks Todos Publicar através de HTTP
Aplicações de Mensagens do Local de Trabalho Todos Enviar notificações
Zapier Todos Enviar notificação
Zendesk Item de trabalho comentado em Criar um comentário privado num pedido

Criar uma subscrição

Quando integra um destes serviços no Azure DevOps, tem de criar uma nova subscrição. Em muitos casos, também tem de fazer algum trabalho no outro serviço. Para obter detalhes específicos, consulte as informações sobre o serviço no qual está interessado.

  1. Abra a página de administrador de um projeto no acesso à Web.

    Captura de ecrã a mostrar o botão Definições do Projeto realçadas.
  2. Execute o assistente para criar a subscrição.

    Captura de ecrã do botão realçado, Criar subscrição.

  3. Selecione o serviço ao qual pretende integrar.

    Selecione o serviço a integrar

  4. Selecione o evento acionar e quaisquer filtros aplicáveis.

    Selecione o evento a acionar e quaisquer filtros

  5. Selecione uma ação a executar no serviço de destino.

    Nota

    A lista de ações disponíveis pode ser limitada com base no tipo de evento que selecionou.

    Captura de ecrã a mostrar a seleção de uma ação para o serviço de destino.

  6. Para confirmar que as definições estão corretas, teste a subscrição e, em seguida, conclua o assistente.

    Captura de ecrã a mostrar a notificação de teste 1.

    Captura de ecrã a mostrar a notificação de teste 2.

  1. Abra a página de administração de um projeto no acesso à Web.

    Captura de ecrã a mostrar a página de administrador.

  2. Crie uma subscrição ao executar o assistente.

    Captura de ecrã da caixa realçada, Criar subscrição, para selecionar para executar o assistente de subscrição.

  3. Selecione o serviço no qual pretende integrar.

    Captura de ecrã a mostrar a seleção de serviços a integrar.

  4. Selecione o evento a acionar e quaisquer filtros (se aplicável).

    Captura de ecrã a mostrar a seleção do evento a ser acionado.

  5. Selecione uma ação a executar no serviço de destino.

    Nota

    A lista de ações disponíveis pode ser limitada com base no tipo de evento que selecionou.

    Captura de ecrã a mostrar a ação selecionada a executar no serviço de destino.

  6. Para confirmar que as definições estão corretas, teste a subscrição e, em seguida, conclua o assistente.

    Captura de ecrã a mostrar a notificação de teste 1.

    Captura de ecrã a mostrar a notificação de teste 2.

FAQs

P: De que permissões preciso para configurar uma subscrição?

R: Editar subscrições e Ver subscrições. Por predefinição, apenas os administradores de projetos têm estas permissões. Para as conceder diretamente a outros utilizadores, pode utilizar a ferramenta de linha de comandos ou a API REST de Segurança.

P: Quais são as implicações de segurança da concessão de permissões Editar subscrições e Ver subscrições ?

R: O utilizador com estas permissões pode ver todas as subscrições criadas no projeto e o histórico de notificações dessas subscrições. Em seguida, esse utilizador pode criar qualquer tipo de subscrição de service hook nesse projeto. Se o utilizador configurar uma subscrição para um recurso ao qual de outra forma não tem permissão para aceder, a subscrição não será acionada.

Por exemplo: Se não tiver acesso a itens de trabalho no caminho da área XYZ e configurar uma subscrição para os eventos de atualização de itens de trabalho, não receberá notificações de atualizações para itens de trabalho no caminho da área XYZ. No entanto, se outro utilizador, que tem acesso aos itens de trabalho no caminho da área XYZ, receber esses eventos de "atualização do item de trabalho", poderá ver o histórico de notificações dos eventos do outro utilizador, que inclui dados de itens de trabalho aos quais de outra forma não tem acesso.

P: Posso criar subscrições de service hook para um projeto programaticamente?

R: Sim. Para obter mais informações, veja Criar uma subscrição de hooks de serviço.

P: Posso remover o acesso de uma aplicação à minha organização depois de a autorizar?

R: Sim. Pode revogar autorizações do seu perfil.

  1. Aceda à sua página de perfil a partir de https://visualstudio.microsoft.com/.

    Certifique-se de que começa a partir do site do Visual Studio (https://visualstudio.microsoft.com/) em vez da sua organização (https://dev.azure.com/{orgName}) porque o seu perfil acedido a partir da sua organização leva-o para a implementação errada da funcionalidade de gestão de autorizações.

  2. Faça a gestão das suas autorizações.

    Captura de ecrã a mostrar o botão Gerir aplicações realçado.

  3. Revogue quaisquer autorizações que já não pretenda permitir.

    Captura de ecrã a mostrar a opção Revogar para autorizações.

P: Por que não podemos configurar mais os hooks de serviço para o HipChat?

R: Atlassian oficialmente deixou cair o apoio ao HipChat. Veja mais sobre o anúncio aqui.