通过

服务挂钩使用者

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

使用服务挂钩使用者 以编程方式创建订阅。 订阅指定事件、使用者和操作。

从以下使用者中选择要在订阅中使用的使用者。 有关可用服务的详细信息，请参阅 与服务挂钩集成、可用服务。

Azure 服务总线

提供与Microsoft Azure 服务总线（包括通知中心）的集成。

向通知中心发送消息

此操作将泛型模板通知发送到指定的 Azure 通知中心。 有关详细信息，请参阅概述。

  • 使用者 ID： azureServiceBus
  • 操作 ID： serviceBusNotificationHubSend
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • connectionString
      • SAS 连接字符串
      • SAS (共享访问签名) 用于连接Azure 服务总线的连接字符串。 此连接字符串在Azure 门户中可用。
      • 数据类型： 字符串
      • 必需： 是
    • notificationHubName
      • 通知中心名称
      • 要向其发送通知的通知中心的名称。 名称只能包含字母、数字、句点、连字符、正斜杠和下划线。 名称必须以字母或数字开头和结尾。 中心应已存在。
      • 数据类型： 字符串
      • 必需： 是
    • tagsExpression
      • Tags
      • 标记表达式 (，用于面向特定设备集) 。 了解详细信息。
      • 数据类型： 字符串
      • 必需： 否

向服务总线队列发送消息

此操作将事件的 JSON 字符串表示形式发送到指定的Azure 服务总线队列。 有关详细信息，请参阅 服务总线队列、文章和订阅。

  • 使用者 ID： azureServiceBus
  • 操作 ID： serviceBusQueueSend
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • connectionString
      • SAS 连接字符串
      • SAS (共享访问签名) 用于连接Azure 服务总线的连接字符串。 此连接字符串在Azure 门户中可用。
      • 数据类型： 字符串
      • 必需： 是
    • queueName
      • 队列名称
      • 要向其发送消息的队列的名称。 名称只能包含字母、数字、句点、连字符、正斜杠和下划线。 名称必须以字母或数字开头和结尾。 如果队列不存在，则在指定的连接字符串具有必要权限时创建队列。
      • 数据类型： 字符串
      • 必需： 是
    • resourceDetailsToSend
      • 要发送的资源详细信息
      • 控制要发送的资源字段
      • 数据类型： 字符串
      • 必需： 否
    • messagesToSend
      • 要发送的消息
      • 控制要发送的消息
      • 数据类型： 字符串
      • 必需： 否
    • detailedMessagesToSend
      • 要发送的详细消息
      • 控制要发送的详细消息
      • 数据类型： 字符串
      • 必需： 否

向服务总线主题发送消息

此操作将事件的 JSON 字符串表示形式发送到指定的Azure 服务总线主题。 有关详细信息，请参阅使用Azure 门户创建服务总线主题和订阅主题。

  • 使用者 ID： azureServiceBus
  • 操作 ID： serviceBusTopicSend
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • connectionString
      • SAS 连接字符串
      • SAS (共享访问签名) 用于连接Azure 服务总线的连接字符串。 此连接字符串在Azure 门户中可用。
      • 数据类型： 字符串
      • 必需： 是
    • topicName
      • 主题名称
      • 要向其发送消息的主题的名称。 名称只能包含字母、数字、句点、连字符、正斜杠和下划线。 名称必须以字母或数字开头和结尾。 如果主题不存在，则在指定的连接字符串具有必要权限时创建该主题。
      • 数据类型： string
      • 必需： 是
    • resourceDetailsToSend
      • 要发送的资源详细信息
      • 控制要发送的资源字段
      • 数据类型： 字符串
      • 必需： 否
    • messagesToSend
      • 要发送的消息
      • 控制要发送的消息
      • 数据类型： 字符串
      • 必需： 否
    • detailedMessagesToSend
      • 要发送的详细消息
      • 控制要发送的详细消息
      • 数据类型： 字符串
      • 必需： 否

Azure 存储

提供与 Microsoft Azure 存储 的集成。

在存储队列中插入消息

此操作会将事件的 JSON 字符串表示形式插入到指定的 Azure 存储队列。 有关详细信息，请参阅 什么是 Azure 队列？。

  • 使用者 ID： azureStorageQueue
  • 操作 ID： 排队
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • accountName
      • 存储帐户名称
      • 与 Azure 存储帐户关联的名称 (例如， https://STORAGE_ACCOUNT_NAME.queue.core.windows.net) 。
      • 数据类型： string
      • 必需： 是
    • accountKey
      • 存储帐户密钥
      • 与 Azure 存储帐户关联的密钥。
      • 数据类型： string
      • 必需： 是
    • queueName
      • 队列名称
      • 在 Azure 存储中使用的队列的仅小写名称。 如果队列尚不存在，则创建此名称的队列。
      • 数据类型： string
      • 必需： 是
    • visiTimeout
      • 消息可见性超时 (（秒) ）
      • 指定排队消息相对于服务器时间的可见性超时值（以秒为单位）。 该值必须大于或等于 0，并且不能大于 7 天或 604，800 秒。 可见性超时值必须设置为小于消息生存时间值的值。
      • 数据类型： 数字
      • 必需： 是
    • ttl
      • 消息生存时间 (（以秒为单位）)
      • 指定队列消息的生存时间间隔（以秒为单位）。 允许的最大生存时间为 7 天或 604，800 秒。
      • 数据类型： 数字
      • 必需： 是
    • resourceDetailsToSend
      • 要发送的资源详细信息
      • 控制要发送的资源字段
      • 数据类型： 字符串
      • 必需： 否
    • messagesToSend
      • 要发送的消息
      • 控制要发送的消息
      • 数据类型： 字符串
      • 必需： 否
    • detailedMessagesToSend
      • 要发送的详细消息
      • 控制要发送的详细消息
      • 数据类型： 字符串
      • 必需： 否

Jenkins

Jenkins 是一种持续集成服务器，允许持续生成和测试软件项目。

触发 Git 生成

使用 Jenkins Git 插件触发配置为使用 Git 存储库的生成。

  • 使用者 ID： jenkins
  • 操作 ID： triggerGitBuild
  • 支持的事件： git.push
  • 设置：
    • serverBaseUrl
      • Jenkins 基 URL
      • 托管 Jenkins 服务器的基 URL
      • 数据类型： uri
      • 必需： 是
    • username
      • 用户名
      • 允许触发生成的用户的 Jenkins 用户名
      • 数据类型： string
      • 必需： 是
    • password
      • 用户 API 令牌 (或密码)
      • 用户的 API 令牌，可在 Jenkins 用户配置页中找到。 API 令牌是自版本 1.426 以来的新增令牌。 对于早期版本的 Jenkins，必须指定实际用户密码。
      • 数据类型：字符串
      • 必需： 是

触发通用生成

触发通用 Jenkins 生成，调用 Jenkins 生成 URL。

  • 使用者 ID： jenkins
  • 操作 ID： triggerGenericBuild
  • 支持的事件： git.push、build.complete、tfvc.checkin
  • 设置：
    • serverBaseUrl
      • Jenkins 基 URL
      • 托管 Jenkins 服务器的基 URL
      • 数据类型： uri
      • 必需： 是
    • username
      • 用户名
      • 允许触发生成的用户的 Jenkins 用户名
      • 数据类型： string
      • 必需： 是
    • password
      • 用户 API 令牌 (或密码)
      • 用户的 API 令牌，可在 Jenkins 用户配置页中找到。 API 令牌是自版本 1.426 以来的新增令牌。 对于早期版本的 Jenkins，必须指定实际用户密码。
      • 数据类型：字符串
      • 必需： 是
    • buildName
      • 构建
      • 要触发的生成名称
      • 数据类型： string
      • 必需： 是
    • buildAuthToken
      • 生成令牌
      • 字符串形式的授权令牌，以便只有知道该令牌的用户才能远程触发此项目的生成
      • 数据类型： string
      • 必需： 否
    • buildParameterized
      • 接受参数
      • 指示生成是参数化还是未参数化， (可以选择先前指定生成参数)
      • 数据类型： 布尔值
      • 必需： 否
    • buildParams
      • 生成参数
      • 生成由冒号分隔的参数名称和值 (例如“param1：value1”) ，每个名称/值对都出现在其自己的文本行上
      • 数据类型： string
      • 必需： 否

Trello

提供与 Trello 的集成。

创建卡片

此操作在 Trello 中的现有列表上创建卡片。 卡片可以表示任务、问题、事件或任何内容。 卡的状态通常由它位于哪个列表决定。 有关详细信息，请参阅 使用 Trello 创建服务挂钩。

  • 使用者 ID： trello
  • 操作 ID： createCard
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • userToken
      • 用户令牌 (需要一个？ 立即获取。)
      • Trello 提供的用户令牌。 若要了解如何获取此令牌，请选择前面所述的操作说明中的链接。
      • 数据类型：字符串
      • 必需： 是
    • boardId
      • Board
      • 创建 Trello 卡的板的名称。
      • 数据类型： 字符串
      • 必需： 是
    • listId
      • 列出
      • 创建 Trello 卡的列表的名称。
      • 数据类型： 字符串
      • 必需： 是
    • 标签
      • 标签
      • 要应用于所创建卡片的标签颜色的逗号分隔列表。 有效的标签颜色名称为红色、橙色、黄色、绿色、蓝色和紫色。
      • 数据类型： 字符串
      • 必需： 否
    • addToTop
      • 在列表开头创建
      • 指示是否应在 Trello 列表的开头而不是末尾创建卡片。
      • 数据类型： 布尔值
      • 必需： 否

创建列表

此操作会在 Trello 中的现有板上创建列表。 列表用于组织板上的卡片，通常表示状态。 有关详细信息，请参阅 使用 Trello 创建服务挂钩。

  • 使用者 ID： trello
  • 操作 ID： createList
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • userToken
      • 用户令牌 (需要一个？ 立即获取。)
      • Trello 提供的用户令牌。 若要了解如何获取此令牌，请选择前面所述的操作说明中的链接。
      • 数据类型：字符串
      • 必需： 是
    • boardId
      • Board
      • 创建 Trello 列表的板的名称。
      • 数据类型： 字符串
      • 必需： 是
    • addToBottom
      • 在板底部创建
      • 指示是否应在板的底部而不是顶部创建列表。
      • 数据类型： 布尔值
      • 必需： 否

Webhook

Webhook 通过 HTTP 提供事件通信。

通过 HTTP 发布

此操作将事件的 JSON 对象表示形式发布到指定的 URL。 建议使用 HTTPS 终结点，因为事件有效负载中可能存在专用数据。 有关详细信息，请参阅 Webhook。

  • 使用者 ID： WebHook
  • 操作 ID： httpRequest
  • 支持的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 设置：
    • url
      • URL
      • 将 HTTP POST 发送到的 URL。
      • 数据类型： uri
      • 必需： 是
    • httpHeaders
      • HTTP 标头
      • HTTP 标头键和值由冒号 (分隔，例如“Key1：value1”) ，每个键值对都出现在其自己的文本行上。
      • 数据类型： 字符串
      • 必需： 否
    • basicAuthUsername
      • 基本身份验证用户名
      • 输入用于标准 HTTP 身份验证的用户名。 基本 HTTP 身份验证 (未加密的) 以纯文本形式发送凭据，这意味着应使用以“https”开头的 URL，通过安全传输层 (SSL) 启用这些凭据的加密。
      • 数据类型： 字符串
      • 必需： 否
    • basicAuthPassword
      • 基本身份验证密码
      • 输入标准 HTTP 身份验证的密码。 基本 HTTP 身份验证以纯文本 (未加密) 发送凭据，这意味着应使用以“https”开头的 URL 通过 SSL 对这些凭据启用加密。
      • 数据类型： 字符串
      • 必需： 否
    • resourceDetailsToSend
      • 要发送的资源详细信息
      • 控制要发送的资源字段
      • 数据类型： 字符串
      • 必需： 否
    • messagesToSend
      • 要发送的消息
      • 控制要发送的消息
      • 数据类型： 字符串
      • 必需： 否
    • detailedMessagesToSend
      • 要发送的详细消息
      • 控制要发送的详细消息
      • 数据类型： 字符串
      • 必需： 否

Zendesk

Zendesk 是一个 SaaS 套件，提供技术支持票证、问题跟踪和客户服务支持。

在票证中创建私人批注

使用 Zendesk 在票证中创建私人批注。

  • 使用者 ID： zendesk
  • 操作 ID： createPrivateComment
  • 支持的事件： workitem.commented
  • 设置：
    • accountName
      • 帐户名
      • Zendesk 帐户名称，例如 https://{account name}.zendesk.com
      • 数据类型： string
      • 必需： 是
    • username
      • 用户名
      • 更新票证的用户的 Zendesk 用户名
      • 数据类型： string
      • 必需： 是
    • apiToken
      • API 令牌
      • 可以在 管理员 Channels > API) 的 > Zendesk 应用中找到 Zendesk API 令牌 (
      • 数据类型： string
      • 必需： 是