Compartilhar via


Criar um bug no Azure DevOps Services usando bibliotecas de clientes do .NET

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

A criação de um novo bug (ou qualquer item de trabalho) é bem simples. Você só precisa definir os valores de campo e enviar um objeto JSON-Patch para o ponto de extremidade REST.

Pré-requisitos

É preciso ter o seguinte antes de criar um item de trabalho.

  • Uma organização no Azure DevOps Services. Se você não tiver um, poderá criar um gratuitamente
  • Um Token de Acesso Pessoal, saiba como criar um
  • No ambiente de desenvolvimento em C#, você pode usar o Visual Studio

Criar um projeto em C# no Visual Studio

Para saber mais sobre programação em C# no Visual Studio, localize a documentação de programação do Visual Studio C#

Conteúdo do código C#

Há algumas coisas acontecendo no seguinte exemplo de código:

  1. Autenticação
    1. Criando credenciais usando seu PAT
    2. Criando um VSSConnection com a URI dos serviços do Azure DevOps e as credenciais
  2. Recuperando o cliente utilizando sua conexão do VSS
  3. Criando o bug
    1. Criar uma matriz de objetos para definir os valores de campo
    2. Converter essa matriz em um objeto json serializado
    3. Enviar esse objeto json serializado para o ponto de extremidade REST

Snippet de código em 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;
        }
    }
}

Próximas etapas