Azure Pipelines 服务端任务开发指南

Azure Pipelines 服务端任务开发指南

azure-pipelines-tasks Tasks for Azure Pipelines 项目地址: https://gitcode.com/gh_mirrors/az/azure-pipelines-tasks

前言

在现代持续集成和持续交付(CI/CD)流程中，Azure Pipelines 提供了强大的自动化能力。其中，服务端任务(Server Task)是一种特殊类型的任务，它直接在 Azure Pipelines/TFS 服务器上执行，而不需要依赖代理(Agent)。本文将深入探讨服务端任务的开发方法、特点以及最佳实践。

服务端任务与代理任务的区别

服务端任务与传统的代理任务有几个关键区别：

1. 执行位置：服务端任务直接在服务器上运行，而代理任务在构建代理上执行
2. 资源消耗：服务端任务不占用代理资源
3. 适用场景：服务端任务适合轻量级操作，如API调用、服务总线消息发布等

核心配置属性

RunsOn 属性

在任务配置文件(task.json)中，RunsOn属性决定了任务的执行位置：

• Agent：默认值，表示在构建代理上运行
• DeploymentGroup：在部署组上运行
• Server：在服务器上运行
• ServerGate：作为门控任务在服务器上运行
• Server | ServerGate：同时作为普通任务和门控任务

执行方式

服务端任务支持三种主要的执行方式：

1. HTTP请求(HttpRequest)

适用于调用REST API的场景，包含三个主要部分：

Execute部分：

• EndpointId：用于生成认证头的端点ID（可选）
• EndpointURL：要调用的HTTP URL
• Method：HTTP方法（GET/POST/PUT等）
• Body：请求体内容
• Headers：请求头（JSON格式）
• WaitForCompletion：是否等待外部服务完成任务（默认false）
• Expression：用于判断任务是否成功的表达式

表达式示例：

eq(root['status'], 'successful')  // 检查状态是否为"successful"
ge(count(root['ActiveReleaseNames']), 3)  // 检查ActiveReleaseNames数量是否≥3

Cancel部分： 定义任务取消时应执行的操作，结构与Execute类似

Events部分： 用于异步任务的状态更新，支持的事件类型包括：

• TaskAssigned（可选）
• TaskStarted
• TaskCompleted

2. 服务总线(ServiceBus)

适用于向Azure服务总线发布消息的场景：

Execute部分：

• EndpointId：服务总线或AzureRM服务连接
• ConnectionString：服务总线连接字符串
• ServiceBusQueueName：队列名称
• Namespace：服务总线命名空间
• MessageBody：消息体（JSON格式）
• MessageProperties：消息属性（JSON格式）

3. HTTP请求链(HttpRequestChain)

适用于需要按顺序调用多个API的场景，每个调用包含：

RequestInputs： 定义请求的基本参数，与HttpRequest的Execute部分类似

ExecutionOptions：

• OutputVariables：定义输出变量供后续调用使用
• SkipSectionExpression：定义跳过当前调用的条件表达式

开发技巧与最佳实践

1. 变量使用：可以在任务配置中使用多种变量类型：

   • 任务输入变量
   • 系统变量（如system.TeamProjectId）
   • 用户自定义变量
   • 端点变量

2. 执行模式选择：

   • 同步模式：适合快速完成的请求（<20秒）
   • 异步模式：适合长时间运行的任务（设置WaitForCompletion=true）

3. 任务限制：

   • 服务端任务不能运行在代理或部署组上
   • 最大超时时间为72小时

内置服务端任务示例

Azure Pipelines提供了多个内置的服务端任务，开发者可以参考这些实现：

1. HTTP请求类：

   • InvokeRestApi：调用REST API
   • AzureMonitor：Azure监控相关操作
   • AzureFunction：调用Azure函数
   • QueryWorkItems：查询工作项

2. 服务总线类：

   • PublishToAzureServiceBus：发布消息到服务总线

3. 门控类：

   • AzurePolicy：Azure策略检查

总结

服务端任务是Azure Pipelines中强大的功能组件，特别适合不需要构建代理参与的轻量级操作。通过合理使用HTTP请求、服务总线等功能，开发者可以创建高效、可靠的自动化流程。理解服务端任务的特性和限制，将帮助您设计出更优的CI/CD解决方案。

希望本指南能帮助您顺利开发Azure Pipelines服务端任务。在实际开发中，建议参考官方实现并结合具体业务需求进行设计。

azure-pipelines-tasks Tasks for Azure Pipelines 项目地址: https://gitcode.com/gh_mirrors/az/azure-pipelines-tasks