Creare un bug in Azure DevOps Services usando le librerie client .NET

Articolo
04/04/2024

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

La creazione di un nuovo bug (o qualsiasi elemento di lavoro) è piuttosto semplice. È sufficiente impostare i valori dei campi e inviare un oggetto JSON-Patch all'endpoint REST.

Prerequisiti

Prima di poter creare un elemento di lavoro, è necessario disporre di quanto segue.

Un'organizzazione in Azure DevOps Services. Se non ne hai uno, puoi crearne uno gratuitamente
Un token di accesso personale, scopri come crearne uno
Un ambiente di sviluppo C#, è possibile usare Visual Studio

Creare un progetto C# in Visual Studio

Per informazioni sulla programmazione C# in Visual Studio, vedere la documentazione relativa alla programmazione C# di Visual Studio

Contenuto del codice C#

Nell'esempio di codice seguente vengono eseguite alcune operazioni:

Autenticazione
1. Creazione di credenziali con il pat
2. Creazione di un vss Connessione ion con l'URI di Azure DevOps Services e le credenziali
Recupero del client tramite vss Connessione ion
Creazione del bug
1. Creare una matrice di oggetti per impostare i valori dei campi
2. Convertire la matrice in un oggetto JSON serializzato
3. Inviare l'oggetto JSON serializzato all'endpoint REST

Frammento di codice 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;
        }
    }
}

Passaggi successivi

Vedere un'altra guida introduttiva: Ottenere un elenco di elementi di lavoro usando query
Esplorare gli esempi di integrazione

Condividi tramite