Consumidores de enlace de servicio

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

Use consumidores de enlaces de servicio para crear una suscripción mediante programación. La suscripción especifica el evento, el consumidor y la acción.

Seleccione el consumidor que desea usar en la suscripción de los siguientes consumidores. Para obtener más información sobre los servicios disponibles, consulte Integración con enlaces de servicio, Servicios disponibles.

• Azure Service Bus
• Almacenamiento de Azure
• Campfire
• Jenkins
• Kato
• Trello
• Web Hooks
• Zendesk

Azure Service Bus

Proporciona integración con Microsoft Azure Service Bus, incluidos Notification Hubs.

Enviar un mensaje a un centro de notificaciones

Esta acción envía una notificación genérica de plantilla al Centro de notificaciones de Azure especificado. Para más información, consulte la introducción.

• Id. de consumidor: azureServiceBus
• Id. de acción: serviceBusNotificationHubSend
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • connectionString
    • Cadena de conexión de SAS
    • Cadena de conexión de SAS (firma de acceso compartido) que se usará para conectarse con Azure Service Bus. Esta cadena de conexión está disponible en el Azure Portal.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • notificationHubName
    • Nombre de centro de notificaciones
    • Nombre del centro de notificaciones al que se va a enviar la notificación. El nombre solo puede contener letras, números, puntos, guiones, barras diagonales y caracteres de subrayado. debe empezar y terminar con una letra o un número. El centro ya debe existir.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • tagsExpression
    • Etiquetas
    • Expresión de etiquetas (para establecer como destino conjuntos específicos de dispositivos). Más información.
    • Tipo de datos: cadena
    • Obligatorio: No

Envío de un mensaje a una cola de Service Bus

Esta acción envía una representación de cadena JSON del evento a la cola de Azure Service Bus especificada. Para más información, consulte Colas, artículos y suscripciones de Service Bus.

• Id. de consumidor: azureServiceBus
• Id. de acción: serviceBusQueueSend
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • connectionString
    • Cadena de conexión de SAS
    • Cadena de conexión de SAS (firma de acceso compartido) que se usará para conectarse con Azure Service Bus. Esta cadena de conexión está disponible en el Azure Portal.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • queueName
    • Nombre de la cola
    • Nombre de la cola a la que se va a enviar el mensaje. El nombre solo puede contener letras, números, puntos, guiones, barras diagonales y caracteres de subrayado. debe empezar y terminar con una letra o un número. Si la cola no existe, se crea si la cadena de conexión especificada tiene los permisos necesarios.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • resourceDetailsToSend
    • Detalles del recurso que se van a enviar
    • Control de los campos de recursos que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • messagesToSend
    • Mensajes que se van a enviar
    • Controlar los mensajes que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • detailedMessagesToSend
    • Mensajes detallados que se van a enviar
    • Controlar los mensajes detallados que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No

Envío de un mensaje a un tema de Service Bus

Esta acción envía una representación de cadena JSON del evento al tema Azure Service Bus especificado. Para obtener más información, consulte Uso del Azure Portal para crear un tema y suscripciones de Service Bus al tema.

• Id. de consumidor: azureServiceBus
• Id. de acción: serviceBusTopicSend
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • connectionString
    • Cadena de conexión de SAS
    • Cadena de conexión de SAS (firma de acceso compartido) que se usará para conectarse con Azure Service Bus. Esta cadena de conexión está disponible en el Azure Portal.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • topicName
    • Nombre del tema
    • Nombre del tema al que se va a enviar el mensaje. El nombre solo puede contener letras, números, puntos, guiones, barras diagonales y caracteres de subrayado. debe empezar y terminar con una letra o un número. Si el tema no existe, se crea si la cadena de conexión especificada tiene los permisos necesarios.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • resourceDetailsToSend
    • Detalles del recurso que se van a enviar
    • Control de los campos de recursos que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • messagesToSend
    • Mensajes que se van a enviar
    • Controlar los mensajes que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • detailedMessagesToSend
    • Mensajes detallados que se van a enviar
    • Controlar los mensajes detallados que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No

Azure Storage

Proporciona integración con Microsoft Azure Storage.

Insertar un mensaje en una cola de Storage

Esta acción inserta una representación de cadena JSON del evento en la cola de Azure Storage especificada. Para más información, consulte ¿Qué son las colas de Azure?

• Id. de consumidor: azureStorageQueue
• Id. de acción: puesta en cola
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • accountName
    • Nombre de la cuenta de almacenamiento
    • Nombre asociado a la cuenta de almacenamiento de Azure (por ejemplo, https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • accountKey
    • Clave de cuenta de almacenamiento
    • Clave asociada a la cuenta de Almacenamiento de Azure.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • queueName
    • Nombre de la cola
    • Nombre solo en minúsculas de la cola que se va a usar en Azure Storage. Si aún no existe, se crea una cola con este nombre.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • visiTimeout
    • Tiempo de espera de visibilidad de mensajes (en segundos)
    • Especifica el valor de tiempo de espera de visibilidad, en segundos, para el mensaje en cola, en relación con la hora del servidor. El valor debe ser mayor o igual que 0 y no puede ser mayor que siete días o 604 800 segundos. El tiempo de espera de visibilidad debe establecerse en un valor menor que el valor de período de vida del mensaje.
    • Tipo de datos: número
    • Obligatorio: Sí
  • ttl
    • Período de vida del mensaje (en segundos)
    • Especifica el intervalo de tiempo de vida para el mensaje de cola, en segundos. El período máximo de vida permitido es de siete días o 604 800 segundos.
    • Tipo de datos: número
    • Obligatorio: Sí
  • resourceDetailsToSend
    • Detalles del recurso que se van a enviar
    • Control de los campos de recursos que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • messagesToSend
    • Mensajes que se van a enviar
    • Controlar los mensajes que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • detailedMessagesToSend
    • Mensajes detallados que se van a enviar
    • Controlar los mensajes detallados que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No

Campfire

Campfire es similar a la mensajería instantánea, pero diseñada exclusivamente para grupos.

Publicar un mensaje en una sala

Publique un mensaje sobre el evento en una sala en Campfire.

• Id. de consumidor: campfire
• Id. de acción: postMessageToRoom
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • accountName
    • Nombre de cuenta
    • Nombre de cuenta, como https://{account name}.campfirenow.com
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • authToken
    • Token de autenticación de API
    • Token de autenticación de API para el usuario desde el que se publican los mensajes. Puede obtener este token visitando la página de perfil de usuario en Campfire.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • roomId
    • Sala
    • Espacio para publicar el mensaje.
    • Tipo de datos: número
    • Obligatorio: Sí
  • showDetails
    • Enviar un mensaje detallado
    • Publique un mensaje corto o detallado sobre el evento.
    • Tipo de datos: booleano
    • Obligatorio: No

Jenkins

Jenkins es un servidor de integración continua, que permite compilar y probar proyectos de software continuamente.

Desencadenamiento de la compilación de Git

Desencadena una compilación configurada para usar un repositorio de Git mediante el complemento de Git de Jenkins.

• Id. de consumidor: jenkins
• Id. de acción: triggerGitBuild
• Eventos admitidos: git.push
• Configuración:
  • serverBaseUrl
    • Jenkins base URL
    • La dirección URL base que hospeda el servidor Jenkins
    • Tipo de datos: URI
    • Obligatorio: Sí
  • username
    • Nombre de usuario
    • El nombre de usuario de Jenkins de un usuario que tiene permiso para desencadenar la compilación
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • password
    • Token de API de usuario (o contraseña)
    • Token de API del usuario, que está disponible en la página de configuración de usuario de Jenkins. El token de API es nuevo desde la versión 1.426. Para versiones anteriores de Jenkins, se debe especificar la contraseña de usuario real.
    • Tipo de datos: cadena
    • Obligatorio: Sí

Desencadenamiento de la compilación genérica

Desencadena una compilación genérica de Jenkins, invocando la dirección URL de compilación de Jenkins.

• Id. de consumidor: jenkins
• Id. de acción: triggerGenericBuild
• Eventos admitidos: git.push, build.complete, tfvc.checkin
• Configuración:
  • serverBaseUrl
    • Jenkins base URL
    • La dirección URL base que hospeda el servidor Jenkins
    • Tipo de datos: URI
    • Obligatorio: Sí
  • username
    • Nombre de usuario
    • El nombre de usuario de Jenkins de un usuario que tiene permiso para desencadenar la compilación
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • password
    • Token de API de usuario (o contraseña)
    • Token de API del usuario, que está disponible en la página de configuración de usuario de Jenkins. El token de API es nuevo desde la versión 1.426. Para versiones anteriores de Jenkins, se debe especificar la contraseña de usuario real.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • buildName
    • Build
    • Nombre de compilación que se va a desencadenar
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • buildAuthToken
    • Token de compilación
    • Token de autorización en forma de cadena para que solo los usuarios que lo sepan puedan desencadenar de forma remota las compilaciones de este proyecto.
    • Tipo de datos: cadena
    • Obligatorio: No
  • buildParameterized
    • Acepta parámetros
    • Indica si la compilación está parametrizada o no (los parámetros de compilación se especifican opcionalmente anteriormente).
    • Tipo de datos: booleano
    • Obligatorio: No
  • buildParams
    • Parámetros de compilación
    • Generar nombres y valores de parámetros separados por dos puntos (por ejemplo, "param1:value1") con cada par nombre-valor que aparece en su propia línea de texto
    • Tipo de datos: cadena
    • Obligatorio: No

Kato

Kato proporciona un servicio de mensajería para organizaciones modernas.

Publicar evento en sala

Publica un evento en una sala de Kato

• Id. de consumidor: kato
• Id. de acción: postEventToRoom
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • roomToken
    • Token de sala
    • Token para interactuar con una sala mediante la API de Kato
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • roomName
    • Nombre de la sala
    • Nombre de la sala como se ve en Kato
    • Tipo de datos: cadena
    • Obligatorio: No

Trello

Proporciona integración con Trello.

Crear una tarjeta

Esta acción crea una tarjeta en una lista existente en Trello. Una tarjeta puede representar una tarea, un problema, un evento o casi cualquier cosa. El estado de una tarjeta suele determinarse por qué lista está activada. Para obtener más información, consulte Creación de un enlace de servicio con Trello.

• Id. de consumidor: trello
• Id. de acción: createCard
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • userToken
    • Token de usuario (¿Necesita uno? Éselo ahora).
    • El token de usuario proporcionado por Trello. Seleccione el vínculo en la descripción de la acción descrita anteriormente para obtener este token.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • boardId
    • Board
    • Nombre del panel en el que se crea la tarjeta trello.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • listId
    • List
    • Nombre de la lista en la que se crea la tarjeta trello.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • etiquetas
    • Etiquetas
    • Lista separada por comas de colores de etiqueta que se aplicarán a la tarjeta creada. Los nombres de color de etiqueta válidos son rojo, naranja, amarillo, verde, azul y púrpura.
    • Tipo de datos: cadena
    • Obligatorio: No
  • addToTop
    • Crear al principio de la lista
    • Indica si la tarjeta debe crearse al principio de la lista de Trello, en lugar del final.
    • Tipo de datos: booleano
    • Obligatorio: No

Crear una lista

Esta acción crea una lista en un panel existente en Trello. Una lista se usa para organizar tarjetas en un panel y normalmente representa un estado. Para obtener más información, consulte Creación de un enlace de servicio con Trello.

• Id. de consumidor: trello
• Id. de acción: createList
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • userToken
    • Token de usuario (¿necesita uno? Ábalo ahora.
    • El token de usuario proporcionado por Trello. Seleccione el vínculo en la descripción de la acción descrita anteriormente para obtener este token.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • boardId
    • Board
    • Nombre del panel en el que se crea la lista de Trello.
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • addToBottom
    • Crear en la parte inferior del panel
    • Indica si la lista se debe crear en la parte inferior del panel, en lugar de en la parte superior.
    • Tipo de datos: booleano
    • Obligatorio: No

webhooks

Los webhooks proporcionan comunicación de eventos a través de HTTP.

Publicación a través de HTTP

Esta acción publica una representación de objeto JSON del evento en la dirección URL especificada. Se recomiendan puntos de conexión HTTPS debido al potencial de datos privados en la carga del evento. Para más información, consulte Webhooks.

• Id. de consumidor: webHooks
• Id. de acción: httpRequest
• Eventos admitidos: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
• Configuración:
  • url
    • Resolución
    • Dirección URL a la que se envía una solicitud HTTP POST.
    • Tipo de datos: URI
    • Obligatorio: Sí
  • httpHeaders
    • Encabezados HTTP
    • Claves y valores de encabezado HTTP separados por dos puntos (por ejemplo, "Key1:value1") con cada par clave-valor que aparece en su propia línea de texto.
    • Tipo de datos: cadena
    • Obligatorio: No
  • basicAuthUsername
    • Nombre de usuario de autenticación básica
    • Escriba un nombre de usuario para la autenticación HTTP estándar. La autenticación HTTP básica envía credenciales en texto sin cifrar (sin cifrar), lo que significa que debe usar una dirección URL que comience por "https" para habilitar el cifrado de estas credenciales a través de la capa de transporte segura (SSL).
    • Tipo de datos: cadena
    • Obligatorio: No
  • basicAuthPassword
    • Contraseña de autenticación básica
    • Escriba una contraseña para la autenticación HTTP estándar. La autenticación HTTP básica envía credenciales en texto sin formato (sin cifrar), lo que significa que debe usar una dirección URL que comience por "https" para habilitar el cifrado de estas credenciales a través de SSL.
    • Tipo de datos: cadena
    • Obligatorio: No
  • resourceDetailsToSend
    • Detalles del recurso que se van a enviar
    • Control de los campos de recursos que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • messagesToSend
    • Mensajes que se van a enviar
    • Controlar los mensajes que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No
  • detailedMessagesToSend
    • Mensajes detallados que se van a enviar
    • Controlar los mensajes detallados que se van a enviar
    • Tipo de datos: cadena
    • Obligatorio: No

Zendesk

Zendesk es un conjunto de aplicaciones SaaS que ofrece incidencias en el departamento de soporte técnico, seguimiento de problemas y servicio al cliente.

Creación de un comentario privado en un vale

Use Zendesk para crear un comentario privado en un vale.

• Id. de consumidor: zendesk
• Id. de acción: createPrivateComment
• Eventos admitidos: workitem.commented
• Configuración:
  • accountName
    • Nombre de cuenta
    • Nombre de cuenta de Zendesk, como https://{account name}.zendesk.com
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • username
    • Nombre de usuario
    • El nombre de usuario de Zendesk de un usuario que actualiza vales
    • Tipo de datos: cadena
    • Obligatorio: Sí
  • apiToken
    • Token de API
    • El token de LA API de Zendesk (se puede encontrar en la aplicación Zendesk en Administración > Channels > API)
    • Tipo de datos: cadena
    • Obligatorio: Sí

Artículos relacionados

• Autorizar otros servicios
• Introducción a los enlaces de servicio