klientské knihovny .NET

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

Klientské knihovny jsou k dispozici pro .NET vývojáře, kteří vytvářejí Windows aplikace a služby, které se integrují s Azure DevOps. Klientské knihovny se integrují se sledováním pracovních položek, správou verzí, sestavením a dalšími službami. Tyto balíčky usnadňují získání a redistribuci knihoven potřebných vaší aplikací nebo službou.

Návod

Najděte odpovídající .NET klientskou třídu a metodu rozhraní API pomocí ukázek klientské knihovny .NET a Azure DevOps reference k rozhraní API.

Diagram závislostí

Diagram závislostí znázorňuje vztah mezi Services.Client, Services.InteractiveClient a TeamFoundationServer.Client.

Funkce klientských knihoven .NET

Klientské knihovny .NET pro Azure DevOps nabízejí několik klíčových funkcí, které usnadňují integraci se službami v Azure DevOps z aplikací a služeb Windows:

Ke stažení z NuGet.org: Knihovny můžete snadno importovat do svých projektů aplikace Visual Studio stažením knihoven z NuGet.org.
Licencováno pro redistribuci: Knihovny jsou licencované k redistribuci ve vašich aplikacích a službách. Další podrobnosti najdete v licenci .
Access k rozhraním API: Získejte přístup k rozhraním API tradičního klientského objektového modelu i k rozhraním API REST API pro interakci s Azure DevOps programově.
Výzvy ohledně claims: Od verze 20.259.0 mohou .NET klientské knihovny nyní vracet tokeny s výzvami k oprávnění, které lze použít k efektivnímu zpracování žádostí o opětovné ověření po důležitých událostech společnosti (například resetování hesla, odstranění účtu atd.) jako součást naší podpory pro Průběžné hodnocení přístupu. Podpora pro Python a Go přijde ve druhé polovině roku 2025.

Tabulka mapování verzí balíčků a Azure DevOps verzí

Následující tabulka mapuje verze balíčků klientských knihoven .NET na odpovídající verze Azure DevOps Server. Pomocí této tabulky určete, která verze balíčku odpovídá vaší verzi Azure DevOps.

Verze balíčku	verze Azure DevOps
16.205.x	`versions >= Azure DevOps Server 2022`
16.170.x	`versions >= Azure DevOps Server 2020`

Nejnovější verze Preview najdete v galerii balíčků NuGet.

Balíčky REST

Následující tabulka uvádí .NET klientské knihovny dostupné pro přístup k různým službám prostřednictvím veřejných rozhraní REST API. Tyto balíčky je možné stáhnout z NuGet.org a poskytnout potřebné binární soubory pro integraci s Azure DevOps.

Balíčky a popis	Binární soubory
Microsoft.VisualStudio.Services.Client Poskytuje přístup ke sdíleným službám platformy prostřednictvím veřejných rozhraní REST API, jako jsou organizace, profil, identita, zabezpečení a další.	`Microsoft.VisualStudio.Services.WebApi.dll`, `Microsoft.VisualStudio.Services.Common.dll`, `Microsoft.TeamFoundation.Common.dll`
Microsoft.TeamFoundationServer.Client Poskytuje přístup ke správě verzí, sledování pracovních položek, sestavení a dalším prostřednictvím veřejných rozhraní REST API.	`Microsoft.TeamFoundation.Build2.WebApi.dll`, `Microsoft.TeamFoundation.Core.WebApi.dll`, `Microsoft.TeamFoundation.WorkItemTracking.Process.WebApi.dll`, `Microsoft.TeamFoundation.SourceControl.WebApi.dll`, `Microsoft.TeamFoundation.TestManagement.WebApi.dll`a tak dále.
Microsoft.VisualStudio.Services.InteractiveClient Podporuje aplikace, které vyžadují interaktivní přihlášení uživatelem.	`Microsoft.VisualStudio.Services.Client.Interactive.dll`
Microsoft.VisualStudio.Services.Release.Client Poskytuje přístup ke službě Release Service prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.dll`
Microsoft.TeamFoundation.DistributedTask.Common.Contracts Poskytuje modely používané pro přístup ke službě distribuovaných úloh prostřednictvím veřejných rozhraní REST API.	`Microsoft.TeamFoundation.DistributedTask.Common.Contracts.dll`
Microsoft.TeamFoundation.DistributedTask.WebApi Poskytuje přístup k distribuované službě úloh prostřednictvím veřejných rozhraní REST API.	`Microsoft.TeamFoundation.DistributedTask.WebApi.dll`
Microsoft.VisualStudio.Services.ServiceHooks.WebApi Poskytuje přístup ke službě Service Hooks Service prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.ServiceHooks.WebApi.dll`
Microsoft.VisualStudio.Services.Gallery.WebApi Poskytuje přístup ke službě galerie prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.Gallery.WebApi.dll`
Microsoft.VisualStudio.Services.Notifications.WebApi Poskytuje přístup ke službě Oznámení prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.Notifications.WebApi.dll`
Microsoft.VisualStudio.Services.ExtensionManagement.WebApi Poskytuje přístup ke službě Správa rozšíření prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.ExtensionManagement.WebApi.dll`
Microsoft.VisualStudio.Services.MemberEntitlementManagement.WebApi Poskytuje přístup ke službě Správa nároků člena prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.MemberEntitlementManagement.WebApi.dll`
Microsoft.VisualStudio.Services.ServiceEndpoints.WebApi Poskytuje přístup ke koncovým bodům služby prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.ServiceEndpoints.WebApi.dll`
Microsoft.VisualStudio.Services.Search.Client Poskytuje přístup k vyhledávací službě prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.Search.Shared.WebApi.dll`, `Microsoft.VisualStudio.Services.Search.WebApi.dll`
Microsoft.TeamFoundation.PublishTestResults Tuto úlohu lze použít k publikování výsledků testů a nahrání testovacích příloh na Azure DevOps. Tento balíček podporuje následující formáty výsledků: 1. JUnit – publikování testů z projektů JUnit, 2. NUnit - publikování testů z projektů NUnit, 3. VSTest – publikování testů z projektů Visual Studio, 4. Xunit – publikování testů z projektů Xunit	`Microsoft.TeamFoundation.TestClient.PublishTestResults.dll`
Microsoft.VisualStudio.Services.Audit.WebApi Poskytuje přístup ke službě auditování prostřednictvím veřejných rozhraní REST API.	`Microsoft.VisualStudio.Services.Audit.WebApi.dll`
Microsoft. Azure. Pipelines.Policy.Client Poskytuje přístup ke schválení, kontrolám a autorizaci potrubí prostřednictvím veřejných REST API rozhraní.	`Microsoft.Azure.Pipelines.Policy.Client.dll`

Návod

Legacy SOAP API: Pokud máte existující Windows aplikaci, která používá objektový model klienta TFS, použijte Microsoft.TeamFoundationServer.ExtendedClient pro rozhraní API založená na protokolu SOAP. Tento balíček se doporučuje jenom v případě, že rozhraní REST API neposkytují konkrétní funkce, které potřebujete (například vytvoření pracovního prostoru TFVC). Tento balíček nepodporuje .NET Standard a Microsoft už ne investuje do rozhraní API založených na protokolu SOAP.

Balíček mýdla

Následující tabulka uvádí .NET klientské knihovny dostupné pro přístup k různým službám prostřednictvím rozhraní API SOAP. Tyto balíčky je možné stáhnout z NuGet.org a poskytnout potřebné binární soubory pro integraci s Azure DevOps. Tyto balíčky používejte jenom v případě, že rozhraní REST API nenabízí funkce, které potřebujete, například vytváření pracovních prostorů v TFVC.

Balíček a popis	Binární soubory
Microsoft.TeamFoundationServer.ExtendedClient Pracujte se správou verzí, pracovními položkami, sestavením a dalšími prostředky z klientské aplikace a spravujte je. Tento balíček nepodporuje OM klienta Net Standard. Tento balíček použijte jenom v případě, že naše rozhraní REST API nenabízí funkce, které potřebujete (například vytváření pracovních prostorů v TFVC).	`Microsoft.TeamFoundation.Build.Client.dll`, `Microsoft.TeamFoundation.DeleteTeamProject.dll`, `Microsoft.TeamFoundation.Diff.dll`, `Microsoft.TeamFoundation.Git.Client.dll`, `Microsoft.TeamFoundation.SharePointReporting.Integration.dll`a tak dále.

Instalovat

Nainstalujte z příkazového řádku správce balíčků NuGet:

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Připojit

Pokud chcete vytvořit ověřené připojení k Azure DevOps, získejte httpClient pro službu, se kterou chcete pracovat, a pak volejte metody proti této službě.

Podívejte se na následující příklady:

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

Cesty ověřování, které vytvářejí interaktivní dialog, nejsou k dispozici v .NET standardní verzi klientských knihoven .NET. Pokud používáte verzi .NET Standard, zadejte přihlašovací údaje explicitněji k ověření, například v následujícím příkladu.

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

Návod

Ověřování identity Microsoft Entra ID: V předchozích příkladech se k ověřování identity používají tokeny Microsoft Entra ID. Další informace najdete v tématu Authenticate Azure DevOps pomocí Microsoft Entra.

Další ukázky ověřování najdete v tématu .NET Samples.

Odkazy

Další informace a aktuální referenční dokumentaci najdete v prohlížeči rozhraní API .NET.

Vzorky

Podívejte se na ukázky na naší stránce ukázek .NET.

Další informace o balíčcích NuGet naleznete v tématu Microsoft.VisualStudio.Services.Client.

Známé problémy

Dialogové okno interaktivního ověřování se nezobrazuje při použití Azure DevOps OM v apartmánu s jedním vláknem (STA)

Dialogové okno interaktivního ověřování se nezobrazuje v případech, kdy váš kód běží z jednovláknového apartmánu (STA). K tomuto problému často dochází z aplikací WPF (Windows Presentation Foundation). Chcete-li tento problém vyřešit, můžete změnit inicializační metodu tak, aby byla asynchronní a vyžaduje ověřování jako v následujícím příkladu.

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

    ...

}

Použití verzí NetStandard 2.0 v rámci Azure DevOps OM

Pro naše balíčky NuGet verze 16.143.1 podporujeme NetStandard 2.0. Tyto balíčky korelují s Azure DevOps Server a jsou plně kompatibilní s Azure DevOps.

Balíček Microsoft.TeamFoundationServer.ExtendedClient nemá podporu NetStandard

Microsoft.TeamFoundationServer.ExtendedClient nepodporuje verzi kompatibilní s netStandardem.

Důležité

Tento balíček obsahuje náš starší objektový model SOAP, který jsme nahradili novějším objektový model REST. Už neinvestujeme do staršího objektového modelu SOAP a nemáme v plánu vytvořit verzi NetStandard.

Váš názor

Byla tato stránka užitečná?

Last updated on 2026-03-11

klientské knihovny .NET

Diagram závislostí

Funkce klientských knihoven .NET

Tabulka mapování verzí balíčků a Azure DevOps verzí

Balíčky REST

Balíček mýdla

Instalovat

Připojit

Odkazy

Vzorky

Známé problémy

Dialogové okno interaktivního ověřování se nezobrazuje při použití Azure DevOps OM v apartmánu s jedním vláknem (STA)

Použití verzí NetStandard 2.0 v rámci Azure DevOps OM

Balíček Microsoft.TeamFoundationServer.ExtendedClient nemá podporu NetStandard

Související obsah

Váš názor

Další materiály