カスタム コネクタCustom Connectors

Azure Logic AppsMicrosoft FlowPowerApps では、Microsoft サービスと Microsoft 以外のサービスに対する 180 種類以上のコネクタが用意されていますが、事前構築済みのコネクタとして使用できないサービスと通信することが必要な場合があります。While Azure Logic Apps, Microsoft Flow, and PowerApps offer over 180+ connectors to connect to Microsoft and non-Microsoft services, you may want to communicate with services that are not available as prebuilt connectors. カスタム コネクタでは、独自のトリガーとアクションを備えたコネクタを作成 (さらには共有) できるようにすることで、このシナリオに対応しています。Custom connectors address this scenario by allowing you to to create (and even share) a connector with its own triggers and actions.

ライフサイクルLifecycle

1.API をビルドする1. Build your API

カスタム コネクタは、Logic Apps、Microsoft Flow、または PowerApps が REST または SOAP API と対話できるようにする REST API (Logic Apps では SOAP API もサポートされます) のラッパーです。A custom connector is a wrapper around a REST API (Logic Apps also supports SOAP APIs) that allows Logic Apps, Microsoft Flow, or PowerApps to communicate with that REST or SOAP API. これらの API には以下のものがあります。These APIs can be:

  • SpotifySlackRackspace、管理対象の API などのパブリック (パブリック インターネット上で参照できる)Public (visible on the public internet) such as Spotify, Slack, Rackspace, or an API you manage
  • プライベート (自社ネットワークでのみ参照できる)Private (visible only to your network)

作成および管理する予定のパブリック API については、以下の Microsoft Azure 製品のいずれかを使用することを検討してください。For public APIs that you plan to create and manage, consider using one of these Microsoft Azure products:

プライベート API の場合、Microsoft では、オンプレミスのデータ ゲートウェイを通じたオンプレミスのデータ接続を提供しています。For private APIs, Microsoft offers on-premises data connectivity through an on-premises data gateway. これらのゲートウェイは、Logic Apps、Microsoft Flow、PowerApps によってサポートされます。These gateways are supported by Logic Apps, Microsoft Flow, and PowerApps.

2.API をセキュリティで保護する2. Secure your API

API とコネクタには、以下の標準的認証方法のいずれかを使用してください (Azure Active Directory を推奨)。Use one of these standard authentication methods for your APIs and connectors (Azure Active Directory is recommended):

Azure portal 内で API の Azure AD 認証を設定できるので、認証を実装する必要はありません。または、API のコード内で認証を要求し、強制できます。You can set up Azure AD authentication for your API in the Azure portal so you do not have to implement authentication or you can require and enforce authentication in your API's code. カスタム コネクタ用の Azure AD の詳細については、Azure AD による API とコネクタの保護に関するページをご覧ください。For more information about Azure AD for custom connectors, see Secure your API and connector with Azure AD.

手順 3.API について記述し、カスタム コネクタを定義する3. Describe the API and define the custom connector

認証済みアクセスを使用する API を用意できたら、次に、Logic Apps、Microsoft Flow、または PowerApps が API と通信できるように、API について記述します。Once you have an API with authenticated access, the next thing to do is to describe your API so that Logic Apps, Microsoft Flow, or PowerApps can communicate with your API. 次のアプローチがサポートされています。The following approaches are supported:

OpenAPI 定義と Postman コレクションでは使用する形式が異なりますが、どちらも言語に依存しない、コンピューターが読み取り可能なドキュメントであり、API を記述します。OpenAPI definitions and Postman collections use different formats, but both are language-agnostic, machine-readable documents that describe your API. これらのドキュメントは、API で使用される言語とプラットフォームに応じて、さまざまなツールで生成できます。You can generate these documents from various tools based on the language and platform used by your API. Logic Apps、Flow、および PowerApps は、バックグラウンドで OpenAPI を使用してコネクタを定義します。Behind the scenes, Logic Apps, Flow, and PowerApps use OpenAPI to define connectors.

4.Logic App、Flow、または PowerApps アプリ内でコネクタを使用する4. Use your connector in a Logic App, Flow, or PowerApps app

カスタム コネクタは、Microsoft マネージド コネクタが使用されるのと同じ方法で使用されます。Custom connectors are used the same way Microsoft-managed connector are used. API への接続を作成する必要があり、その後その接続を使用して、カスタム コネクタ内で公開している任意の操作を呼び出すことができます。You will need to create a connection to your API and then you can use that connection to call any operations that you have exposed in your custom connector.

Microsoft Flow 内で作成されたコネクタは、PowerApps 内で使用できます。Connectors created in Microsoft Flow are available in PowerApps. 同様に、PowerApps 内で作成されたコネクタは、Microsoft Flow 内で使用できます。Likewise, connectors created in PowerApps are available in Microsoft Flow. これは Logic Apps 内で作成されたコネクタには当てはまりませんが、OpenAPI 定義または Postman コレクションを再利用して、これらのサービスのいずれかでコネクタを再作成することができます。This is not true for connectors created in Logic Apps, but you can reuse the OpenAPI definition or Postman collection to recreate the connector in any of these services. 詳細については、次の該当するチュートリアルを参照してください。For more information, see the appropriate tutorial:

5.コネクタを共有する5. Share your connector

Logic Apps、Microsoft Flow、または PowerApps でリソースを共有する場合と同様に、コネクタを組織のユーザーと共有できます。You can share your connector with users in your organization in the same way that you share resources in Logic Apps, Microsoft Flow, or PowerApps. 共有は任意ですが、コネクタを他のユーザーと共有することが望ましい場合があります。Sharing is optional, but you may have scenarios where you want to share your connectors with other users.

詳細については、組織内でのカスタム コネクタの共有に関するページをご覧ください。For more information, see Share custom connectors in your organization.

6.コネクタを認定する6. Certify your connector

Logic Apps、Microsoft Flow、PowerApps のすべてのユーザーとコネクタを共有する場合は、コネクタを提出して Microsoft の認定を受けることができます。If you would like to share your connector with all users of Logic Apps, Microsoft Flow, and PowerApps, you can submit your connector for Microsoft certification. Microsoft では、コネクタをレビューし、技術とコンテンツのコンプライアンスを確認し、機能を検証します。Microsoft will review your connector, check for technical and content compliance, and validates functionality.

詳細については、「Microsoft の認定を受けるためにコネクタを提出する」を参照してください。For more information, see Submit your connectors for Microsoft certification.

チュートリアルTutorial

チュートリアルでは、Cognitive Services Text Analytics API を使用します。The tutorial uses the Cognitive Services Text Analytics API. Microsoft ではこの API 用のコネクタを既に用意していますが、これはカスタム コネクタのライフサイクルとカスタム コネクタで固有のシナリオをサポートする方法を説明するための優れた例になります。Microsoft already provides a connector for this API, but it is a good example for teaching the custom connector lifecycle and how custom connectors can support unique scenarios.

シナリオScenario

作成するコネクタでは、テキスト入力のセンチメント スコア (0.000 から 1.000) を返す Text Analytics Sentiment 操作を公開します。The connector you will build exposes the Text Analytics Sentiment operation which returns the sentiment score (0.000 to 1.000) for the text input.

前提条件Prerequisites

  • 次のいずれかのサブスクリプション:One of the following subscriptions:
  • Logic Apps、Flows、または PowerApps のアプリを作成する方法に関する基礎知識Basic understanding of how to create Logic Apps, Flows, or PowerApps apps
  • Cognitive Services Text Analytics API の API キーAPI key for the Cognitive Services Text Analytics API

API キーを取得するGet an API key

Text Analytics API は "API キー" を使用してユーザーを認証します。The Text Analytics API uses an API key to authenticate users. ユーザーがカスタム コネクタを介して API への接続を作成するときに、ユーザーはこのキーの値を指定します。When a user creates a connection to the API through a custom connector, the user specifies the value of this key. API キーは以下によって取得できます。You can get an API key by:

  • API を試すように API キーに要求する。この場合、Azure サブスクリプションは不要ですRequesting an API key to try out the API which does not require an Azure subscription

  • Azure サブスクリプションに Text Analytics API を追加するAdding the Text Analytics API to your Azure subscription. サブスクリプション内に API リソースを用意したら、[キー] セクションから API キーを取得します。Once you have the API resource in your subscription, get the API key from the Keys section:

    API キーを取得する

チュートリアルを開始するStart the tutorial

高度なチュートリアルAdvanced tutorials

カスタム コネクタの具体的なシナリオの詳細については、次のチュートリアルを参照してください。The following tutorials provide more detail for specific custom connector scenarios: