サービス フック コンシューマー

  • [アーティクル]

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

サービス フック コンシューマーを使用して 、プログラムによってサブスクリプションを作成します。 サブスクリプションは、イベント、コンシューマー、およびアクションを指定します。

次のコンシューマーから、サブスクリプションで使用するコンシューマーを選択します。 使用可能なサービスの詳細については、「 サービス フックとの統合」、利用可能なサービスに関するページを参照してください。

Azure Service Bus

Notification Hubs など、Microsoft Azure Service Busとの統合を提供します。

通知ハブにメッセージを送信する

このアクションにより、指定した Azure Notification Hub に汎用のテンプレート通知が送信されます。 詳細については、概要に関するページを参照してください。

  • コンシューマー ID: azureServiceBus
  • アクション ID: serviceBusNotificationHubSend
  • サポートされているイベント: build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定:
    • connectionString
      • SAS 接続文字列
      • Azure Service Busとの接続に使用する SAS (Shared Access Signature) 接続文字列。 この接続文字列は、Azure portalで使用できます。
      • データ型: string
      • 必須: はい
    • notificationHubName
      • 通知ハブの名前
      • 通知を送信する通知ハブの名前。 名前には、文字、数字、ピリオド、ハイフン、スラッシュ、アンダースコアのみを含めることができます。 名前の最初と最後は、文字か数字にする必要があります。 ハブは既に存在している必要があります。
      • データ型: string
      • 必須: はい
    • tagsExpression

Service Bus キューにメッセージを送信する

このアクションにより、指定したAzure Service Bus キューにイベントの JSON 文字列表現が送信されます。 詳細については、「 Service Bus のキュー、記事、サブスクリプション」を参照してください。

  • コンシューマー ID: azureServiceBus
  • アクション ID: serviceBusQueueSend
  • サポートされているイベント: build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定:
    • connectionString
      • SAS 接続文字列
      • Azure Service Busとの接続に使用する SAS (Shared Access Signature) 接続文字列。 この接続文字列は、Azure portalで使用できます。
      • データ型: string
      • 必須: はい
    • queueName
      • キュー名
      • メッセージの送信先となるキューの名前。 名前には、文字、数字、ピリオド、ハイフン、スラッシュ、アンダースコアのみを含めることができます。 名前の最初と最後は、文字か数字にする必要があります。 キューが存在しない場合は、指定された接続文字列に必要なアクセス許可がある場合に作成されます。
      • データ型: string
      • 必須: はい
    • resourceDetailsToSend
      • 送信するリソースの詳細
      • 送信するリソース フィールドを制御する
      • データ型: string
      • 必須: いいえ
    • messagesToSend
      • 送信するメッセージ
      • 送信するメッセージを制御する
      • データ型: string
      • 必須: いいえ
    • detailedMessagesToSend
      • 送信する詳細なメッセージ
      • 送信する詳細なメッセージを制御する
      • データ型: string
      • 必須: いいえ

Service Bus トピックにメッセージを送信する

このアクションは、指定したAzure Service Bus トピックにイベントの JSON 文字列表現を送信します。 詳細については、「Azure portalを使用して Service Bus トピックを作成し、トピックのサブスクリプションを作成する」を参照してください。

  • コンシューマー ID: azureServiceBus
  • アクション ID: serviceBusTopicSend
  • サポートされているイベント: build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定:
    • connectionString
      • SAS 接続文字列
      • Azure Service Busとの接続に使用する SAS (Shared Access Signature) 接続文字列。 この接続文字列は、Azure portalで使用できます。
      • データ型: string
      • 必須: はい
    • topicName
      • トピック名
      • メッセージの送信先となるトピックの名前。 名前には、文字、数字、ピリオド、ハイフン、スラッシュ、アンダースコアのみを含めることができます。 名前の最初と最後は、文字か数字にする必要があります。 トピックが存在しない場合は、指定した接続文字列に必要なアクセス許可がある場合に作成されます。
      • データ型: string
      • 必須: はい
    • resourceDetailsToSend
      • 送信するリソースの詳細
      • 送信するリソース フィールドを制御する
      • データ型: string
      • 必須: いいえ
    • messagesToSend
      • 送信するメッセージ
      • 送信するメッセージを制御する
      • データ型: string
      • 必須: いいえ
    • detailedMessagesToSend
      • 送信する詳細なメッセージ
      • 送信する詳細なメッセージを制御する
      • データ型: string
      • 必須: いいえ

Azure Storage

Microsoft Azure Storageとの統合を提供します。

ストレージ キューにメッセージを挿入する

このアクションにより、イベントの 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 Storage 内で使用するキューの小文字のみの名前。 この名前のキューがまだ存在しない場合は作成されます。
      • データ型: string
      • 必須: はい
    • visiTimeout
      • メッセージの可視性タイムアウト (秒単位)
      • エンキューされたメッセージの可視性タイムアウト値を、サーバー時間を基準にして秒単位で指定します。 値は 0 以上である必要があり、7 日または 604,800 秒を超えることはできません。 表示タイムアウトは、メッセージの time-to-live 値より小さい値に設定する必要があります。
      • データ型: 数値
      • 必須: はい
    • ttl
      • メッセージの有効期間 (秒単位)
      • キュー メッセージの有効期間を秒単位で指定します。 最長有効期間は 7 日間(604,800 秒)です。
      • データ型: 数値
      • 必須: はい
    • resourceDetailsToSend
      • 送信するリソースの詳細
      • 送信するリソース フィールドを制御する
      • データ型: string
      • 必須: いいえ
    • messagesToSend
      • 送信するメッセージ
      • 送信するメッセージを制御する
      • データ型: string
      • 必須: いいえ
    • detailedMessagesToSend
      • 送信する詳細なメッセージ
      • 送信する詳細なメッセージを制御する
      • データ型: string
      • 必須: いいえ

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 では、実際のユーザー パスワードを指定する必要があります。
      • データ型: string
      • 必須: はい

汎用ビルドをトリガーする

Jenkins ビルド URL を呼び出して、汎用 Jenkins ビルドをトリガーします。

  • コンシューマー 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 では、実際のユーザー パスワードを指定する必要があります。
      • データ型: string
      • 必須: はい
    • buildName
      • Build
      • トリガーするビルド名
      • データ型: 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 によって提供されるユーザー トークン。 このトークンを取得する方法については、前に説明したアクションの説明のリンクを選択します。
      • データ型: string
      • 必須: はい
    • boardId
      • Board
      • Trello カードが作成されるボードの名前。
      • データ型: string
      • 必須: はい
    • listId
      • List
      • Trello カードが作成されるリストの名前。
      • データ型: string
      • 必須: はい
    • ラベル
      • ラベル
      • 作成したカードに適用するラベルの色のコンマ区切りのリスト。 有効なラベルの色名は、赤、オレンジ、黄、緑、青、紫です。
      • データ型: string
      • 必須: いいえ
    • addToTop
      • リストの先頭に作成する
      • 末尾ではなく Trello リストの先頭にカードを作成する必要があるかどうかを示します。
      • データ型: boolean
      • 必須: いいえ

リストを作成する

このアクションにより、Trello の既存のボードにリストが作成されます。 リストはボード上のカードを整理するために使用され、通常は状態を表します。 詳細については、「 Trello を使用してサービス フックを作成する」を参照してください。

  • コンシューマー ID: trello
  • アクション ID: createList
  • サポートされているイベント: build.complete、git.push、tfvc.checkin、workitem.created、workitem.commented、workitem.updated
  • 設定:
    • userToken
      • ユーザー トークン (必要ですか? 今すぐ入手してください。)
      • Trello によって提供されるユーザー トークン。 このトークンを取得する方法については、前に説明したアクションの説明のリンクを選択します。
      • データ型: string
      • 必須: はい
    • boardId
      • Board
      • Trello リストが作成されるボードの名前。
      • データ型: string
      • 必須: はい
    • addToBottom
      • ボードの下部に作成する
      • リストを上部ではなくボードの下部に作成するかどうかを示します。
      • データ型: boolean
      • 必須: いいえ

Webhooks

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" など) で区切られ、各キーと値のペアは独自のテキスト行に表示されます。
      • データ型: string
      • 必須: いいえ
    • basicAuthUsername
      • 基本認証ユーザー名
      • 標準 HTTP 認証のユーザー名を入力します。 基本的な HTTP 認証では、プレーン テキスト (暗号化されていない) で資格情報が送信されます。つまり、"https" で始まる URL を使用して、セキュリティで保護されたトランスポート層 (SSL) 経由でこれらの資格情報の暗号化を有効にする必要があります。
      • データ型: string
      • 必須: いいえ
    • basicAuthPassword
      • 基本認証パスワード
      • 標準 HTTP 認証のパスワードを入力します。 基本的な HTTP 認証では、プレーン テキスト (暗号化されていない) で資格情報が送信されます。つまり、"https" で始まる URL を使用して、SSL 経由でこれらの資格情報の暗号化を有効にする必要があります。
      • データ型: string
      • 必須: いいえ
    • resourceDetailsToSend
      • 送信するリソースの詳細
      • 送信するリソース フィールドを制御する
      • データ型: string
      • 必須: いいえ
    • messagesToSend
      • 送信するメッセージ
      • 送信するメッセージを制御する
      • データ型: string
      • 必須: いいえ
    • detailedMessagesToSend
      • 送信する詳細なメッセージ
      • 送信する詳細なメッセージを制御する
      • データ型: string
      • 必須: いいえ

Zendesk

Zendesk は、ヘルプ デスクのチケット発行、問題の追跡、カスタマー サービス サポートを提供する SaaS スイートです。

チケットにプライベート コメントを作成する

Zendesk を使用して、チケットにプライベート コメントを作成します。

  • コンシューマー ID: zendesk
  • アクション ID: createPrivateComment
  • サポートされているイベント: workitem.commented
  • 設定:
    • accountName
      • アカウント名
      • Zendesk アカウント名 https://{account name}.zendesk.com
      • データ型: string
      • 必須: はい
    • username
      • ユーザー名
      • チケットを更新するユーザーの Zendesk ユーザー名
      • データ型: string
      • 必須: はい
    • apiToken
      • API トークン
      • Zendesk API トークン (管理 > Channels > API の Zendesk アプリにあります)
      • データ型: string
      • 必須: はい