Skapa en bugg i Azure DevOps Services med hjälp av .NET-klientbibliotek

Artikel
04/04/2024

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

Det är ganska enkelt att skapa en ny bugg (eller ett arbetsobjekt). Du behöver bara ange fältvärdena och skicka ett JSON-Patch-objekt till REST-slutpunkten.

Förutsättningar

Du måste ha följande innan du kan skapa ett arbetsobjekt.

En organisation i Azure DevOps Services. Om du inte har en kan du skapa en kostnadsfritt
En personlig åtkomsttoken, ta reda på hur du skapar en
En C#-utvecklingsmiljö, du kan använda Visual Studio

Skapa ett C#-projekt i Visual Studio

Om du vill veta mer om C#-programmering i Visual Studio hittar du dokumentationen för Visual Studio C#-programmering

C#-kodinnehåll

Det finns några saker som händer i följande kodexempel:

Autentisering
1. Skapa autentiseringsuppgifter med din PAT
2. Skapa en VSS Anslut ion med din Azure DevOps Services-URI och autentiseringsuppgifterna
Hämtar klienten med vss Anslut ion
Skapa buggen
1. Skapa en matris med objekt för att ange fältvärdena
2. Konvertera matrisen till ett serialiserat json-objekt
3. Skicka det serialiserade json-objektet till REST-slutpunkten

C#-kodfragment

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;
        }
    }
}

Nästa steg

Kolla in en annan snabbstart: Hämta en lista över arbetsobjekt med hjälp av frågor
Utforska integreringsexemplen

Dela via