導入
このモジュールでは、カスタム コネクタを使用したポリシーの使用について考察し、ポリシー テンプレートを使用してポリシーを構成する方法について説明します。
このモジュールの内容は次のとおりです。
ポリシーで実行時のカスタム コネクタの動作を変更する方法を学習する。
カスタム コネクタにポリシー テンプレートを適用する。
ポリシーを使用すると、実行時のカスタム コネクタの動作を変更できます。 また、ポリシーを使用して、データ変換、ルーティング要求、パラメータ値の設定などの作業を実行できます。 インポートの前にカスタム コネクタ API プロパティ ファイルでポリシーを直接構成したり、ポリシー テンプレートを適用してカスタム コネクタ デザイナーのメーカー ポータルから直接構成したりできます。
一般的なポリシーの使用例を次に示します。
ホスト URL の設定 - 既定では、ホスト URL はコネクタの構成にハードコードされています。 ポリシーと接続パラメーターを組み合わせると、コネクタを使用して接続を作成するごとにホスト URL を指定できます。 たとえば、この使用例では、システム API の開発、テスト、および運用版に対処できました。
ヘッダーの設定 - 接続パラメーター、クエリ、または要求の本文からデータをヘッダーに昇格するために使用します。 通常、このプロセスは、ヘッダーで構成された特定の情報を必要とする API に対応するために行われます。 たとえば、この使用例では、実行されているビジネス プロセス全体を追跡する関連付け ID でした。
クエリ パラメーターの設定 - 必要に応じて既定値を扱うために使用しますが、作成者は既定値を構成しません。 たとえば、API でポリシーを使用して返されるレコード数に対するトップ パラメーターが必要な場合、作成者が構成しなければ、ユーザーは使用する既定値を設定できます。
ユーザーは、ポリシーを使用して特定の API のニーズに対応し、不要な複雑さを非表示にすることでコネクタの使用をより簡単にできます。
ポリシーの適用
カスタム コネクタにポリシー テンプレートを適用すると、テンプレートの一覧から使用するポリシーを選択できます。 選択した各テンプレートから、そのポリシーに必要な構成の入力を求めるメッセージが表示されます。 このフォームに入力すると、ユーザーがコネクタを更新した後にポリシーが有効になります。 次のスクリーンショットは、テンプレートの 1 つを使用して新しいポリシーを作成する例を示しています。
ポリシー テンプレートを適用するときに、すべてのアクションとトリガーに適用するか、特定のアクションに対して適用するかを選択できます。
たとえば、ホスト URL の設定テンプレートは、通常、すべてのアクションとトリガーに適用されます。 逆に、配列をオブジェクトに変換する (プレビュー) テンプレートは、同様のデータを返す 1 つまたは 2 つのアクションのみ適用される場合があります。
すべてのアクションおよびトリガーに対して実行するポリシーを構成する場合、ポリシー パラメーターで使用されるデータ パスがすべてのアクションおよびトリガーに対して有効である必要があります。そうしないと、ランタイム エラーが発生します。
構成済みポリシーの一覧で、各ポリシーの横の省略記号 (...) を選択し、一覧上で上または下に移動できます。 この機能を使用すると、実行時にポリシーを適用する順序を構成できます。これは、複数のポリシー テンプレートを使用してデータ変換を行う場合に役立ちます。 たとえば、1 つのポリシーが区切り文字列を配列に解析し、別のポリシーが配列をあるオブジェクトに変換するとします。 この例では、実装の順序が重要です。
ポリシー テンプレートを構成すると、コネクタの API プロパティが変更されます。 API のプロパティは、コネクタの API 定義とは別に格納されます。 構成したポリシーを上書きせずに、ポータルを介して更新された API 定義をインポートできます。
CLI を使用した表示および変更
ポータルでポリシーを表示する他に、CLI から paconn コマンドを使用して、それらを API プロパティ ファイルの一部としてエクスポートすることもできます。
ダウンロードには、4 つのファイル (apiDefintion.swagger.json、apiProperties.json、icon.png、settings.json) が含まれています。
apiProperties.json ファイルを開いて policyTemplateInstances セクションを探せば、構成されたすべてのポリシーを確認できます。
次のスクリーンショットは、policyTemplateInstances セクションの例です。
JSON での作業を理解している場合は、直接 apiProperties.json ファイルを変更することもできます。 ホスト URL の設定などの一部のポリシーを使用すると、接続の作成時に URL の入力を求める場合、ポリシーの構成を完了するために apiPropertiess.json で connectionParameters を変更する必要があります。 paconn update コマンドは、変更をインポートするために使用します。
他のコネクタがポリシーを使用する方法を検討することが役立つことがあります。 Microsoft Power Platform コネクタの GitHub レポジトリには、認定コネクタと非認定コネクタの優れた例が多数掲載されているので、参照してください。 また、コネクタの apiProperties.json ファイルを参照して確認することもできます。 setHeader などのポリシー テンプレート名を使用してレポジトリを検索すると、どのコネクタがそのポリシーを使用しているかを素早く明らかにできます。