Integração com ganchos de serviço

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

Os Ganchos de Serviço permitem executar tarefas em outros serviços quando eventos acontecem em seu projeto no Azure DevOps.

Por exemplo, você pode criar um cartão no Trello quando um item de trabalho é criado ou enviar uma notificação por push para os dispositivos móveis da sua equipe quando uma compilação falha. Você também pode usar ganchos de serviço em aplicativos e serviços personalizados como uma maneira mais eficiente de conduzir atividades quando eventos acontecem em seus projetos.

Como funcionam os ganchos de serviço?

Os editores de gancho de serviço definem um conjunto de eventos que você pode assinar. As subscrições ouvem estes eventos e definem as ações a tomar com base no evento.

As subscrições também se destinam aos 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 ganchos de serviço exigem a permissão de intervalos de IP para conexão de entrada com pontos de extremidade de serviço. O ponto de extremidade de serviço é o conjunto de propriedades fornecidas a um gancho de serviço. Para obter mais informações, consulte Listas de endereços permitidos e conexões de rede, endereços IP e restrições de intervalo.

Serviços disponíveis

Os seguintes serviços estão disponíveis como destino de ganchos de serviço. Para obter mais informações sobre outros aplicativos e serviços que se integram ao Azure DevOps, vá para o Visual Studio Marketplace.

Serviço Eventos suportados Ações suportadas
Central de aplicativos Item de trabalho atualizado Enviar notificação. As subscrições são geridas através do App Center.
AppVeyor Código empurrado Acione uma compilação do AppVeyor. As subscrições são geridas através do AppVeyor.
Azuqua Todos Postar evento para FLO. As subscrições são geridas através da Azuqua.
Serviço de Aplicações do Azure Código empurrado Implante o aplicativo Web. As subscrições são geridas através do Serviço de Aplicações do Azure.
Azure Service Bus Todos Envie uma mensagem para um Hub de Notificação, Fila do Service Bus ou Tópico do Service Bus. A subscrição é gerida através do Serviço de Aplicações do Azure.
Armazenamento do Azure Todos Insira uma mensagem em uma fila de armazenamento.
Bambu Compilação concluída, código enviado Enfileire uma compilação.
Datadog Todos Publique um evento no Datadog.
Grafana Implantação da versão concluída Adicione anotação ao banco de dados Grafana.
Jenkins Compilação concluída, código enviado, tentativa de mesclagem PR, implantação de liberação concluída Acione a compilação genérica ou Git.
Microsoft Teams Todos Publique uma mensagem em um canal. As subscrições são geridas no Microsoft Teams.
MyGet Compilação concluída, código enviado por push Publique o pacote NuGet no MyGet. Acione uma compilação MyGet. As subscrições são geridas pelo MyGet.
Office 365 Todos Publique uma mensagem em um grupo.
Slack Todos Publique uma mensagem em um canal.
Trello Todos Crie um cartão ou uma lista.
UserVoice Item de trabalho criado, item de trabalho atualizado Enviar evento de item de trabalho vinculado. As subscrições são geridas através do UserVoice.
Ganchos da Web Todos Postar via HTTP.
Aplicativos de mensagens do Workplace Todos Enviar notificações. As subscrições são geridas através das Aplicações de Mensagens do Workplace.
Zapier Todos Enviar notificação. As subscrições são geridas através do Zapier.
Zendesk Item de trabalho comentado Crie um comentário privado em um ticket.
Serviço Eventos suportados Ações suportadas
Azure Service Bus Todos Envie uma mensagem para um Hub de Notificação, Fila do Service Bus ou Tópico do Service Bus. A subscrição é gerida através do Serviço de Aplicações do Azure.
Armazenamento do Azure Todos Insira uma mensagem em uma fila de armazenamento.
Bambu Compilação concluída, código enviado Enfileire uma compilação.
Datadog Todos Publique um evento no Datadog.
Grafana Implantação da versão concluída Adicione anotação ao banco de dados Grafana.
Jenkins Compilação concluída, código enviado, tentativa de mesclagem PR, implantação de liberação concluída Acione a compilação genérica ou Git.
Microsoft Teams Todos Publique uma mensagem em um canal. As subscrições são geridas no Microsoft Teams.
Office 365 Todos Publique uma mensagem em um grupo.
Slack Todos Publique uma mensagem em um canal.
Trello Todos Crie um cartão ou uma lista.
[UserVoice] ((https://www.uservoice.com) Item de trabalho criado, item de trabalho atualizado Enviar evento de item de trabalho vinculado. As subscrições são geridas através do UserVoice.
Ganchos da Web Todos Postar via HTTP.
Zendesk Item de trabalho comentado Crie um comentário privado em um ticket.

Criar uma subscrição

Ao integrar um desses serviços ao Azure DevOps, você deve criar uma nova assinatura. Em muitos casos, você também precisa fazer alguma configuração no outro serviço. Para obter detalhes específicos, consulte as informações do serviço em que está interessado.

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

    Captura de ecrã do botão Definições do projeto realçado.
  2. Execute o assistente para criar a assinatura.

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

  3. Selecione o serviço com o qual deseja integrar.

    Selecione o serviço a integrar

  4. Selecione o evento a ser acionado e os filtros aplicáveis.

    Selecione o evento a ser acionado e quaisquer filtros

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

    Nota

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

    Captura de tela mostrando a seleção de uma ação para o serviço de destino.

  6. Para confirmar se as configurações estão corretas, teste a assinatura e conclua o assistente.

    Captura de tela mostrando a notificação de teste 1.

    Captura de tela mostrando a notificação de teste 2.

FAQs

P: De que permissões necessito 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.

Para conceder permissão de exibição para um grupo, consulte Definir permissão de exibição para um grupo na página Ganchos de serviço.

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 usuário com essas permissões pode ver todas as assinaturas criadas no projeto e o histórico de notificações dessas assinaturas. Esse usuário pode criar qualquer tipo de assinatura de gancho de serviço nesse projeto. Se o usuário configurar uma assinatura para um recurso que, de outra forma, não tem permissão para acessar, a assinatura não será acionada.

Por exemplo: as assinaturas criadas para eventos de atualização de item de trabalho no caminho de área XYZ não enviarão notificações se você não tiver acesso a esses itens de trabalho. No entanto, você pode ver o histórico de notificações de outros usuários que têm acesso a esses itens de trabalho.

P: Posso criar assinaturas de gancho de serviço para um projeto programaticamente?

R: Sim. Para obter mais informações, consulte Criar uma assinatura de ganchos de serviço.

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

R: Sim. Você pode revogar autorizações do seu perfil.

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

    Certifique-se de iniciar 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. Gerencie suas autorizações.

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

  3. Revogue todas as autorizações que você não deseja mais permitir.

    Captura de tela mostrando a opção Revogar para autorizações.

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

R: A Atlassian oficialmente abandonou o suporte para o HipChat. Para mais informações, consulte o anúncio.