Клиентские библиотеки .NET

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

Клиентские библиотеки доступны разработчикам .NET, создающим приложения и службы Windows, которые интегрируются с Azure DevOps. Клиентские библиотеки интегрируются с отслеживанием рабочих элементов, управлением версиями, сборкой и другими службами. Эти пакеты упрощают получение и распространение библиотек, необходимых приложению или службе.

Схема зависимостей

Функции клиентских библиотек .NET

Клиентские библиотеки .NET для Azure DevOps предлагают несколько ключевых функций, которые упрощают интеграцию со службами в Azure DevOps из приложений и служб Windows:

• Можно скачать с NuGet.org: Легко импортируйте библиотеки в проекты Visual Studio, скачивая их с NuGet.org.
• Лицензированные для распространения: библиотеки лицензированы для распространения в ваших приложениях и сервисах. Вы можете просмотреть лицензию для получения дополнительной информации.
• Доступ к API: Получите доступ к традиционным API-интерфейсам клиентской объектной модели и REST API для программного взаимодействия с Azure DevOps.

Таблица сопоставления версий пакета и Azure DevOps

В следующей таблице сопоставляется версии пакетов клиентских библиотек .NET с соответствующими версиями Azure DevOps Server. Используйте эту таблицу, чтобы определить, какая версия пакета соответствует вашей версии Azure DevOps.

Свежие предварительные версии можно найти в галерее пакетов NuGet #B0 #A1.

Пакеты REST

В следующей таблице перечислены клиентские библиотеки .NET, доступные для доступа к различным службам через общедоступные ИНТЕРФЕЙСы REST API. Эти пакеты можно скачать из NuGet.org и предоставить необходимые двоичные файлы для интеграции с Azure DevOps.

Упаковка мыла

В следующей таблице перечислены клиентские библиотеки .NET, доступные для доступа к различным службам через API SOAP. Эти пакеты можно скачать из NuGet.org и предоставить необходимые двоичные файлы для интеграции с Azure DevOps. Используйте только эти пакеты, если интерфейсы REST API не предлагают необходимые функциональные возможности, например создание рабочих областей в TFVC.

Установка

Установите из командной строки диспетчера пакетов NuGet:

PM> Install-Package Microsoft.TeamFoundationServer.ExtendedClient

Подключиться

Чтобы создать аутентифицированное подключение к Azure DevOps, получите HttpClient для службы, с которой вы хотите работать, а затем вызовите методы этой службы.

См. следующие примеры.

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

Пути проверки подлинности, создающие интерактивное диалоговое окно, недоступны в версии .NET Standard клиентских библиотек .NET. При использовании версии .NET Standard укажите учетные данные более явно для проверки подлинности, как показано в следующем примере.

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

Дополнительные примеры проверки подлинности см. в разделе Примеры .NET.

Ссылка

Дополнительные сведения и справочные материалы по up-to-date см. в браузере API .NET.

Образцы

Ознакомьтесь с примерами на нашей странице примеров .NET или непосредственно в нашем репозитории .NET GitHub.

Дополнительные сведения о пакетах NuGet см. в Microsoft.VisualStudio.Services.Client.

Известные проблемы

Диалоговое окно интерактивной проверки подлинности не отображается при использовании Azure DevOps OM в однопоточной модели (STA).

Диалоговое окно интерактивной аутентификации не отображается в случаях, когда ваш код выполняется в Single Threaded Apartment (STA). Эта проблема часто возникает в WPF приложениях. Чтобы обойти эту проблему, можно изменить метод инициализации на асинхронную и запрашивать проверку подлинности, как показано в следующем примере.

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

    ...

}

Использование NetStandard 2.0 версий OM Azure DevOps

Для версии 16.143.1 пакетов NuGet мы поддерживаем NetStandard 2.0. Эти пакеты коррелируются с Azure DevOps Server 2019 RTW и полностью совместимы с Azure DevOps.

Пакет Microsoft.TeamFoundationServer.ExtendedClient не поддерживает NetStandard

Microsoft.TeamFoundationServer.ExtendedClient не поддерживает версию с поддержкой NetStandard.