.NET-Clientbibliotheken

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

Clientbibliotheken sind für .NET-Entwickler verfügbar, die Windows-Apps und -Dienste erstellen, die in Azure DevOps integriert sind. Clientbibliotheken sind in die Nachverfolgung von Arbeitsaufgaben, die Versionsverwaltung, den Build und andere Dienste integriert. Diese Pakete erleichtern das Abrufen und Erneutverteilen der Bibliotheken, die von Ihrer App oder Ihrem Dienst benötigt werden.

Abhängigkeitsdiagramm

Features von .NET-Clientbibliotheken

Die .NET-Clientbibliotheken für Azure DevOps bieten mehrere wichtige Features, die die Integration in Dienste in Azure DevOps aus Ihren Windows-Anwendungen und -Diensten erleichtern:

• Aus NuGet.orgherunterladen: Importieren Sie die Bibliotheken ganz einfach in Ihre Visual Studio-Projekte, indem Sie sie aus NuGet.orgherunterladen.
• Lizenziert für die Umverteilung: Die Bibliotheken werden für die Umverteilung in Ihren Apps und Diensten lizenziert. Sie können die Lizenz anzeigen, um weitere Details zu erhalten.
• Zugriff auf APIs: Zugriff auf herkömmliche Clientobjektmodell-APIs und REST-APIs für die programmgesteuerte Interaktion mit Azure DevOps.
• Unterstützung von Anspruchsherausforderungen: Ab Version 20.259.0 können .NET-Clientbibliotheken Tokens mit Anspruchsherausforderungen zurückgeben, die verwendet werden können, um Anforderungen zur erneuten Authentifizierung nach kritischen Unternehmensereignissen (z. B. Kennwortzurücksetzungen, Kontolöschungen usw.) im Rahmen unserer Unterstützung für die Kontinuierliche Zugriffsbewertung ordnungsgemäß zu verarbeiten. Die Unterstützung für Python und Go wird in der zweiten Hälfte des Jahres 2025 kommen.

Paket- und Azure DevOps-Versionszuordnungstabelle

Die folgende Tabelle ordnet die Paketversionen der .NET-Clientbibliotheken den entsprechenden Versionen von Azure DevOps Server zu. Verwenden Sie diese Tabelle, um zu bestimmen, welche Paketversion Ihrer Azure DevOps-Version entspricht.

Die neuesten Vorschauversionen finden Sie im NuGet-Paketkatalog.

REST-Pakete

In der folgenden Tabelle sind die .NET-Clientbibliotheken aufgeführt, die für den Zugriff auf verschiedene Dienste über öffentliche REST-APIs verfügbar sind. Diese Pakete können von NuGet.org heruntergeladen werden und stellen die erforderlichen Binärdateien bereit, die in Azure DevOps integriert werden können.

Seifenverpackung

In der folgenden Tabelle sind die .NET-Clientbibliotheken aufgeführt, die für den Zugriff auf verschiedene Dienste über SOAP-APIs verfügbar sind. Diese Pakete können von NuGet.org heruntergeladen werden und stellen die erforderlichen Binärdateien bereit, die in Azure DevOps integriert werden können. Verwenden Sie diese Pakete nur, wenn die REST-APIs nicht die benötigten Funktionen bieten, z. B. das Erstellen von Arbeitsbereichen in TFVC.

Installieren

Installieren Sie über die Eingabeaufforderung des NuGet-Paket-Managers:

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Verbinden

Um eine authentifizierte Verbindung mit Azure DevOps zu erstellen, rufen Sie einen HttpClient für den Dienst ab, mit dem Sie arbeiten möchten, und rufen Sie dann Methoden für diesen Dienst auf.

Sehen Sie sich die folgenden Beispiele an:

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

Authentifizierungspfade, die ein interaktives Dialogfeld erzeugen, sind in der .NET Standard-Version der .NET-Clientbibliotheken nicht verfügbar. Wenn Sie die .NET Standard-Version verwenden, geben Sie Ihre Anmeldeinformationen expliziter für die Authentifizierung an, z. B. im folgenden Beispiel.

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

Weitere Authentifizierungsbeispiele finden Sie unter .NET Samples.

Referenz

Weitere Informationen und eine aktuelle Referenzdokumentation finden Sie unter .NET-API-Browser.

Beispiele

Sehen Sie sich Beispiele auf unserer .NET-Beispielseite an.

Weitere Informationen zu NuGet-Paketen finden Sie unter Microsoft.VisualStudio.Services.Client.

Bekannte Probleme

Das Dialogfeld "Interaktive Authentifizierung" wird nicht angezeigt, wenn Sie das Azure DevOps-OM in einem Single Threaded Apartment (STA) verwenden.

Das Dialogfeld für die interaktive Authentifizierung wird in Fällen nicht angezeigt, in denen Ihr Code von einem Single Threaded Apartment (STA) ausgeführt wird. Dieses Problem kann häufig bei WPF--Anwendungen auftreten. Um dieses Problem zu umgehen, können Sie die Initialisierungsmethode so ändern, dass sie asynchron ist und die Authentifizierung anfordert, wie im folgenden Beispiel gezeigt.

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

    ...

}

Verwenden von NetStandard 2.0-Versionen des Azure DevOps-OM

Für Version 16.143.1 unserer NuGet-Pakete unterstützen wir NetStandard 2.0. Diese Pakete korrelieren mit Azure DevOps Server und sind vollständig mit Azure DevOps kompatibel.

Microsoft.TeamFoundationServer.ExtendedClient-Paket hat keine NetStandard-Unterstützung

Die Microsoft.TeamFoundationServer.ExtendedClient- unterstützt keine NetStandard-kompatible Version.