Creación de un error en Azure DevOps Services mediante bibliotecas cliente de .NET

Artículo
04/04/2024

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

Crear un nuevo error (o cualquier elemento de trabajo) es bastante sencillo. Solo tiene que establecer los valores de campo y enviar un objeto JSON-Patch al punto de conexión rest.

Requisitos previos

Debe tener lo siguiente para poder crear un elemento de trabajo.

Una organización en Azure DevOps Services. Si no tiene una, puede crear una gratuitamente.
Un token de acceso personal, averigüe cómo crear uno
Un entorno de desarrollo de C#, puede usar Visual Studio.

Creación de un proyecto de C# en Visual Studio

Para obtener información sobre la programación de C# en Visual Studio, busque la documentación de programación de C# de Visual Studio.

Contenido de código de C#

Hay algunas cosas que suceden en el ejemplo de código siguiente:

Authentication
1. Creación de credenciales mediante el PAT
2. Creación de un VSS Conectar ion con el URI de Azure DevOps Services y las credenciales
Recuperación del cliente mediante VSS Conectar ion
Creación del error
1. Crear una matriz de objetos para establecer los valores de campo
2. Conversión de esa matriz en un objeto JSON serializado
3. Envío de ese objeto JSON serializado al punto de conexión REST

Fragmento de código C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Microsoft.TeamFoundation.WorkItemTracking.WebApi;
using Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models;
using Microsoft.VisualStudio.Services.Common;
using Microsoft.VisualStudio.Services.WebApi.Patch.Json;
using Microsoft.VisualStudio.Services.WebApi.Patch;
using Microsoft.VisualStudio.Services.WebApi;
using System.Net.Http.Headers;
using System.Net.Http;
using Newtonsoft.Json;

 
public class CreateBug 
{
    readonly string _uri;
    readonly string _personalAccessToken;
    readonly string _project;

    /// <summary>
    /// Constructor. Manually set values to match your organization. 
    /// </summary>
    public CreateBug()
    {
        _uri = "https://dev.azure.com/{orgName}";
        _personalAccessToken = "personal access token";
        _project = "project name";
    }

    /// <summary>
    /// Create a bug using the .NET client library
    /// </summary>
    /// <returns>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</returns>    
    public WorkItem CreateBugUsingClientLib()
    {
        Uri uri = new Uri(_uri);
        string personalAccessToken = _personalAccessToken;
        string project = _project;

        VssBasicCredential credentials = new VssBasicCredential("", _personalAccessToken);
        JsonPatchDocument patchDocument = new JsonPatchDocument();

        //add fields and their values to your patch document
        patchDocument.Add(
            new JsonPatchOperation()
            {
                Operation = Operation.Add,
                Path = "/fields/System.Title",
                Value = "Authorization Errors"
            }
        );

        patchDocument.Add(
            new JsonPatchOperation()
            {
                Operation = Operation.Add,
                Path = "/fields/Microsoft.VSTS.TCM.ReproSteps",
                Value = "Our authorization logic needs to allow for users with Microsoft accounts (formerly Live Ids) - http:// msdn.microsoft.com/library/live/hh826547.aspx"
            }
        );

        patchDocument.Add(
            new JsonPatchOperation()
            {
                Operation = Operation.Add,
                Path = "/fields/Microsoft.VSTS.Common.Priority",
                Value = "1"
            }
        );

        patchDocument.Add(
            new JsonPatchOperation()
            {
                Operation = Operation.Add,
                Path = "/fields/Microsoft.VSTS.Common.Severity",
                Value = "2 - High"
            }
        );
        VssConnection connection = new VssConnection(uri, credentials);
        WorkItemTrackingHttpClient workItemTrackingHttpClient = connection.GetClient<WorkItemTrackingHttpClient>();

        try
        {
            WorkItem result = workItemTrackingHttpClient.CreateWorkItemAsync(patchDocument, project, "Bug").Result;

            Console.WriteLine("Bug Successfully Created: Bug #{0}", result.Id);

            return result;
        }
        catch (AggregateException ex)
        {
            Console.WriteLine("Error creating bug: {0}", ex.InnerException.Message);
            return null;
        }
    }
}

Pasos siguientes

Consulte otro inicio rápido: Obtención de una lista de elementos de trabajo mediante consultas
Exploración de los ejemplos de integración

Compartir vía