Creación de un consumidor personalizado para enlaces de servicio

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

Use enlaces de servicio para notificar a los sistemas que no son de Microsoft los eventos que se producen en el proyecto. Un consumidor personalizado envía un mensaje HTTP al punto de conexión definido en el manifiesto de la extensión.

En este artículo se explica el desarrollo de una extensión que implementa un servicio de consumidor de ejemplo, que incluye los siguientes eventos y acciones.

• Eventos admitidos que desencadenan las siguientes acciones:
  • Código insertado
  • Solicitud de incorporación de cambios creada
  • Solicitud de incorporación de cambios actualizada
• Acciones admitidas para realizar cuando se producen eventos:
  • Enviar un mensaje HTTP

Para obtener más información, consulte el repositorio de GitHub de ejemplo de extensión. Para obtener una lista de todos los eventos admitidos que puede usar como desencadenadores para la extensión de consumidor personalizada, consulte Lista de tipos de eventos.

Funcionamiento de los enlaces de servicio

Los publicadores de enlaces de servicio definen un conjunto de eventos. Las suscripciones escuchan los eventos y definen acciones que se ejecutan cuando se desencadena un evento.

En este diagrama se muestra el flujo general del hook de servicio: los publicadores emiten eventos, las suscripciones se corresponden con los eventos, y las acciones se ejecutan cuando se produce una coincidencia. En el ejemplo de este artículo, una extensión implementa el consumidor. Cuando se produce un evento admitido, la acción configurada del consumidor envía un mensaje HTTP al punto de conexión especificado en el manifiesto de extensión.

Creación de la extensión

1. Vea cómo crear la extensión desde cero.

2. Agregue la contribución específica para la implementación de consumidor personalizada al archivo de manifiesto básico. Consulte el siguiente ejemplo de cómo debe verse el manifiesto después de agregar la contribución.

{
    "manifestVersion": 1,
    "id": "samples-service-hooks-consumer",
    "version": "0.1.2",
    "name": "Service Hooks Sample",
    "description": "A simple extension that demonstrates how to contribute a consumer service into service hooks.",
    "publisher": "fabrikam",
    "public": false,
    "icons": {
        "default": "images/logo.png"
    },
    "scopes": [],
    "files": [
        {
            "path": "images",
            "addressable": true
        }
    ],
    "content": {
        "details": {
            "path": "readme.md"
        }
    },
    "categories": [
        "Developer samples"
    ],
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "contributions": [
        {
            "id": "consumer",
            "type": "ms.vss-servicehooks.consumer",
            "targets": [
                "ms.vss-servicehooks.consumers"
            ],
            "properties": {
                "id": "consumer",
                "name": "Sample Consumer",
                "description": "Sample consumer service",
                "informationUrl": "https://aka.ms/vsoextensions",
                "inputDescriptors": [
                    {
                        "id": "url",
                        "isRequired": true,
                        "name": "URL",
                        "description": "URL to post event payload to",
                        "inputMode": "textbox"
                    }
                ],
                "actions": [
                    {
                        "id": "performAction",
                        "name": "Perform action",
                        "description": "Posts a standard event payload",
                        "supportedEventTypes": [
                            "git.push",
                            "git.pullrequest.created",
                            "git.pullrequest.updated"
                        ],
                        "publishEvent": {
                            "url": "{{{url}}}",
                            "resourceDetailsToSend": "all",
                            "messagesToSend": "all",
                            "detailedMessagesToSend": "all"
                        }
                    }
                ]
            }
        }
    ]
}

Para cada contribución en tu extensión, el manifiesto define los siguientes elementos.

• Tipo de contribución: servicio de consumidor (ms.vss-servicehooks.consumer) en este caso.
• Destino de contribución: Servicios para consumidores (ms.vss-servicehooks.consumers) en este caso.
• Propiedades específicas de cada tipo de contribución.

Los consumidores tienen las siguientes propiedades.

Las acciones para el consumidor tienen las siguientes propiedades:

3. Implemente la extensión en la organización de Azure DevOps y pruóbela.

Pasos siguientes

Contenido relacionado

• Consumidores de enlace de servicio
• Servicios disponibles para enlaces de servicio
• Crear una suscripción de enlace de servicio mediante programación
• Probar y depurar extensiones en el explorador
• Repositorio de GitHub de ejemplo de extensión
• Lista de tipos de eventos