Compartilhar via

Consumidores de gancho de serviço

  • Artigo

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

Use os consumidores de gancho de serviço para criar programaticamente uma assinatura. A assinatura especifica o evento, o consumidor e a ação.

Selecione o consumidor que você deseja usar em sua assinatura dos consumidores a seguir. Para obter mais informações sobre os serviços disponíveis, consulte Integrar com ganchos de serviço, Serviços disponíveis.

Barramento de Serviço do Azure

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

Enviar uma mensagem para um Hub de Notificação

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

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusNotificationHubSend
  • Eventos com suporte: 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 com Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • notificationHubName
      • Nome do hub de notificação
      • O nome do hub de notificação para o qual enviar a notificação. O nome pode conter apenas letras, números, períodos, hifens, barras de avanço e sublinhados. O nome deve começar e terminar com uma letra ou um número. O hub já deve existir.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • tagsExpression
      • Marcações
      • A expressão de marcas (para direcionar conjuntos específicos de dispositivos). Saiba mais.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Enviar uma mensagem para uma fila do Barramento de Serviço

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

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusQueueSend
  • Eventos com suporte: 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 com Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: cadeia de caracteres
      • 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, períodos, hifens, barras de avanço e sublinhados. O nome deve começar e terminar com uma letra ou um 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: cadeia de caracteres
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a serem enviados
      • Controlar os campos de recurso a serem enviados
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • messagesToSend
      • Mensagens a serem enviadas
      • Controlar as mensagens a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a serem enviadas
      • Controlar as mensagens detalhadas a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Enviar uma mensagem para um tópico do Barramento de Serviço

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

  • ID do consumidor: azureServiceBus
  • ID da ação: serviceBusTopicSend
  • Eventos com suporte: 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 com Barramento de Serviço do Azure. Essa cadeia de conexão está disponível no portal do Azure.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • topicName
      • Nome do tópico
      • O nome do tópico para o qual enviar a mensagem. O nome pode conter apenas letras, números, períodos, hifens, barras de avanço e sublinhados. O nome deve começar e terminar com uma letra ou um 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: cadeia de caracteres
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a serem enviados
      • Controlar os campos de recurso a serem enviados
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • messagesToSend
      • Mensagens a serem enviadas
      • Controlar as mensagens a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a serem enviadas
      • Controlar as mensagens detalhadas a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Armazenamento do Azure

Fornece integração com Armazenamento do Microsoft Azure.

Inserir uma mensagem em uma fila de armazenamento

Essa 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: enfileirar
  • Eventos com suporte: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Configurações:
    • accountName
      • 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: cadeia de caracteres
      • Obrigatório: Sim
    • accountKey
      • Chave da conta de armazenamento
      • A chave associada à sua conta de armazenamento do Azure.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • queueName
      • Nome da fila
      • O nome somente em minúsculas da fila a ser usada no armazenamento do Azure. Uma fila com esse nome será criada se ainda não existir.
      • Tipo de dados: cadeia de caracteres
      • 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 que o valor de vida útil da mensagem.
      • Tipo de dados: número
      • Obrigatório: Sim
    • ttl
      • Vida útil da mensagem (em segundos)
      • Especifica o intervalo de vida útil da mensagem da fila, em segundos. O tempo de vida máximo permitido é de sete dias ou 604.800 segundos.
      • Tipo de dados: número
      • Obrigatório: Sim
    • resourceDetailsToSend
      • Detalhes do recurso a serem enviados
      • Controlar os campos de recurso a serem enviados
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • messagesToSend
      • Mensagens a serem enviadas
      • Controlar as mensagens a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a serem enviadas
      • Controlar as mensagens detalhadas a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Jenkins

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

Disparar build do Git

Dispara um build configurado para usar um repositório Git usando o Plug-in Git do Jenkins.

  • ID do consumidor: jenkins
  • ID da ação: triggerGitBuild
  • Eventos com suporte: git.push
  • Configurações:
    • serverBaseUrl
      • Jenkins base URL
      • A URL base que hospeda o servidor Jenkins
      • Tipo de dados: uri
      • Obrigatório: Sim
    • username
      • Nome de usuário
      • O nome de usuário jenkins de um usuário que tem permissão para disparar o build
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • password
      • 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 de usuário do Jenkins. O token de API é novo desde a versão 1.426. Para versões anteriores do Jenkins, a senha do usuário real deve ser especificada.
      • Tipo de dados: string
      • Obrigatório: Sim

Disparar build genérico

Dispara um build genérico do Jenkins, invocando a URL de build do Jenkins.

  • ID do consumidor: jenkins
  • ID da ação: triggerGenericBuild
  • Eventos com suporte: 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
    • username
      • Nome de usuário
      • O nome de usuário jenkins de um usuário que tem permissão para disparar o build
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • password
      • 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 de usuário do Jenkins. O token de API é novo desde a versão 1.426. Para versões anteriores do Jenkins, a senha do usuário real deve ser especificada.
      • Tipo de dados: string
      • Obrigatório: Sim
    • buildName
      • Build
      • O nome do build a ser disparado
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • buildAuthToken
      • Token de build
      • O token de autorização na forma de uma cadeia de caracteres para que apenas os usuários que o saibam possam disparar remotamente os builds deste projeto
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • buildParameterized
      • Aceita parâmetros
      • Indica se o build é parametrizado ou não (os parâmetros de build são, opcionalmente, especificados anteriormente)
      • Tipo de dados: booliano
      • Obrigatório: Não
    • buildParams
      • Parâmetros de build
      • Nomes e valores de parâmetros de build separados por dois-pontos (por exemplo, "param1:value1") com cada par nome-valor aparecendo em sua própria linha de texto
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Trello

Fornece integração com o Trello.

Criar um cartão

Essa 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. Normalmente, o estado de um cartão é determinado pela lista em que ele está. 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 com suporte: 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.)
      • O 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
      • Board
      • O nome do quadro no qual o cartão Trello é criado.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • listId
      • Lista
      • O nome da lista na qual o cartão Trello é criado.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Sim
    • rótulos
      • Rótulos
      • Uma lista separada por vírgulas de cores de rótulo a serem aplicadas ao cartão criado. Os nomes de cores de rótulo válidos são vermelho, laranja, amarelo, verde, azul e roxo.
      • Tipo de dados: cadeia de caracteres
      • 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: booliano
      • Obrigatório: Não

Cria uma lista

Essa 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 com suporte: 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.)
      • O 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
      • Board
      • O nome do quadro no qual a lista trello é criada.
      • Tipo de dados: cadeia de caracteres
      • 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: booliano
      • Obrigatório: Não

Webhooks

Os webhooks fornecem comunicação de evento via HTTP.

Postar via HTTP

Essa ação posta 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 no conteúdo do evento. Para obter mais informações, consulte Webhooks.

  • ID do consumidor: webHooks
  • ID da ação: httpRequest
  • Eventos com suporte: 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
    • httpHeaders
      • Cabeçalhos HTTP
      • Chaves de cabeçalho HTTP e valores separados por dois-pontos (por exemplo, "Key1:value1") com cada chave-valor-par aparecendo em sua própria linha de texto.
      • Tipo de dados: cadeia de caracteres
      • 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 sem formatação (não criptografado), o que significa que você deve usar uma URL começando com "https" para habilitar a criptografia dessas credenciais por meio da SSL (camada de transporte seguro).
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • basicAuthPassword
      • Senha de autenticação básica
      • Insira uma senha para autenticação HTTP padrão. A autenticação HTTP básica envia credenciais em texto sem formatação (não criptografado), o que significa que você deve usar uma URL começando com "https" para habilitar a criptografia dessas credenciais via SSL.
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • resourceDetailsToSend
      • Detalhes do recurso a serem enviados
      • Controlar os campos de recurso a serem enviados
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • messagesToSend
      • Mensagens a serem enviadas
      • Controlar as mensagens a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não
    • detailedMessagesToSend
      • Mensagens detalhadas a serem enviadas
      • Controlar as mensagens detalhadas a serem enviadas
      • Tipo de dados: cadeia de caracteres
      • Obrigatório: Não

Zendesk

O Zendesk é um pacote SaaS que oferece tíquetes de suporte técnico, acompanhamento de problemas e suporte ao atendimento ao cliente.

Criar um comentário privado em um tíquete

Use o Zendesk para criar um comentário privado em um tíquete.

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