Compartir a través de

Consumidores de enlace de servicio

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

Puede usar un enlace de servicio para realizar una acción en un servicio de consumidor cuando se produce un evento en un proyecto de Azure DevOps. Por ejemplo, un enlace de servicio puede notificar a un consumidor cuando se produce un error en una compilación.

Para configurar un enlace de servicio, cree una suscripción que especifique el evento, el consumidor y la acción. Con algunos consumidores, creas una suscripción en el servicio al consumidor, no en Azure DevOps. En este artículo se proporciona información sobre la configuración de consumidor que se usa al crear una suscripción mediante programación en Azure DevOps.

Puede seleccionar entre los siguientes consumidores al crear una suscripción en Azure DevOps:

Para obtener información sobre estos consumidores y otros usuarios que puede integrar con enlaces de servicio, consulte Servicios disponibles.

Azure Service Bus

Service Bus es un servicio de mensajería que facilita la comunicación asincrónica entre aplicaciones y servicios. Como consumidor de enlaces de servicio, proporciona integración con colas y temas de Service Bus y también con Azure Notification Hubs.

Envío de un mensaje a un centro de notificaciones

Esta acción envía una notificación genérica de plantilla a una instancia especificada de Notification Hubs.

  • Id. de consumidor: azureServiceBus

  • Id. de acción: serviceBusNotificationHubSend

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    connectionString Cadena de conexión de SAS Cadena de conexión con firma de acceso compartido (SAS) que se utilizará para la conexión con Service Bus. Esta cadena de conexión está disponible en el Azure Portal. string Sí
    notificationHubName Nombre del 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. string Sí
    tagsExpression Etiquetas Expresión de etiqueta que tiene como destino un conjunto específico de dispositivos. Para obtener más información, consulte Expresiones de etiqueta y enrutamiento. string No

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

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

  • Id. de consumidor: azureServiceBus

  • Id. de acción: serviceBusQueueSend

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    AuthenticationMechanismInputId Modo de autenticación Modo de autenticación que se va a usar: una cadena de conexión o una conexión de servicio. string No
    ServiceConnectionInputId Conexiones de Azure Resource Manager Identificador de una conexión de servicio. string No
    ServiceBusHostNameInputId Nombre de host de Service Bus Nombre de host en Azure Portal, con el formato sb://<Service-Bus-name>.servicebus.windows.net. string No
    connectionString Cadena de conexión de SAS Cadena de conexión de SAS que se va a usar para conectarse con Service Bus. Esta cadena de conexión está disponible en el Azure Portal. string No
    queueName Nombre de 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. string Sí
    bypassSerializer Enviar como cadena norializada Una opción para enviar mensajes a Service Bus como cadenas norializadas en lugar de como cadenas serializadas de .NET. Seleccione esta opción cuando el receptor no sea un cliente .NET, por ejemplo, cuando el cliente use la biblioteca cliente de Azure para Node. boolean No
    resourceDetailsToSend Detalles del recurso que se van a enviar Número de campos de recurso que se van a enviar a la cola. Las opciones posibles son todos los campos, un número mínimo y ninguno. string No
    messagesToSend Mensajes que se van a enviar Tipos de mensajes que se van a enviar a la cola. string No
    detailedMessagesToSend Mensajes detallados que se van a enviar Tipos de mensajes detallados que se van a enviar a la cola. string No

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

Esta acción envía una representación de cadena JSON de un evento a un tema de 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: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    AuthenticationMechanismInputId Modo de autenticación Modo de autenticación que se va a usar. string No
    ServiceConnectionInputId Conexiones de Azure Resource Manager Identificador de una conexión de servicio. string No
    ServiceBusHostNameInputId Nombre de host de Service Bus Nombre de host en Azure Portal, con el formato sb://{Service-Bus-name}.servicebus.windows.net. string No
    connectionString Cadena de conexión de SAS Cadena de conexión de SAS que se va a usar para conectarse con Service Bus. Esta cadena de conexión está disponible en el Azure Portal. string No
    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. string Sí
    bypassSerializer Enviar como cadena norializada Una opción para enviar mensajes a Service Bus como cadenas norializadas en lugar de como cadenas serializadas de .NET. Seleccione esta opción cuando el receptor no sea un cliente .NET, por ejemplo, cuando el cliente use la biblioteca cliente de Azure para Node. boolean No
    resourceDetailsToSend Detalles del recurso que se van a enviar Número de campos de recurso que se van a enviar al tema. Las opciones posibles son todos los campos, un número mínimo y ninguno. string No
    messagesToSend Mensajes que se van a enviar Tipos de mensajes que se van a enviar al tema. string No
    detailedMessagesToSend Mensajes detallados que se van a enviar Tipos de mensajes detallados que se van a enviar al tema. string No

Azure Storage

El almacenamiento es una solución de almacenamiento en la nube para varios tipos de datos. Azure Queue Storage es una parte del almacenamiento que proporciona colas de mensajería que pueden actuar como puntos de conexión de servicio.

Insertar un mensaje en una cola de almacenamiento

Esta acción inserta una representación de cadena JSON de un evento en una cola de Storage especificada. Para más información, consulte ¿Qué es Azure Queue Storage?.

  • Id. de consumidor: azureStorageQueue

  • Id. de acción: enqueue

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    AuthenticationMechanismInputId Modo de autenticación Modo de autenticación que se va a usar. string No
    ServiceConnectionInputId Conexiones de Azure Resource Manager Identificador de una conexión de servicio. string No
    accountName Nombre de la cuenta de almacenamiento Nombre asociado a la cuenta de almacenamiento. Este nombre está disponible en Azure Portal. string Sí
    accountKey Clave de cuenta de almacenamiento Clave asociada a la cuenta de Almacenamiento. string No
    queueName Nombre de cola Nombre solo en minúsculas de la cola que se va a usar en Storage. Se crea una cola con este nombre si aún no existe. string Sí
    visiTimeout Tiempo de espera de visibilidad de mensajes 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 que sea menor que el valor de período de vida del mensaje. number Sí
    ttl Período de vida del mensaje Intervalo de tiempo de vida para el mensaje de cola, en segundos. El valor máximo que puede usar es de siete días o 604 800 segundos. number Sí
    resourceDetailsToSend Detalles del recurso que se van a enviar Número de campos de recurso que se van a enviar a la cola. Las opciones posibles son todos los campos, un número mínimo y ninguno. string No
    messagesToSend Mensajes que se van a enviar Tipos de mensajes que se van a enviar a la cola. string No
    detailedMessagesToSend Mensajes detallados que se van a enviar Tipos de mensajes detallados que se van a enviar a la cola. string No

Bamboo

Bamboo es un servidor de integración continua de Atlassian.

Poner en cola una compilación

Esta acción programa una compilación en Bamboo.

  • Id. de consumidor: bamboo

  • Id. de acción: queueBuild

  • Eventos compatibles: git.push, build.complete, tfvc.checkin

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    serverBaseUrl URL base de Bamboo El URI que contiene el nombre de host del servidor Bamboo. uri Sí
    basicAuthCredentials Credenciales de autenticación básicas Credenciales estándar que se usarán para autenticarse en el servidor bamboo. Para evitar el envío de credenciales en texto sin formato, use el protocolo HTTPS para cifrar las credenciales a través de Seguridad de la capa de transporte (TLS). Se recomienda usar entidades de servicio e identidades administradas en Azure DevOps. string Sí
    planName Planificación Nombre del plan que se va a enviar a la cola. string Sí

Datadog

Datadog es una plataforma de supervisión y análisis para entornos en la nube.

Publicación de un evento en Datadog

Esta acción crea un evento y las métricas correspondientes en Datadog.

  • Id. de consumidor: datadog

  • Id. de acción: postEventInDatadog

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    apiKey Clave de API de Datadog Clave de acceso de la cuenta de Datadog. Puede encontrar la clave de API en el portal de Datadog. Vaya a su perfil y, a continuación, seleccione Configuración de la organización>Claves de API. string Sí
    accountType Tipo de cuenta de Datadog El tipo de la cuenta de Datadog. Puede determinar el tipo de cuenta desde el nombre de host de la dirección URL que usa la cuenta de Datadog:
    - app.datadoghq.com: US
    - app.datadoghq.eu: EU
    - us3.datadoghq.com: US3
    - us5.datadoghq.com: US5
    - ap1.datadoghq.com: AP1
    - app.dog-gov.com: GOV    		 string Sí

Grafana

Grafana es un editor de gráficos y un panel de código abierto.

Agregar una anotación a una base de datos de Grafana

Esta acción crea una anotación en Grafana.

  • Id. de consumidor: grafana

  • Id. de acción: addAnnotation

  • Eventos admitidos: ms.vss-release.deployment-completed-event

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    url URL de Grafana Dirección URL que se va a usar para publicar una anotación en Grafana. uri Sí
    apiToken Token de API Token de acceso para publicar anotaciones en una base de datos de Grafana. Para obtener información sobre cómo crear un token, consulte Creación de tokens y paneles de cuentas de servicio para una organización. string Sí
    tags Etiquetas Lista separada por comas de etiquetas que se van a usar para agregar anotaciones. string Sí
    annotationDeploymentDurationWindow Anotación de la ventana de duración de la implementación Una opción para configurar la ventana de duración de una anotación.
    - Cuando se selecciona, la anotación se aplica al tiempo entre el inicio y la finalización de la implementación.
    - Cuando no se selecciona, la anotación se aplica a la finalización de la implementación.    		 boolean No
    text Mensaje de texto Descripción personalizada de una anotación. Cuando no se especifica, esta configuración describe la versión y el estado. Esta configuración puede incluir vínculos, como <a href="https://www.contoso.com" target="_blank">Contoso</a>. string No
    dashboardId Panel Identificador del panel al que se va a agregar la anotación. Cuando no se especifica un identificador, la anotación se agrega en el nivel global. string No

Jenkins

Jenkins es un servidor de integración continua que puede usar para compilar y probar proyectos de software continuamente.

Desencadenamiento de una compilación de Git

Esta acción usa el complemento Git de Jenkins para desencadenar una compilación en un repositorio de Git.

  • Id. de consumidor: jenkins

  • Id. de acción: triggerGitBuild

  • Eventos admitidos: git.push, git.pullrequest.merged

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    serverBaseUrl URL base de Jenkins URI que contiene el nombre de host del servidor jenkins. uri Sí
    basicAuthCredentials Credenciales de autenticación básicas Credenciales de autenticación HTTP estándar. Para evitar el envío de credenciales en texto sin formato, use el protocolo HTTPS para cifrar las credenciales a través de TLS. Se recomienda usar entidades de servicio e identidades administradas en Azure DevOps. string Sí
    useTfsPlugin Nivel de integración El nivel de integración seleccionado, que es uno de los dos valores:
    - La API de Jenkins integrada
    - La integración extendida proporcionada por el complemento de Azure DevOps Server si ese complemento está instalado en el servidor Jenkins.    		 string No

Desencadenar una compilación genérica

Esta acción desencadena una compilación genérica de Jenkins que invoca la dirección URL de compilación de Jenkins.

  • Id. de consumidor: jenkins

  • Id. de acción: triggerGenericBuild

  • Eventos admitidos: git.push, git.pullrequest.merged, build.complete, tfvc.checkin, ms.vss-release.deployment-completed-event

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    serverBaseUrl URL base de Jenkins URI que contiene el nombre de host del servidor jenkins. uri Sí
    basicAuthCredentials Credenciales de autenticación básicas Credenciales de autenticación HTTP estándar. Para evitar el envío de credenciales en texto sin formato, use el protocolo HTTPS para cifrar las credenciales a través de TLS. Se recomienda usar entidades de servicio e identidades administradas en Azure DevOps. string Sí
    buildName Construir Nombre de la compilación que se va a desencadenar. string Sí
    useTfsPlugin Nivel de integración El nivel de integración seleccionado, que es uno de los dos valores:
    - La API de Jenkins integrada
    - La integración extendida proporcionada por el complemento de Azure DevOps Server si ese complemento está instalado en el servidor Jenkins.    		 string No
    buildAuthToken Token de compilación Un token de autorización para una compilación. Solo los usuarios que conocen el token pueden desencadenar compilaciones de forma remota. string No
    buildParameterized Acepta parámetros Opción que especifica si la compilación acepta parámetros. boolean No
    buildParams Parámetros de compilación Compile parámetros en forma de pares nombre-valor. En cada par, el nombre y el valor están separados por dos puntos, como <parameter>:<value>. Cada par de nombre y valor aparece en una línea propia. string No

Slack

Slack es una plataforma que se puede buscar para la comunicación del equipo.

Publicar un mensaje en un canal

Esta acción publica un mensaje sobre un evento en un canal de Slack. Para más información, consulte Creación de un enlace de servicio para Azure DevOps con Slack.

  • Id. de consumidor: slack

  • Id. de acción: postMessageToChannel

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    url URL de webhook de Slack La dirección URL del webhook proporcionada por Slack para enviar solicitudes HTTP POST. uri Sí

Trello

Trello es una herramienta de administración de proyectos que usa paneles, listas y tarjetas para ayudar a los equipos a realizar un seguimiento de los flujos de trabajo.

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 u otros elementos relacionados con el proyecto. Para más información, consulte Creación de un enlace de servicio para Azure DevOps Services y TFS con Trello.

  • Id. de consumidor: trello

  • Id. de acción: createCard

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    userToken Token de usuario Token de usuario que proporciona acceso a los recursos de Trello. Para obtener un token, vaya a la página de autorización de Trello. string Sí
    boardId Junta Nombre del panel en el que se crea la tarjeta trello. string Sí
    listId Lista Nombre de la lista en la que se crea la tarjeta trello. string Sí
    labels 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 red, orange, yellowgreen, , bluey purple. string No
    addToTop Crear al principio de la lista Opción que indica si se va a crear la tarjeta al principio o al final de la lista de Trello. Cuando este campo es true, la tarjeta se crea al principio. boolean No
    cardName Nombre de tarjeta Nombre de la nueva tarjeta. De forma predeterminada, la descripción del texto del evento se usa como nombre. Puede usar marcadores de posición para insertar contenido del evento en el nombre. Para más información, consulte Creación de un enlace de servicio para Azure DevOps Services y TFS con Trello. string No
    cardDescription Descripción de la tarjeta Descripción de la nueva tarjeta. De forma predeterminada, la descripción detallada de Markdown del evento se usa como descripción. Puede usar marcadores de posición para insertar contenido del evento en la descripción. Para más información, consulte Creación de un enlace de servicio para Azure DevOps Services y TFS con Trello. string 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 más información, consulte Creación de un enlace de servicio para Azure DevOps Services y TFS con Trello.

  • Id. de consumidor: trello

  • Id. de acción: createList

  • Eventos admitidos: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    userToken Token de usuario Token de usuario que proporciona acceso a los recursos de Trello. Para obtener un token, vaya a la página de autorización de Trello. string Sí
    boardId Junta Nombre del panel en el que se crea la lista de Trello. string Sí
    addToBottom Crear en la parte inferior del panel Opción que indica si se va a crear la tarjeta al principio o al final del panel. Cuando este campo es true, la tarjeta se crea al final. boolean No
    listName Nombre de la lista Nombre de la nueva lista. De forma predeterminada, la descripción del texto del evento se usa como nombre. Puede usar marcadores de posición para insertar contenido del evento en el nombre. Para más información, consulte Creación de un enlace de servicio para Azure DevOps Services y TFS con Trello. string No

Webhooks

Los webhooks proporcionan una manera de enviar una representación JSON de un evento de Azure DevOps a cualquier servicio que tenga un punto de conexión público.

Publicación a través de HTTP

Esta acción envía una representación de objeto JSON de un evento a una 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: todos los eventos

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    url URL Dirección URL a la que se va a enviar una solicitud HTTP POST. uri Sí
    acceptUntrustedCerts Aceptar certificados SSL que no son de confianza Una opción para no requerir un certificado confiable de capa de sockets seguros (SSL) para un punto de conexión. Use esta opción solo durante el desarrollo y las pruebas. boolean No
    basicAuthCredentials Credenciales de autenticación básicas Credenciales de autenticación HTTP estándar. Para evitar el envío de credenciales en texto sin formato, use el protocolo HTTPS para cifrar las credenciales a través de TLS. Se recomienda usar entidades de servicio e identidades administradas en Azure DevOps. string Sí
    httpHeaders Encabezados HTTP Claves y valores de las cabeceras HTTP en forma de pares clave-valor. En cada par, la clave y el valor están separados por dos puntos, como <key>:<value>. Cada par clave-valor aparece en su propia línea. Cualquiera que tenga acceso a la suscripción del enlace de servicio puede ver estos valores. string No
    resourceDetailsToSend Detalles del recurso que se van a enviar Número de campos de recurso que se van a enviar a la cola. Las opciones posibles son todos los campos, un número mínimo y ninguno. string No
    messagesToSend Mensajes que se van a enviar Tipos de mensajes que se van a enviar a la cola. string No
    detailedMessagesToSend Mensajes detallados que se van a enviar Tipos de mensajes detallados que se van a enviar a la cola. string No

Zendesk

Zendesk es un software como servicio (SaaS) que ofrece gestión de tickets del servicio de soporte, seguimiento de incidencias y soporte al cliente.

Creación de un comentario privado en un vale

Esta acción crea un comentario privado en un ticket de Zendesk.

  • Id. de consumidor: zendesk

  • Id. de acción: createPrivateComment

  • Eventos admitidos: workitem.commented

  • Configuración:

    ID de Entrada Nombre Descripción Tipo de dato Obligatorio
    accountName Nombre de cuenta Nombre de la cuenta de Zendesk. Puede encontrar el nombre de la cuenta en la dirección URL de la cuenta de Zendesk, que tiene el formato https://<account-name>.zendesk.com. string Sí
    username Nombre de usuario Nombre de usuario del usuario de Zendesk que actualiza los tickets. string Sí
    apiToken Token de API Token de la API de Zendesk. Para buscar el token, vaya a la aplicación Zendesk y luego seleccione Administración>, Canales>, API. string Sí

Contenido relacionado

  • Last updated on