Azure DevOps .NET 示例项目教程

Azure DevOps .NET 示例项目教程

azure-devops-dotnet-samples.NET/C# samples for integrating with Azure DevOps Services and Azure DevOps Server项目地址:https://gitcode.com/gh_mirrors/az/azure-devops-dotnet-samples

1. 项目的目录结构及介绍

目录结构

azure-devops-dotnet-samples/
├── ClientLibrary/
│   ├── Samples/
│   ├── Quickstarts/
├── ServiceHooks/
│   ├── Utilities/
│   ├── Permissions/
├── .gitignore
├── README.md
├── azure-pipelines.yml
├── LICENSE.md

目录介绍

• ClientLibrary/: 包含示例代码和快速入门程序，展示如何使用 .NET 客户端库与 Azure DevOps 服务和 Azure DevOps Server 进行集成。
  • Samples/: 包含短小的可重用代码块，演示如何调用特定的 API。
  • Quickstarts/: 包含自包含的程序，演示通过调用多个 API 实现特定场景。
• ServiceHooks/: 包含与服务挂钩相关的示例和实用程序。
  • Utilities/: 包含服务挂钩的实用程序代码。
  • Permissions/: 包含与权限相关的代码示例。
• .gitignore: Git 忽略文件配置。
• README.md: 项目说明文档。
• azure-pipelines.yml: Azure Pipelines 配置文件。
• LICENSE.md: 项目许可证文件。

2. 项目的启动文件介绍

启动文件

在 ClientLibrary/Quickstarts/ 目录下，可以找到一些自包含的程序，这些程序通常是项目的启动文件。例如：

using System;
using System.Threading.Tasks;
using Microsoft.TeamFoundation.WorkItemTracking.WebApi;
using Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models;
using Microsoft.VisualStudio.Services.Common;
using Microsoft.VisualStudio.Services.WebApi;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            if (args.Length == 3)
            {
                Uri orgUrl = new Uri(args[0]); // Organization URL, 例如: https://dev.azure.com/fabrikam
                string personalAccessToken = args[1]; // 个人访问令牌
                int workItemId = int.Parse(args[2]); // 工作项 ID

                // 连接到 Azure DevOps
                VssConnection connection = new VssConnection(orgUrl, new VssBasicCredential(string.Empty, personalAccessToken));

                // 获取工作项
                WorkItemTrackingHttpClient workItemTrackingClient = connection.GetClient<WorkItemTrackingHttpClient>();
                WorkItem workItem = workItemTrackingClient.GetWorkItemAsync(workItemId).Result;

                // 显示工作项字段值
                foreach (var field in workItem.Fields)
                {
                    Console.WriteLine($"{field.Key}: {field.Value}");
                }
            }
            else
            {
                Console.WriteLine("参数错误: 需要三个参数 (组织 URL, 个人访问令牌, 工作项 ID)");
            }
        }
    }
}

启动文件介绍

上述代码是一个简单的控制台程序，它连接到 Azure DevOps 并显示指定工作项的字段值。启动文件通常包含以下内容：

• 参数处理: 处理命令行参数，如组织 URL、个人访问令牌和工作项 ID。
• 连接到 Azure DevOps: 使用 VssConnection 类连接到 Azure DevOps。
• 获取工作项: 使用 WorkItemTrackingHttpClient 类获取指定的工作项。
• 显示工作项字段值: 遍历工作项的字段并显示其值。

3. 项目的配置文件介绍

配置文件

• azure-pipelines.yml: Azure Pipelines 配置文件，用于定义 CI/CD 流水线。

trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

steps:
- script: echo Hello, world!
  displayName: 'Run a one-line script'

- script: |
    echo Add other tasks to build, test, and deploy your project.
    echo See https://aka.ms/yaml
  displayName: 'Run a multi-line script'

配置文件介绍

• 触发器: 定义触发流水线的分支，例如 main 分支。
• 池:

azure-devops-dotnet-samples.NET/C# samples for integrating with Azure DevOps Services and Azure DevOps Server项目地址:https://gitcode.com/gh_mirrors/az/azure-devops-dotnet-samples