Bibliotecas de cliente .NET

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

As bibliotecas de cliente estão disponíveis para desenvolvedores .NET que criam aplicativos e serviços do Windows que se integram ao Azure DevOps. As bibliotecas de cliente integram-se com o acompanhamento de itens de trabalho, controle de versão, compilação e outros serviços. Esses pacotes substituem o instalador tradicional do TFS Client OM e facilitam a aquisição e a redistribuição das bibliotecas necessárias para seu aplicativo ou serviço.

Diagrama de dependência

Funcionalidades

• Transferível a partir do NuGet.org e facilmente importável para os seus projetos do Visual Studio
• As bibliotecas são licenciadas para redistribuição em seus aplicativos e serviços (veja a licença)
• Acesse APIs de modelo de objeto de cliente tradicional e APIs REST

Pacote e tabela de mapeamento de versão do Azure DevOps

Para obter as versões de visualização mais recentes, consulte a galeria de pacotes NuGet.

Pacotes REST

Embalagem de sabão

Instalar

Instale a partir de um prompt de comando do gerenciador de pacotes NuGet:

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Ligar

Para criar uma conexão autenticada com o Azure DevOps, obtenha um HttpClient para o serviço com o qual você deseja trabalhar e chame métodos nesse serviço.

Veja os exemplos seguintes:

using Microsoft.VisualStudio.Services.Common;
using Microsoft.VisualStudio.Services.Client;
using Microsoft.TeamFoundation.SourceControl.WebApi;
using Microsoft.VisualStudio.Services.WebApi;

const String c_collectionUri = "https://dev.azure.com/fabrikam";
const String c_projectName = "MyGreatProject";
const String c_repoName = "MyRepo";

Uri orgUrl = new Uri(c_collectionUri);

// Connect to Azure DevOps Services
VssConnection connection = new VssConnection(orgUrl, new VssBasicCredential(string.Empty, personalAccessToken));

// Get a GitHttpClient to talk to the Git endpoints
using (GitHttpClient gitClient = connection.GetClient<GitHttpClient>())
{
    // Get data about a specific repository
    var repo = gitClient.GetRepositoryAsync(c_projectName, c_repoName).Result;
}

Os caminhos de autenticação que produzem uma caixa de diálogo interativa não estão disponíveis na versão .NET Standard das bibliotecas de cliente .NET. Quando você estiver usando a versão .NET Standard, forneça suas credenciais mais explicitamente para autenticar, como no exemplo a seguir.

using System;
using Microsoft.TeamFoundation.SourceControl.WebApi;
using Microsoft.VisualStudio.Services.Common;
using Microsoft.VisualStudio.Services.WebApi;

namespace ConsoleApp1
{
    class Program
    {
        const string collectionUri = "https://dev.azure.com/fabrikam";
        const string projectName = "MyGreatProject";
        const string repoName = "MyRepo";
        const string pat = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

        static void Main(string[] args)
        {
            var creds = new VssBasicCredential(string.Empty, pat);
            
            // Connect to Azure DevOps Services
            var connection = new VssConnection(new Uri(collectionUri), creds);
            
            // Get a GitHttpClient to talk to the Git endpoints
            using var gitClient = connection.GetClient<GitHttpClient>();
            
            // Get data about a specific repository
            var repo = gitClient.GetRepositoryAsync(projectName, repoName).Result;
        }
    }
}

Para obter mais exemplos de autenticação, consulte Exemplos do .NET.

Referência

Para obter mais informações e documentação de referência atualizada, consulte o navegador da API .NET.

Exemplos

Confira exemplos em nossa página de exemplos do .NET ou diretamente em nosso repositório .NET GitHub.

Problemas conhecidos

A caixa de diálogo de autenticação interativa não aparece ao usar o Azure DevOps OM em um STA (Single Threaded Apartment)

A caixa de diálogo de autenticação interativa não aparece nos casos em que seu código está sendo executado a partir de um Single Threaded Apartment (STA). Esse problema geralmente pode ocorrer a partir de aplicativos WPF . Para contornar esse problema, você pode alterar seu método de inicialização para ser assíncrono e solicitar autenticação como no exemplo a seguir.

async void InitAzureDevOps()
{
    Uri _uri = new Uri("https://dev.azure.com/MyAccount/");

    var creds = new VssClientCredentials(new WindowsCredential(false),
                                         new VssFederatedCredential(false),
                                         CredentialPromptType.PromptIfNeeded);

    VssConnection vssConnection = new VssConnection(_uri, creds);
    await vssConnection.ConnectAsync();

    ...

}

Usando versões NetStandard 2.0 do Azure DevOps OM

Para a versão 16.143.1 dos nossos pacotes NuGet, suportamos NetStandard 2.0. Esses pacotes se correlacionam com o Azure DevOps Server 2019 RTW e são totalmente compatíveis com o Azure DevOps.

O pacote Microsoft.TeamFoundationServer.ExtendedClient não tem suporte a NetStandard

O Microsoft.TeamFoundationServer.ExtendedClient não suporta uma versão compatível com NetStandard.