分享方式：

服務掛勾取用者

  • 文章

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

使用服務勾點取用者以 程序設計方式建立訂用帳戶。 訂用帳戶會指定事件、取用者和動作。

從下列取用者中選取您想要在訂用帳戶中使用的取用者。 如需可用服務的詳細資訊，請參閱 與服務勾點、可用服務整合。

Azure 服務匯流排

提供與 Microsoft Azure 服務匯流排的整合，包括通知中樞。

將訊息傳送至通知中樞

此動作會將一般範本通知傳送至指定的 Azure 通知中樞。 如需詳細資訊，請參閱概觀。

  • 取用者標識碼： azureServiceBus
  • 動作標識碼： serviceBusNotificationHubSend
  • 支援的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定：
    • connectionString
      • SAS 連接字串
      • SAS（共用存取簽章）連接字串 用來與 Azure 服務匯流排 連線。 此 連接字串 可在 Azure 入口網站 中使用。
      • 數據類型： 字串
      • 必要： 是
    • notificationHubName
      • 通知中樞名稱
      • 要傳送通知的通知中樞名稱。 名稱只能包含字母、數位、句點、連字元、正斜線和底線。 名稱必須以字母或數字為開頭或結尾。 中樞應該已經存在。
      • 數據類型： 字串
      • 必要： 是
    • tagsExpression
      • 標籤
      • 標記表達式（用於以特定裝置集為目標）。 深入了解。
      • 數據類型： 字串
      • 必要： 否

將訊息傳送至 服務匯流排 佇列

此動作會將事件的 JSON 字串表示傳送至指定的 Azure 服務匯流排 佇列。 如需詳細資訊，請參閱 服務匯流排 佇列、文章和訂用帳戶。

  • 取用者標識碼： azureServiceBus
  • 動作標識碼： 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 入口網站 來建立主題 服務匯流排 主題和訂用帳戶。

  • 取用者標識碼： azureServiceBus
  • 動作標識碼： serviceBusTopicSend
  • 支援的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定：
    • connectionString
      • SAS 連接字串
      • SAS（共用存取簽章）連接字串 用來與 Azure 服務匯流排 連線。 此 連接字串 可在 Azure 入口網站 中使用。
      • 數據類型： 字串
      • 必要： 是
    • topicName
      • 主題名稱
      • 要傳送訊息的主題名稱。 名稱只能包含字母、數位、句點、連字元、正斜線和底線。 名稱必須以字母或數字為開頭或結尾。 如果主題不存在，當指定的 連接字串 具有必要許可權時，就會建立該主題。
      • 數據類型： 字串
      • 必要： 是
    • resourceDetailsToSend
      • 要傳送的資源詳細數據
      • 控制要傳送的資源欄位
      • 數據類型： 字串
      • 必要： 否
    • messagesToSend
      • 要傳送的訊息
      • 控制要傳送的訊息
      • 數據類型： 字串
      • 必要： 否
    • detailedMessagesToSend
      • 要傳送的詳細訊息
      • 控制要傳送的詳細訊息
      • 數據類型： 字串
      • 必要： 否

Azure 儲存體

提供與 Microsoft Azure 儲存體的整合。

在記憶體佇列中插入訊息

此動作會將事件的 JSON 字串表示插入指定的 Azure 記憶體佇列。 如需詳細資訊，請參閱 什麼是 Azure 佇列？。

  • 取用者標識碼： azureStorageQueue
  • 動作標識碼： 加入佇列
  • 支援的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定：
    • accountName
      • 儲存體帳戶名稱
      • 與您的 Azure 記憶體帳戶相關聯的名稱（例如 ， https://STORAGE_ACCOUNT_NAME.queue.core.windows.net。
      • 數據類型： 字串
      • 必要： 是
    • accountKey
      • 儲存體帳戶金鑰
      • 與您的 Azure 記憶體帳戶相關聯的金鑰。
      • 數據類型： 字串
      • 必要： 是
    • queueName
      • 佇列名稱
      • Azure 記憶體中要使用的佇列名稱只有小寫。 如果佇列不存在，就會建立此名稱的佇列。
      • 數據類型： 字串
      • 必要： 是
    • visiTimeout
      • 訊息可見性逾時（秒為單位）
      • 指定與伺服器時間相對加入佇列訊息的可見度逾時值，以秒為單位。 此值必須大於或等於0，且不能大於7天或604,800秒。 可見性逾時必須設定為小於訊息存留時間值的值。
      • 數據類型： number
      • 必要： 是
    • ttl
      • 訊息存留時間（秒為單位）
      • 指定佇列訊息的存留時間間隔，以秒為單位。 允許的存留時間上限為 7 天，或 604,800 秒。
      • 數據類型： number
      • 必要： 是
    • resourceDetailsToSend
      • 要傳送的資源詳細數據
      • 控制要傳送的資源欄位
      • 數據類型： 字串
      • 必要： 否
    • messagesToSend
      • 要傳送的訊息
      • 控制要傳送的訊息
      • 數據類型： 字串
      • 必要： 否
    • detailedMessagesToSend
      • 要傳送的詳細訊息
      • 控制要傳送的詳細訊息
      • 數據類型： 字串
      • 必要： 否

Jenkins

Jenkins 是持續整合伺服器，可持續建置及測試軟體專案。

觸發 Git 組建

觸發設定為使用 Jenkins Git 外掛程式的 Git 存放庫的組建。

  • 取用者標識碼： jenkins
  • 動作標識碼： triggerGitBuild
  • 支援的事件： git.push
  • 設定：
    • serverBaseUrl
      • Jenkins 基底 URL
      • 裝載 Jenkins 伺服器的基底 URL
      • 數據類型： uri
      • 必要： 是
    • username
      • 使用者名稱
      • 允許觸發組建之使用者的 Jenkins 用戶名稱
      • 數據類型： 字串
      • 必要： 是
    • password
      • 使用者 API 令牌 （或密碼）
      • 使用者的 API 令牌，可在 Jenkins 使用者設定頁面中取得。 API 令牌是自1.426版以來的新功能。 對於舊版的 Jenkins，必須指定實際的用戶密碼。
      • 數據類型： 字串
      • 必要： 是

觸發泛型組建

觸發一般 Jenkins 組建，叫用 Jenkins 組建 URL。

  • 取用者標識碼： jenkins
  • 動作標識碼： triggerGenericBuild
  • 支援的事件： git.push、build.complete、tfvc.checkin
  • 設定：
    • serverBaseUrl
      • Jenkins 基底 URL
      • 裝載 Jenkins 伺服器的基底 URL
      • 數據類型： uri
      • 必要： 是
    • username
      • 使用者名稱
      • 允許觸發組建之使用者的 Jenkins 用戶名稱
      • 數據類型： 字串
      • 必要： 是
    • password
      • 使用者 API 令牌 （或密碼）
      • 使用者的 API 令牌，可在 Jenkins 使用者設定頁面中取得。 API 令牌是自1.426版以來的新功能。 對於舊版的 Jenkins，必須指定實際的用戶密碼。
      • 數據類型： 字串
      • 必要： 是
    • buildName
      • 建立
      • 要觸發的組建名稱
      • 數據類型： 字串
      • 必要： 是
    • buildAuthToken
      • 建置令牌
      • 以字串形式表示的授權令牌，讓只有知道授權令牌的使用者才能從遠端觸發此項目的組建
      • 數據類型： 字串
      • 必要： 否
    • buildParameterized
      • 接受參數
      • 指出組建是否參數化（先前選擇性地指定組建參數）
      • 數據類型： 布爾值
      • 必要： 否
    • buildParams
      • 建置參數
      • 建置以冒號分隔的參數名稱和值（例如 “param1：value1”），每個名稱/值組都會出現在自己的文字行上
      • 數據類型： 字串
      • 必要： 否

Trello

提供與 Trello 的整合。

建立卡片

此動作會在 Trello 的現有清單上建立卡片。 卡片可以代表工作、問題、事件，或只代表任何專案。 卡片的狀態通常取決於卡片的狀態。 如需詳細資訊，請參閱 使用 Trello 建立服務勾點。

  • 取用者標識碼： trello
  • 動作標識碼： createCard
  • 支援的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定：
    • userToken
      • 使用者權杖 （需要一個？ 立即取得。
      • Trello 所提供的使用者令牌。 若要瞭解如何取得此令牌，請選取先前所述的動作描述中的連結。
      • 數據類型： 字串
      • 必要： 是
    • boardId
      • 委員會
      • Trello 卡片建立所在的面板名稱。
      • 數據類型： 字串
      • 必要： 是
    • listId
      • 清單​​
      • 建立 Trello 卡片的清單名稱。
      • 數據類型： 字串
      • 必要： 是
    • 標籤
      • 標籤
      • 要套用至已建立卡片的標籤色彩逗號分隔清單。 有效的標籤色彩名稱是紅色、橙色、黃色、綠色、藍色和紫色。
      • 數據類型： 字串
      • 必要： 否
    • addToTop
      • 在清單開頭建立
      • 指出卡片是否應該在 Trello 列表的開頭建立，而不是結尾。
      • 數據類型： 布爾值
      • 必要： 否

建立清單

此動作會在 Trello 的現有面板上建立清單。 清單用來組織面板上的卡片，通常代表狀態。 如需詳細資訊，請參閱 使用 Trello 建立服務勾點。

  • 取用者標識碼： trello
  • 動作標識碼： createList
  • 支援的事件： build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定：
    • userToken
      • 使用者權杖 （需要一個？ 立即取得。
      • Trello 所提供的使用者令牌。 若要瞭解如何取得此令牌，請選取先前所述的動作描述中的連結。
      • 數據類型： 字串
      • 必要： 是
    • boardId
      • 委員會
      • Trello 清單建立所在的面板名稱。
      • 數據類型： 字串
      • 必要： 是
    • addToBottom
      • 在面板底部建立
      • 指出清單是否應該建立在面板底部，而不是頂端。
      • 數據類型： 布爾值
      • 必要： 否

Webhooks

Webhook 會透過 HTTP 提供事件通訊。

透過 HTTP 張貼

此動作會將事件的 JSON 物件表示張貼至指定的 URL。 建議使用 HTTPS 端點，因為可能會有事件承載中的私用數據。 如需詳細資訊，請參閱 Webhook。

  • 取用者標識碼： WebHook
  • 動作標識碼： 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 在票證中建立私人批注。

  • 取用者標識碼： zendesk
  • 動作標識碼： createPrivateComment
  • 支援的事件： workitem.commented
  • 設定：
    • accountName
      • 帳戶名稱
      • Zendesk 帳戶名稱，例如 https://{account name}.zendesk.com
      • 數據類型： 字串
      • 必要： 是
    • username
      • 使用者名稱
      • 更新票證之使用者的 Zendesk 用戶名稱
      • 數據類型： 字串
      • 必要： 是
    • apiToken
      • API 權杖
      • Zendesk API 令牌 （可在系統管理 > 通道 > API 的 Zendesk 應用程式中找到）
      • 數據類型： 字串
      • 必要： 是