Partilhar via

Consumidores de hooks de serviço

  • Artigo

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

Use consumidores de gancho de serviço para criar uma assinatura de forma programática. A assinatura especifica o evento, o consumidor e a ação.

Selecione o consumidor que pretende utilizar na sua subscrição de entre os seguintes consumidores. Para obter mais informações sobre os serviços disponíveis, consulte Integrar com ganchos de serviço, Serviços disponíveis.

Azure Service Bus

Fornece integração com o Barramento de Serviço do Microsoft Azure, incluindo Hubs de Notificação.

Enviar uma mensagem para um Hub de Notificação

Esta ação envia uma notificação de modelo genérica para o Hub de Notificação do Azure especificado. Para obter mais informações, consulte a visão geral.

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusNotificationHubSend
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • connectionString
      • Cadeia de conexão SAS
      • A cadeia de conexão SAS (assinatura de acesso compartilhado) a ser usada para se conectar ao Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: string
      • Obrigatório: Sim
    • notificationHubName
      • Nome do Hub de Notificações
      • O nome do hub de notificação para o qual enviar a notificação. O nome pode conter apenas letras, números, pontos, hífenes, barras e sublinhados. O nome deve começar e terminar com uma letra ou número. O hub já deveria existir.
      • Tipo de dados: string
      • Obrigatório: Sim
    • tagsExpressão
      • Etiquetas
      • A expressão de tags (para segmentar conjuntos específicos de dispositivos). Mais informações.
      • Tipo de dados: string
      • Obrigatório: Não

Enviar uma mensagem para uma fila do Service Bus

Esta ação envia uma representação de cadeia de caracteres JSON do evento para a fila especificada do Barramento de Serviço do Azure. Para obter mais informações, consulte Filas, artigos e assinaturas do Service Bus.

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusQueueSend
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • connectionString
      • Cadeia de conexão SAS
      • A cadeia de conexão SAS (assinatura de acesso compartilhado) a ser usada para se conectar ao Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: string
      • Obrigatório: Sim
    • queueName
      • Nome da fila
      • O nome da fila para a qual enviar a mensagem. O nome pode conter apenas letras, números, pontos, hífenes, barras e sublinhados. O nome deve começar e terminar com uma letra ou número. Se a fila não existir, ela será criada se a cadeia de conexão especificada tiver as permissões necessárias.
      • Tipo de dados: string
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a enviar
      • Controlar os campos de recursos a serem enviados
      • Tipo de dados: string
      • Obrigatório: Não
    • mensagensparaEnviar
      • Mensagens a enviar
      • Controlar as mensagens a enviar
      • Tipo de dados: string
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a enviar
      • Controlar as mensagens detalhadas a enviar
      • Tipo de dados: string
      • Obrigatório: Não

Enviar uma mensagem para um tópico do Service Bus

Esta ação envia uma representação de cadeia de caracteres JSON do evento para o tópico especificado do Barramento de Serviço do Azure. Para obter mais informações, consulte Usar o portal do Azure para criar um tópico do Service Bus e assinaturas para o tópico.

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusTopicSend
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • connectionString
      • Cadeia de conexão SAS
      • A cadeia de conexão SAS (assinatura de acesso compartilhado) a ser usada para se conectar ao Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: string
      • Obrigatório: Sim
    • nome_tópico
      • Nome do tópico
      • O nome do tópico para o qual enviar a mensagem. O nome pode conter apenas letras, números, pontos, hífenes, barras e sublinhados. O nome deve começar e terminar com uma letra ou número. Se o tópico não existir, ele será criado se a cadeia de conexão especificada tiver as permissões necessárias.
      • Tipo de dados: string
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a enviar
      • Controlar os campos de recursos a serem enviados
      • Tipo de dados: string
      • Obrigatório: Não
    • mensagensparaEnviar
      • Mensagens a enviar
      • Controlar as mensagens a enviar
      • Tipo de dados: string
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a enviar
      • Controlar as mensagens detalhadas a enviar
      • Tipo de dados: string
      • Obrigatório: Não

Armazenamento do Azure

Fornece integração com o Armazenamento do Microsoft Azure.

Inserir uma mensagem em uma fila de armazenamento

Esta ação insere uma representação de cadeia de caracteres JSON do evento na fila de armazenamento do Azure especificada. Para obter mais informações, consulte O que são filas do Azure?.

  • ID do consumidor: azureStorageQueue
  • ID da ação: enqueue
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • nomedaconta;
      • Nome da conta de armazenamento
      • O nome associado à sua conta de armazenamento do Azure (por exemplo, https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Tipo de dados: string
      • Obrigatório: Sim
    • accountKey
      • Chave da conta de armazenamento
      • A chave associada à sua conta de armazenamento do Azure.
      • Tipo de dados: string
      • Obrigatório: Sim
    • queueName
      • Nome da fila
      • O nome somente minúsculo da fila a ser usada no armazenamento do Azure. Uma fila com esse nome é criada se ainda não existir.
      • Tipo de dados: string
      • Obrigatório: Sim
    • visiTimeout
      • Tempo limite de visibilidade da mensagem (em segundos)
      • Especifica o valor de tempo limite de visibilidade, em segundos, para a mensagem enfileirada, em relação ao tempo do servidor. O valor deve ser maior ou igual a 0 e não pode ser maior que sete dias ou 604.800 segundos. O tempo limite de visibilidade deve ser definido como um valor menor do que o valor de tempo de vida útil da mensagem.
      • Tipo de dados: número
      • Obrigatório: Sim
    • TTL
      • Tempo de vida da mensagem (em segundos)
      • Especifica o intervalo de tempo de vida para a mensagem de fila, em segundos. O tempo máximo de vida permitido é de sete dias, ou 604.800 segundos.
      • Tipo de dados: número
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a enviar
      • Controlar os campos de recursos a serem enviados
      • Tipo de dados: string
      • Obrigatório: Não
    • mensagensparaEnviar
      • Mensagens a enviar
      • Controlar as mensagens a enviar
      • Tipo de dados: string
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a enviar
      • Controlar as mensagens detalhadas a enviar
      • Tipo de dados: string
      • Obrigatório: Não

Jenkins

Jenkins é um servidor de integração contínua, que permite construir e testar projetos de software continuamente.

Acionar a compilação do Git

Aciona uma compilação configurada para usar um repositório Git usando o plug-in Jenkins Git.

  • ID do consumidor: jenkins
  • ID da ação: triggerGitBuild
  • Eventos suportados: git.push
  • Configurações:
    • serverBaseUrl
      • Jenkins base URL
      • A URL base que hospeda o servidor Jenkins
      • Tipo de dados: uri
      • Obrigatório: Sim
    • nome de utilizador
      • User name
      • O nome de usuário Jenkins de um usuário que tem permissão para disparar a compilação
      • Tipo de dados: string
      • Obrigatório: Sim
    • palavra-passe
      • Token de API do usuário (ou senha)
      • O token de API do usuário, que está disponível na página de configuração do usuário Jenkins. O token da API é novo desde a versão 1.426. Para versões anteriores do Jenkins, a senha de usuário real deve ser especificada.
      • Tipo de dados: string
      • Obrigatório: Sim

Acionar compilação genérica

Aciona uma compilação genérica do Jenkins, invocando a URL de compilação do Jenkins.

  • ID do consumidor: jenkins
  • ID da ação: triggerGenericBuild
  • Eventos suportados: git.push, build.complete, tfvc.checkin
  • Configurações:
    • serverBaseUrl
      • Jenkins base URL
      • A URL base que hospeda o servidor Jenkins
      • Tipo de dados: uri
      • Obrigatório: Sim
    • nome de utilizador
      • User name
      • O nome de usuário Jenkins de um usuário que tem permissão para disparar a compilação
      • Tipo de dados: string
      • Obrigatório: Sim
    • palavra-passe
      • Token de API do usuário (ou senha)
      • O token de API do usuário, que está disponível na página de configuração do usuário Jenkins. O token da API é novo desde a versão 1.426. Para versões anteriores do Jenkins, a senha de usuário real deve ser especificada.
      • Tipo de dados: string
      • Obrigatório: Sim
    • buildName [en]
      • Compilar
      • O nome da compilação a ser acionado
      • Tipo de dados: string
      • Obrigatório: Sim
    • buildAuthToken
      • Token de construção
      • O token de autorização na forma de uma cadeia de caracteres para que apenas os usuários que o conhecem possam acionar remotamente as compilações deste projeto
      • Tipo de dados: string
      • Obrigatório: Não
    • buildParametrizado
      • Aceita parâmetros
      • Indica se a compilação é parametrizada ou não (os parâmetros de compilação são opcionalmente especificados anteriormente)
      • Tipo de dados: booleano
      • Obrigatório: Não
    • buildParams
      • Parâmetros de construção
      • Crie parâmetros, nomes e valores separados por dois pontos (por exemplo, "param1:value1") com cada par nome-valor aparecendo em sua própria linha de texto
      • Tipo de dados: string
      • Obrigatório: Não

Trello

Fornece integração com o Trello.

Criar um cartão

Esta ação cria um cartão em uma lista existente no Trello. Um cartão pode representar uma tarefa, um problema, um evento ou praticamente qualquer coisa. O estado de um cartão é normalmente determinado pela lista em que se encontra. Para obter mais informações, consulte Criar um gancho de serviço com o Trello.

  • ID do consumidor: trello
  • ID da ação: createCard
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • userToken
      • Token de usuário (Precisa de um? Obtenha-o agora.)
      • Seu token de usuário fornecido pelo Trello. Para saber como obter esse token, selecione o link na descrição da ação descrita anteriormente.
      • Tipo de dados: string
      • Obrigatório: Sim
    • boardId
      • Placa
      • O nome da placa na qual o cartão Trello é criado.
      • Tipo de dados: string
      • Obrigatório: Sim
    • listId
      • Listagem
      • O nome da lista na qual o cartão do Trello é criado.
      • Tipo de dados: string
      • Obrigatório: Sim
    • rótulos
      • Etiquetas
      • Uma lista separada por vírgulas de cores de rótulo para aplicar ao cartão criado. Os nomes de cores de rótulos válidos são vermelho, laranja, amarelo, verde, azul e roxo.
      • Tipo de dados: string
      • Obrigatório: Não
    • addToTop
      • Criar no início da lista
      • Indica se o cartão deve ser criado no início da lista do Trello, em vez do final.
      • Tipo de dados: booleano
      • Obrigatório: Não

Criar uma lista

Esta ação cria uma lista em um quadro existente no Trello. Uma lista é usada para organizar cartões em um quadro e normalmente representa um estado. Para obter mais informações, consulte Criar um gancho de serviço com o Trello.

  • ID do consumidor: trello
  • ID da ação: createList
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • userToken
      • Token de usuário (precisa de um? Obtenha-o agora.)
      • Seu token de usuário fornecido pelo Trello. Para saber como obter esse token, selecione o link na descrição da ação descrita anteriormente.
      • Tipo de dados: string
      • Obrigatório: Sim
    • boardId
      • Placa
      • O nome do quadro no qual a lista do Trello é criada.
      • Tipo de dados: string
      • Obrigatório: Sim
    • addToBottom
      • Criar na parte inferior do quadro
      • Indica se a lista deve ser criada na parte inferior do quadro, em vez da parte superior.
      • Tipo de dados: booleano
      • Obrigatório: Não

Webhooks

Webhooks fornecem comunicação de eventos via HTTP.

Postar via HTTP

Esta ação publica uma representação de objeto JSON do evento na URL especificada. Os pontos de extremidade HTTPS são recomendados devido ao potencial de dados privados na carga útil do evento. Para obter mais informações, consulte Webhooks.

  • ID do consumidor: webHooks
  • ID da ação: httpRequest
  • Eventos suportados: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • URL
      • URL
      • A URL para a qual um HTTP POST é enviado.
      • Tipo de dados: uri
      • Obrigatório: Sim
    • Cabeçalhos http
      • Cabeçalhos de HTTP
      • Chaves de cabeçalho HTTP e valores separados por dois pontos (por exemplo, "Key1:value1") com cada par chave-valor-aparecendo em sua própria linha de texto.
      • Tipo de dados: string
      • Obrigatório: Não
    • basicAuthUsername
      • Nome de usuário de autenticação básica
      • Insira um nome de usuário para autenticação HTTP padrão. A autenticação HTTP básica envia credenciais em texto simples (não criptografado), o que significa que você deve usar uma URL que comece com "https" para habilitar a criptografia dessas credenciais por meio da camada de transporte seguro (SSL).
      • Tipo de dados: string
      • Obrigatório: Não
    • basicAuthPassword
      • Palavra-passe de autenticação básica
      • Insira uma senha para autenticação HTTP padrão. A autenticação HTTP básica envia credenciais em texto simples (não criptografado), o que significa que você deve usar uma URL que comece com "https" para habilitar a criptografia dessas credenciais via SSL.
      • Tipo de dados: string
      • Obrigatório: Não
    • resourceDetailsToSend
      • Detalhes do recurso a enviar
      • Controlar os campos de recursos a serem enviados
      • Tipo de dados: string
      • Obrigatório: Não
    • mensagensparaEnviar
      • Mensagens a enviar
      • Controlar as mensagens a enviar
      • Tipo de dados: string
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a enviar
      • Controlar as mensagens detalhadas a enviar
      • Tipo de dados: string
      • Obrigatório: Não

Zendesk

O Zendesk é um pacote SaaS que oferece emissão de tíquetes de help desk, rastreamento de problemas e suporte ao atendimento ao cliente.

Criar um comentário privado em um ticket

Use o Zendesk para criar um comentário privado em um ticket.

  • ID do consumidor: zendesk
  • ID da ação: createPrivateComment
  • Eventos suportados: workitem.commented
  • Configurações:
    • nomedaconta;
      • Nome da conta
      • Nome da conta Zendesk como https://{account name}.zendesk.com
      • Tipo de dados: string
      • Obrigatório: Sim
    • nome de utilizador
      • User name
      • O nome de usuário do Zendesk de um usuário que atualiza tíquetes
      • Tipo de dados: string
      • Obrigatório: Sim
    • apiToken
      • Token de API
      • O token da API do Zendesk (pode ser encontrado no aplicativo Zendesk na API de Canais de Administração > > )
      • Tipo de dados: string
      • Obrigatório: Sim