Bibliothèques clientes .NET

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

Les bibliothèques clientes sont disponibles pour les développeurs .NET qui créent des applications et des services Windows qui s’intègrent à Azure DevOps. Les bibliothèques clientes s’intègrent au suivi des éléments de travail, au contrôle de version, à la génération et à d’autres services. Ces packages remplacent le programme d’installation de l’om client TFS traditionnel et facilitent l’acquisition et la redistribution des bibliothèques nécessaires par votre application ou service.

Diagramme de dépendances

Fonctionnalités

• Téléchargeable à partir de NuGet.org et facilement importable dans vos projets Visual Studio
• Les bibliothèques sont concédées sous licence pour la redistribution dans vos applications et services (voir la licence)
• Accéder aux API de modèle objet client traditionnelles et aux API REST

Table de mappage de versions d’Azure DevOps et de package

Pour connaître les dernières versions préliminaires, consultez la galerie de packages NuGet.

Packages REST

Package Soap

Installer

Installer à partir d’une invite de commandes du gestionnaire de package NuGet :

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Se connecter

Pour créer une connexion authentifiée à Azure DevOps, obtenez un HttpClient pour le service avec lequel vous souhaitez travailler, puis appelez des méthodes sur ce service.

Voici des exemples :

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

Les chemins d’authentification qui produisent une boîte de dialogue interactive ne sont pas disponibles dans la version .NET Standard des bibliothèques clientes .NET. Lorsque vous utilisez la version .NET Standard, fournissez vos informations d’identification plus explicitement pour vous authentifier, comme dans l’exemple suivant.

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

Pour plus d’exemples d’authentification, consultez les exemples .NET.

Référence

Pour plus d’informations et pour obtenir une documentation de référence à jour, consultez le navigateur d’API .NET.

Exemples

Consultez des exemples sur notre page d’exemples .NET ou directement sur notre dépôt GitHub .NET.

Problèmes connus

La boîte de dialogue d’authentification interactive n’apparaît pas lors de l’utilisation de l’om Azure DevOps dans un seul appartement threaded (STA)

La boîte de dialogue d’authentification interactive n’apparaît pas dans les cas où votre code s’exécute à partir d’un seul appartement threaded (STA). Ce problème peut généralement se produire à partir d’applications WPF . Pour contourner ce problème, vous pouvez modifier votre méthode d’initialisation pour qu’elle soit asynchrone et demander l’authentification comme dans l’exemple suivant.

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

    ...

}

Utilisation des versions de NetStandard 2.0 de l’om Azure DevOps

Pour la version 16.143.1 de nos packages NuGet, nous prenons en charge NetStandard 2.0. Ces packages sont corrélés avec Azure DevOps Server 2019 RTW et sont entièrement compatibles avec Azure DevOps.

Le package Microsoft.TeamFoundationServer.ExtendedClient ne prend pas en charge NetStandard

Microsoft.TeamFoundationServer.ExtendedClient ne prend pas en charge une version conforme à NetStandard.