Librerie client .NET

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

Le librerie client sono disponibili per gli sviluppatori .NET che creano app e servizi Windows che si integrano con Azure DevOps. Le librerie client si integrano con il rilevamento degli elementi di lavoro, il controllo della versione, la compilazione e altri servizi. Questi pacchetti sostituiscono il tradizionale programma di installazione di TFS Client OM e semplificano l'acquisizione e la ridistribuzione delle librerie necessarie per l'app o il servizio.

Diagramma delle dipendenze

Funzionalità

• Scaricabile da NuGet.org e facilmente importabile nei progetti di Visual Studio
• Le librerie sono concesse in licenza per la ridistribuzione nelle app e nei servizi (visualizzare la licenza)
• Accedere alle API del modello a oggetti client tradizionali e alle API REST

Tabella di mapping delle versioni di Package e Azure DevOps

Per le versioni di anteprima più recenti, vedere la raccolta di pacchetti NuGet.

Pacchetti REST

Pacchetto Soap

Installare

Eseguire l'installazione da un prompt dei comandi di Gestione pacchetti NuGet:

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Connessione

Per creare una connessione autenticata ad Azure DevOps, ottenere un HttpClient per il servizio da usare e quindi chiamare i metodi per tale servizio.

Vedere gli esempi seguenti:

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

I percorsi di autenticazione che producono una finestra di dialogo interattiva non sono disponibili nella versione .NET Standard delle librerie client .NET. Quando si usa la versione .NET Standard, specificare le credenziali in modo più esplicito per l'autenticazione, come nell'esempio seguente.

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

Per altri esempi di autenticazione, vedere Esempi di .NET.

Riferimento

Per altre informazioni e per la documentazione di riferimento aggiornata, vedere browser API .NET.

Esempi

Vedere gli esempi nella pagina degli esempi .NET o direttamente nel repository GitHub .NET.

Problemi noti

La finestra di dialogo di autenticazione interattiva non viene visualizzata quando si usa l'om di Azure DevOps in un apartment a thread singolo (STA)

La finestra di dialogo di autenticazione interattiva non viene visualizzata nei casi in cui il codice è in esecuzione da un apartment a thread singolo (STA). Questo problema può verificarsi comunemente dalle applicazioni WPF . Per risolvere questo problema, è possibile modificare il metodo di inizializzazione in modo che sia asincrono e richiedere l'autenticazione come nell'esempio seguente.

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();

    ...

}

Uso di NetStandard 2.0 delle versioni di Azure DevOps OM

Per la versione 16.143.1 dei pacchetti NuGet, è supportato NetStandard 2.0. Questi pacchetti sono correlati ad Azure DevOps Server 2019 RTW e sono completamente compatibili con Azure DevOps.

Il pacchetto Microsoft.TeamFoundationServer.ExtendedClient non supporta NetStandard

Microsoft.TeamFoundationServer.ExtendedClient non supporta una versione conforme a NetStandard.