Integrar com os ganchos de serviço

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Os ganchos de serviço permitem que você execute tarefas em outros serviços quando ocorrem eventos 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 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 impulsionar 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 assinaturas escutam esses eventos e definem ações a serem executadas com base no evento.

As assinaturas também se destinam aos consumidores, que são serviços externos que podem executar suas próprias ações quando ocorrem eventos.

Observação

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 serviços a seguir estão disponíveis como destino dos ganchos de serviço. Para obter mais informações sobre outros aplicativos e serviços que se integram ao Azure DevOps, acesse o Visual Studio Marketplace.

Serviço	Eventos compatíveis	Ações com suporte
App Center	Item de trabalho atualizado	Enviar notificação. As assinaturas são gerenciadas por meio do App Center.
AppVeyor	Código enviado por push	Acione uma compilação do AppVeyor. As assinaturas são gerenciadas por meio do AppVeyor.
Azuqua	Tudo	Pós-evento para FLO. As assinaturas são gerenciadas através do Azuqua.
Serviço de Aplicativo do Azure	Código enviado por push	Implantar aplicativo Web. As assinaturas são gerenciadas por meio do Serviço de Aplicativo do Azure.
Barramento de Serviço do Azure	Tudo	Envie uma mensagem para um Hub de Notificação, Fila do Barramento de Serviço ou Tópico do Barramento de Serviço. A assinatura é gerenciada por meio do Serviço de Aplicativo do Azure.
Armazenamento do Azure	Tudo	Insira uma mensagem em uma Fila de Armazenamento.
Bambu	Compilação concluída, código enviado	Enfileirar uma compilação.
Datadog	Tudo	Publique um evento no Datadog.
Grafana	Conclusão da implantação do lançamento	Adicione anotação ao banco de dados do Grafana.
Jenkins	Build concluído, código enviado, tentativa de mesclagem de PR, implantação de versão concluída	Dispare a compilação genérica ou do Git.
Equipes da Microsoft	Tudo	Postar uma mensagem em um canal. As assinaturas são gerenciadas no Microsoft Teams.
MyGet	Compilação concluída, código enviado	Publique o pacote NuGet no MyGet. Dispare uma compilação MyGet. As assinaturas são gerenciadas pelo MyGet.
Office 365	Tudo	Postar uma mensagem em um grupo.
Stack	Tudo	Postar uma mensagem em um canal.
Trello	Tudo	Crie um cartão ou lista.
UserVoice	Item de trabalho criado, item de trabalho atualizado	Enviar evento de item de trabalho vinculado. As assinaturas são gerenciadas por meio do UserVoice.
Web Hooks	Tudo	Postar via HTTP.
Aplicativos de mensagens no local de trabalho	Tudo	Enviar notificações. As assinaturas são gerenciadas por meio dos aplicativos de mensagens do Workplace.
Zapier	Tudo	Enviar notificação. As assinaturas são gerenciadas por meio do Zapier.
Zendesk	Item de trabalho comentado	Crie um comentário privado em um ticket.

Criar uma assinatura

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, confira as informações do serviço em que você está interessado.

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

   

2. Execute o assistente para criar a assinatura.

   

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

   

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

   

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

   Observação

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

   

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

   

   

Perguntas Frequentes

P: Quais permissões eu preciso para configurar uma assinatura?

R: Editar assinaturas e Exibir assinaturas. Por padrão, somente os administradores de projeto têm essas permissões. Para concedê-las diretamente a outros usuários, você pode usar a ferramenta de linha de comando ou a API REST de Segurança.

Para conceder permissão de visualização a um grupo, consulte Definir permissão de visualizaçã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 de edição de assinaturas e de exibição de assinaturas ?

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 ele não tem permissão para acessar, a assinatura não será disparada.

Por exemplo: As assinaturas que você cria 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?

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

P: Posso remover o acesso de um aplicativo à minha organização depois de autorizá-lo?

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

1. Vá para a página do seu perfil a partir de https://visualstudio.microsoft.com/.

   Certifique-se de começar no site do Visual Studio (https://visualstudio.microsoft.com/) em vez de sua organização (https://dev.azure.com/{orgName}) porque seu perfil acessado de sua organização leva você à implementação errada do recurso de gerenciamento de autorizações.

2. Gerencie suas autorizações.

   

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

   

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

R: A Atlassian abandonou oficialmente o suporte ao HipChat. Para obter mais informações, confira o comunicado.

Artigos relacionados

• Solucionar problemas de ganchos de serviço e perguntas frequentes
• Visual Studio Marketplace
• Informações de cobrança