サービスフックとの統合Integrate with service hooks

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2017Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2017

サービスフックを使用すると、Azure DevOps プロジェクトでイベントが発生した場合に、他のサービスに対してタスクを実行できます。Service hooks let you run tasks on other services when events happen in your Azure DevOps projects. たとえば、作業項目が作成されたときに Trello でカードを作成したり、ビルドが失敗したときにチームのモバイルデバイスにプッシュ通知を送信したりします。For example, create a card in Trello when a work item is created or send a push notification to your team's mobile devices when a build fails. また、プロジェクトでイベントが発生したときにアクティビティを実行するより効率的な方法として、カスタムアプリとサービスのサービスフックを使用することもできます。You can also use service hooks in custom apps and services as a more efficient way to drive activities when events happen in your projects.

サービスフックとはWhat is a service hook?

サービスフック 発行元 は、一連の イベント を定義します。Service hook publishers define a set of events. サブスクリプション は、イベントを リッスンし、 イベントに基づいて実行する アクション を定義します。Subscriptions listen for the events and define actions to take based on the event. また、サブスクリプションは、イベントが発生したときに独自のアクションを実行できる外部サービスである コンシューマー を対象としています。Subscriptions also target consumers, which are external services that can run their own actions, when an event occurs.

サービスフック図

注意

Azure DevOps Services サービスフックのエンドポイントに接続するには、着信接続に対して IP 範囲を許可する必要があります。For Azure DevOps Services connecting to endpoints for Service Hooks requires allowing IP ranges for inbound connection. 詳細については、「 許可されているアドレス一覧とネットワーク接続、IP アドレス、および範囲の制限」を参照してください。For details, see Allowed address lists and network connections, IP addresses and range restrictions.

利用可能なサービスAvailable services

これらのサービスは、サービスフックのターゲットとして使用できます。These services are available as the target of service hooks. Azure DevOps Services と統合する他のアプリとサービスの詳細については、「」を参照してください Visual Studio MarketplaceTo learn about others apps and services that integrate with Azure DevOps Services, visit the Visual Studio Marketplace

パイプラインPipelines 共同作業Collaborate カスタマー サポートCustomer support 計画と追跡Plan and track 統合Integrate
AppVeyorAppVeyor FlowdockFlowdock UserVoiceUserVoice TrelloTrello Azure Service BusAzure Service Bus
BambooBamboo HipChat (サポートされなくなりました)HipChat (No longer supported) ZendeskZendesk Azure ストレージAzure Storage
JenkinsJenkins HubotHubot GrafanaGrafana
MyGetMyGet Office 365Office 365 Web フックWeb Hooks
SlackSlack SlackSlack SlackSlack ZapierZapier
Microsoft TeamsMicrosoft Teams Microsoft TeamsMicrosoft Teams Microsoft TeamsMicrosoft Teams DatadogDatadog

サブスクリプションの作成Create a subscription

これらのサービスのいずれかを Azure DevOps Services と統合する場合は、新しいサブスクリプションを作成する必要があります。When you integrate one of these services with Azure DevOps Services, you have to create a new subscription. 多くの場合、他のサービスでも何らかの作業を行う必要があります。In many cases, you have to do some work in the other service, too. 詳細については、関心のあるサービスに関する情報を参照してください。For specific details, look at the information on the service that you're interested in.

  1. Web アクセスでプロジェクトの [管理者] ページを開きます。Open the admin page for a project in web access.

    Screenshot of highlighted Project settings button.
  2. ウィザードを実行して、サブスクリプションを作成します。Create a subscription by running the wizard.

    強調表示されたボタンのスクリーンショット (サブスクリプションの作成)。

  3. 統合するサービスを選択します。Select the service you want to integrate with.

    統合するサービスを選択します

  4. トリガーするイベントとフィルター (該当する場合) を選択します。Select the event to trigger on and any filters (if applicable).

    トリガーするイベントとフィルターを選択します

  5. ターゲットサービスで実行するアクションを選択します。Select an action to run on the target service.

    注意

    使用可能なアクションの一覧は、選択したイベントの種類によって制限される場合があります。The list of available actions may be limited based on the event type you selected.

    ターゲットサービスのアクションを選択します

  6. 設定が正しいことを確認するには、サブスクリプションをテストしてから、ウィザードを終了します。To confirm the settings are correct, test the subscription and then finish the wizard.

    Azure DevOps Server 2019、2020、Azure DevOps Services のテスト通知1

    Azure DevOps Server 2019、2020、Azure DevOps Services のテスト通知2

  1. Web アクセスでプロジェクトの [管理者] ページを開きます。Open the admin page for a project in web access.

    [管理者] ページのスクリーンショット。

  2. ウィザードを実行して、サブスクリプションを作成します。Create a subscription by running the wizard.

    サブスクリプションウィザードを実行するために選択する、強調表示されたボックスのスクリーンショット (サブスクリプションの作成)。

  3. 統合するサービスを選択します。Select the service you want to integrate with.

    統合するサービスを選択します

  4. トリガーするイベントとフィルター (該当する場合) を選択します。Select the event to trigger on and any filters (if applicable).

    トリガーするイベントを選択し、必要なフィルターを選択します

  5. ターゲットサービスで実行するアクションを選択します。Select an action to run on the target service.

    注意

    使用可能なアクションの一覧は、選択したイベントの種類によって制限される場合があります。The list of available actions may be limited based on the event type you selected.

    ターゲットサービスで実行するアクションを選択します

  6. 設定が正しいことを確認するには、サブスクリプションをテストしてから、ウィザードを終了します。To confirm the settings are correct, test the subscription and then finish the wizard.

    テスト通知1

    テスト通知2

Q & AQ & A

Q: サブスクリプションを設定するには、どのようなアクセス許可が必要ですか。Q: What permissions do I need to set up a subscription?

A: サブスクリプションを編集 し、 サブスクリプションを表示 します。A: Edit subscriptions and View subscriptions. 既定では、プロジェクト管理者のみがこれらのアクセス許可を持っています。By default, only project administrators have these permissions. 他のユーザーに直接付与するには、 コマンドラインツール または セキュリティ REST API を使用します。To grant them to other users directly, you can use the command line tool or the Security REST API.

Q: サブスクリプションの編集サブスクリプションの表示 のアクセス許可を付与すると、どのようなセキュリティへの影響がありますか。Q: What are the security implications of granting Edit subscriptions and View subscriptions permissions?

A: これらのアクセス許可を持つユーザーは、プロジェクトで作成されたすべてのサブスクリプションと、それらのサブスクリプションの通知履歴を表示できます。A: The user with these permissions can see all subscriptions created in the project and the notification history for those subscriptions. そのユーザーは、そのプロジェクトで任意の種類のサービスフックサブスクリプションを作成できます。That user can then create any type of service hook subscription in that project. ユーザーが、アクセス権限を持っていないリソースのサブスクリプションを設定した場合、そのサブスクリプションはトリガーされません。If the user sets up a subscription for a resource that they don't otherwise have permission to access, the subscription won't get triggered.

たとえば、区分パス XYZ の作業項目にアクセスできず、作業項目の更新イベントに対するサブスクリプションを設定した場合、区分パス XYZ の作業項目の更新に関する通知は表示されません。For example: if I don't have access to work items in area path XYZ, and I set up a subscription to the work item update events, I won't get notifications for updates to work items in area path XYZ. ただし、区分パス XYZ の作業項目へのアクセス権を持つ別のユーザーが "作業項目の更新" イベントを受信している場合は、他のユーザーのイベントの通知履歴が表示されることがあります。これには、他の方法でアクセスできない作業項目データも含まれます。However, if another user who does have access to the work items in area path XYZ is receiving those "work item update" events, then I could see the notification history of that other user's events, which includes work item data that I don't otherwise have access to.

Q: プログラムを使用してプロジェクトのサービスフックサブスクリプションを作成できますか。Q: Can I create service hook subscriptions for a project programmatically?

A: はい。A: Yes. 詳細については、「 サービスフックサブスクリプションを作成する」を参照してください。For more information, see Create a service hooks subscription.

Q: 承認した後で、組織へのアプリのアクセス権を削除することはできますか。Q: Can I remove an app's access to my organization after I've authorized it?

A: はい。A: Yes. プロファイルから承認を取り消すことができます。You can revoke authorizations from your profile.

  1. のプロファイルページにアクセス https://visualstudio.com します。Go to your profile page from https://visualstudio.com.

    現在、組織 () ではなく、Visual Studio サイトから開始するようにしてください https://visualstudio.com) https://dev.azure.com/{orgName} 。これは、組織からアクセスしたプロファイルによって、承認管理機能の不適切な実装に移動するためです。Make sure you start from the Visual Studio site (https://visualstudio.com) instead of your organization (https://dev.azure.com/{orgName}) because, right now, your profile accessed from your organization takes you to the wrong implementation of the authorizations management feature.

  2. 承認を管理します。Manage your authorizations.

    Click Manage applications to manage authorizations
  3. 許可する必要がなくなった承認を取り消します。Revoke any authorizations you no longer want to allow.

    Click Revoke to revoke authorizations

Q: HipChat のサービスフックをセットアップできなくなるのはなぜですか。Q: Why can't we setup Service Hooks for HipChat anymore?

A: Atlassian は、HipChat のサポートを正式に削除しました。A: Atlassian officially dropped support for HipChat. 詳細について は、こちらを参照してください。See more on that announcement here.