bibliotecas de cliente .NET

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

As bibliotecas de cliente estão disponíveis para desenvolvedores .NET que criam aplicativos e serviços Windows que se integram ao Azure DevOps. As bibliotecas de cliente se integram ao rastreamento de itens de trabalho, controle de versão, construção e outros serviços. Esses pacotes facilitam a aquisição e redistribuição das bibliotecas necessárias para seu aplicativo ou serviço.

Diagrama de dependência

Recursos de bibliotecas de cliente do .NET

As bibliotecas de cliente .NET para Azure DevOps oferecem vários recursos importantes que facilitam a integração com serviços em Azure DevOps de seus aplicativos e serviços Windows:

• Disponível para download no NuGet.org: importe facilmente as bibliotecas para seus projetos no Visual Studio baixando-as de NuGet.org.
• Licenciado para redistribuição: as bibliotecas são licenciadas para redistribuição em seus aplicativos e serviços. Você pode exibir a licença para obter mais detalhes.
• Access to APIs: obtenha acesso às APIs tradicionais do modelo de objeto cliente e às APIs REST para interagir com Azure DevOps programaticamente.
• Desafios de claims no suporte: A partir da versão 20.259.0, as bibliotecas de clientes .NET agora podem retornar tokens com desafios de claims que podem ser usados para lidar de forma transparente com solicitações de reautenticação após eventos críticos da empresa (por exemplo, redefinições de senha, exclusões de conta etc.) como parte do nosso suporte à Avaliação de Acesso Contínuo. Suporte a Python e Go estará disponível no segundo semestre de 2025.

Tabela de mapeamento de versões entre pacote e Azure DevOps

A tabela a seguir mapeia as versões do pacote das bibliotecas de cliente .NET para as versões correspondentes do Azure DevOps Server. Use esta tabela para determinar qual versão do pacote corresponde à sua versão Azure DevOps.

Para as versões prévias mais recentes, consulte a galeria de pacotes NuGet .

Pacotes REST

A tabela a seguir lista as bibliotecas de cliente .NET disponíveis para acessar vários serviços por meio de APIs REST públicas. Esses pacotes podem ser baixados de NuGet.org e fornecer os binários necessários para integração com Azure DevOps.

Pacote de sabonete

A tabela a seguir lista as bibliotecas de cliente .NET disponíveis para acessar vários serviços por meio de APIs SOAP. Esses pacotes podem ser baixados de NuGet.org e fornecer os binários necessários para integração com Azure DevOps. Use esses pacotes somente quando as APIs REST não oferecerem a funcionalidade necessária, por exemplo, a criação de workspaces no TFVC.

Instalar

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

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Conectar

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

Veja os seguintes exemplos:

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

const string collectionUri = "https://dev.azure.com/fabrikam";
const string projectName = "MyGreatProject";
const string repoName = "MyRepo";
const string accessToken = "your-microsoft-entra-id-token";

Uri orgUrl = new Uri(collectionUri);

// Connect to Azure DevOps using Microsoft Entra ID token
VssConnection connection = new VssConnection(orgUrl, new VssBasicCredential(string.Empty, accessToken));

// 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(projectName, 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 do .NET. Quando você estiver usando a versão .NET Standard, forneça suas credenciais de forma mais explícita para se 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 accessToken = "your-microsoft-entra-id-token";

        static void Main(string[] args)
        {
            var creds = new VssBasicCredential(string.Empty, accessToken);
            
            // Connect to Azure DevOps Services using Microsoft Entra ID token
            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 .NET Samples.

Referência

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

Exemplos

Confira exemplos em nossa página .NET Samples.

Para obter mais informações sobre pacotes NuGet, consulte Microsoft.VisualStudio.Services.Client.

Problemas conhecidos

A caixa de diálogo de autenticação interativa não aparece ao usar o Azure DevOps OM em um STA (apartamento único encadeado)

A caixa de diálogo de autenticação interativa não aparece nos casos em que o código está em execução em um STA (Single Threaded Apartment). Esse problema geralmente pode ocorrer 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);
    CancellationTokenSource source = new CancellationTokenSource();
    CancellationToken token = source.Token;
    await vssConnection.ConnectAsync(token);

    ...

}

Usando as versões do NetStandard 2.0 do OM Azure DevOps

Para a versão 16.143.1 de nossos pacotes NuGet, damos suporte ao NetStandard 2.0. Esses pacotes se correlacionam com Azure DevOps Server e são totalmente compatíveis com Azure DevOps.

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

O Microsoft.TeamFoundationServer.ExtendedClient não dá suporte a uma versão compatível com o NetStandard.

Conteúdo relacionado

• Exemplos de biblioteca cliente .NET
• Diretrizes de autenticação
• Guia de migração do WIT Client OM
• Exemplos de API REST