検証済み発行者の認定プロセス

[アーティクル]
10/19/2023

このプロセスは、検証済み発行者向けです (独立発行者を除く)。独立発行者の場合は、独立発行者の認定プロセスにアクセスしてください。

カスタムコネクタの開発完了後は、以下の手順で認定の準備を行い、マイクロソフトに提出するコネクタファイルを生成します。

注意

このトピックでは、Azure Logic Apps、Power Automate、および Power Apps でカスタムコネクタを認定するための情報を提供します。この記事に記載の手順を実行する前に、コネクタの承認を読み、カスタムコネクターをマイクロソフトに登録してください。

基本的な認証プロセスのワークフロー

次のフローチャートは、基本的な認証プロセスのワークフローを表しています。この記事の番号付きの手順は、ワークフローに対応しています。手順では、認証プロセスに必要な詳細も説明します。

フローチャートを拡大表示するには、右下の虫眼鏡アイコンを選択します。

このフローチャートの詳細については、詳細なコネクタ認証プロセスのワークフローにアクセスしてください。

手順1: 使用しているコネクタを登録する

カスタムコネクタでの開発が完了していなくても、認定を申請できます。認定プロセスを開始するには、登録フォームに記入してコネクタの認定登録をしてください。

Microsoft 担当者から 2 営業日以内に電子メールが届き、担当者は次のことを行います。

カスタムコネクタを理解する。
開発プロセスについて解説します。
認定プロセスにしたがってガイドします。

ステップ2: 提出要件を満たす

認定されたコネクタ間で高水準の品質と一貫性を維持するために、Microsoft には、カスタムコネクタが認定のために遵守する必要がある一連の要件とガイドラインがあります。

コネクタにタイトルを付ける

存在しており、英語で書かれている必要があります。
一意であり、既存のコネクタタイトルと区別できる必要があります。
製品または組織の名前である必要があります。
認定済みコネクタの既存の命名パターンに従う必要があります。独立系発行者の場合は、コネクタの名前は、コネクタ名 (独立系発行者) のパターンに従います。
名前を 30 文字より長くすることはできません。
「API」、「Connector」、または Power Platform 製品名を含めることはできません (Power Apps など)。
キャリッジリターン、改行、空白など、英数字以外の文字で終了することはできません。

例

推奨するコネクタタイトルの例: 「Azure Sentinel」、「Office 365 Outlook」
良くないコネクタタイトルの例: 「Azure Sentinel の Power Apps コネクタ」、「Office 365 Outlook API」

コネクタの説明を記述する

存在しており、英語で書かれている必要があります。
文法上の誤りとスペルミスがないようにしてください。
コネクタが提供する主な目的と価値を簡潔に説明する必要があります。
30 字よりも短くしたり、500 字より長くしたりすることはできません。
Power Platform の製品名を含めることはできません (例: "Power Apps")。

コネクタで使用するアイコンのデザイン

このセクションは、独立した発行元には適用されません。

100 ×100 から 230 × 230 ピクセル (角は丸くない) の範囲で、1:1 サイズのロゴを作成します。
不透過、白以外 (#ffffff) の背景と、指定したアイコンの背景色に一致する、既定でない色 (#007ee5) が含まれている必要があります。
その他の認定コネクタアイコンに一意である必要があります。
PNG 形式で "icon.png" として提出する必要があります。
ロゴの寸法は、画像の高さと幅が 70% 未満で、同一の背景を使用しています。
ブランドカラーが有効な 16 進数のカラーであることを確認し、白 (#ffffff) やデフォルト (#007ee5) にしないでください。

操作とパラメータの概要と説明の定義

存在しており、英語で書かれている必要があります。
文法上の誤りとスペルミスがないようにしてください。
オペレーションとパラメーターの概要は、80 文字以下で、英数字または括弧のみで構成する必要があります。
操作方法やパラメータの説明は、完全な説明文とし、語尾には句読点を付けてください。
Microsoft Power Platform の製品名を含めることはできません (例: "Power Apps")。

正確な操作レスポンスの定義

想定される応答のみを使用して、正確なスキーマを使用した操作応答を定義します。
正確なスキーマ定義の既定応答を使用しないでください。
Swagger 内のすべての操作に有効な応答スキーマ定義を提供します。
空の応答スキーマは、応答スキーマが動的である特別な場合を除いて許可されていません。これは、動的コンテンツが出力に表示されないことを意味し、作成者は応答を解析するために JSON を使用する必要があります。
空の操作は許可されていません。
必要でない限り、空のプロパティを削除します。

Swagger プロパティを確認する

"openapidefinition" が正しくフォーマットされた JSON ファイル内にあることを確認します。
Swagger 定義が OpenAPI 2.0 標準およびコネクタの拡張標準に準拠していることを確認します。

接続パラメーターを確認する

"UIDefinition" の適切な値 (表示名、説明) でプロパティが更新されていることを確認します。

接続パラメーターで基本認証を使用する場合は、JSON が次の例のように正しくフォーマットされていることを確認してください。

{
  "username": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourUsernameLabel",
      "description": "The description of YourUsernameLabel for this api",
      "tooltip": "Provide the YourUsernameLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": true,
        "required": "true"
        }
  }
},
  "password": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourPasswordLabel",
      "description": "The description of YourPasswordLabel for this api",
      "tooltip": "Provide the YourPasswordLabel tooltip text",
      "constraints": {
        "tabIndex": 3,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

接続パラメーターが認証として APIKey を含んでいる場合、JSON が次の例のように正しくフォーマットされていることを確認してください。

{
  "api_key": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourApiKeyParameterLabel",
      "tooltip": "Provide your YourApiKeyParameterLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

接続パラメーターが認証として汎用 OAuth を含んでいる場合、JSON が次の例のように正しくフォーマットされていることを確認してください。

{
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "oauth2",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "AuthorizationUrl": {
          "value": "https://contoso.com"
        },
        "TokenUrl": {
          "value": "https://contoso.com"
        },
        "RefreshUrl": {
          "value": "https://contoso.com"
        }
      },
      "clientId": "YourClientID"
    },
    "uiDefinition": null
  }
}

接続パラメーターが OAuth2 ID プロバイダーを含んでいる場合、その ID プロバイダーがサポートされている OAuth2 プロバイダーのリストに含まれていることを確認してください。以下は、GitHub OAuth2 ID プロバイダーの例です:
```
{
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "github",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {},
      "clientId": "YourClientId"
    },
    "uiDefinition": null
  }
}
```

接続パラメーターが認証として Microsoft Entra ID を含んでいる場合、JSON が次の例のように正しくフォーマットされていることを確認してください。

{
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "aad",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "LoginUri": {
          "value": "https://login.microsoftonline.com"
        },
        "TenantId": {
          "value": "common"
        },
        "ResourceUri": {
          "value": "resourceUri"
        },
        "EnableOnbehalfOfLogin": {
          "value": false
        }
      },
      "clientId": "AzureActiveDirectoryClientId"
    },
    "uiDefinition": null
  }
}

質の高い英語の文字列を作成する

コネクタは、Power Automate のローカライズの一環としてローカライズされるため、コネクタを開発する際には、英語の文字列の翻訳品質が鍵となります。ここでは、指定した文字列の値を作成する上で、注目すべき主なポイントを紹介します。

スペルチェックプログラムを実行して、すべての文字列値に誤字脱字がないことを確認してください。不完全な英語の文字列があった場合、翻訳結果が不完全、または文脈的に正しくないものとなります。
完全な文章であることをご確認ください。文が完全でない場合、低品質の翻訳を生成してしまう可能性があります。
文章の意味が明確になるようにしてください。また、文の意味が曖昧な場合、質の低い翻訳や間違った翻訳が生成される可能性があります。
要約、x-ms-要約、および説明が文法的に正しいことを確認してください。それらをコピー、および貼り付けをしないで下さい。それらが製品内でどのように表示されるかについては、コネクタ文字列のガイダンスをご覧ください。
可能であれば、ランタイムの合成文字列は避けてください。その代わりに、完全な形の文章を使用してください。文字列や文章が連結されていると、翻訳が困難になったり、誤訳の原因になったりします。
略語を使う場合は、必ず大文字にして明確化してください。これにより、誤字脱字と間違われる可能性が低くなります。
CaMel 形式の文字列 (例: minimizeHighways または MinimizeHighways) は、通常、翻訳不可と判断されます。文字列値をローカライズする場合は、CaMel フォーム文字列を修正する必要があります。

手順 3: ソリューションチェッカーを実行してコネクタを検証する

ソリューションチェッカーは、静的分析を実行して、コネクタが Microsoft の認証に必要な標準に準拠していることを確認するメカニズムです。 Power Automate または Power Apps のソリューションにコネクタを追加し、ソリューションチェッカーでカスタムコネクタを検証するの指示に従い、ソリューションチェッカーを実行します。

このビデオでは、ソリューションチェッカーの実行方法について説明します!

手順4: メタデータの追加

コネクタアーティファクト (ファイル) には、コネクタとそのエンドサービスを説明する特定のメタデータが含まれている必要があります。メタデータで提供される情報は、コネクタのドキュメントで公開され、一般的にすべてのユーザーがアクセスできます。個人情報や機密情報を入力しないようにしてください。また、このような情報の提供に問題がある場合は、Microsoft の問い合わせ先にお知らせください。メタデータがどのように文書化されるかについては、コネクタの参照情報に記載されているコネクタ別のドキュメントページのいずれかをご覧ください。

手順 4a: 発行元と stackOwner のプロパティ

"公開元" はあなたの会社、または組織の名前です。完全な会社名を入力します (たとえば、"Contoso Corporation")。これは英数字形式である必要があります。
stackOwner は、コネクタが接続しているバックエンドサービススタックの所有者である会社、あるいは組織です。これは英数字形式である必要があります。

発行者	Description	例
認証済	ISV が stackOwner に代わってコネクタを構築している場合を除き、発行元と stackOwner は同じになります。	"発行元": "Tesla", "stackOwner": "Tesla"
独立	スタック所有者と発行元所有者を指定する必要があります。	"発行元": "Nirmal Kumar", "stackOwner": "ITGlue"

ファイルの場所: apiProperties.json
詳細については、API プロパティファイルを参照してください。

構文: 公開元と stackOwner プロパティは、apiProperties.json ファイル内のトップレベルプロパティとして存在します。以下のハイライト行を図のように追加します。示されているとおりにプロパティ名とスキーマを入力していることを確認してください。

サンプルコードスニペットで利用可能な publisher プロパティと stackOwner プロパティを示すスクリーンショット。

手順 4c: サンプルコードスニペット

次のコードスニペットを使用して、情報をコピーして入力できます。前のセクションで説明したように、スニペットを正しい場所の正しいファイルに追加してください。

    "publisher": "_____",
    "stackOwner": "_____"

    "contact": {
      "name": "_____",
      "url": "_____",
      "email": "_____"
    }

    "x-ms-connector-metadata": [
      {
        "propertyName": "Website",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Privacy policy",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Categories",
        "propertyValue": "_____;_____"
      }
    ]

注意

現在、stackOwner プロパティと Paconn CLI ツールの使用には制限があります。詳細については、Readme ファイルの制限事項を参照してください。

手順 4d: JSON ファイルのフォーマットと制限

プロパティが正しく配置されていることを確認してください。
JSON を Visual Studio Code に貼り付けます。スペルチェッカーなどの拡張機能や、JSON プラグインなどのプラグインを自由に使用してください。
Swagger ファイルは 1MB を超えてはなりません。
- コネクタの構築を開始する前に、コネクタの設計を検討してください。コネクタを 2 つ以上のコネクタに分割する必要があるかどうかを評価します。
- 大きな Swagger ファイルは、コネクタの使用時に遅延を引き起こす可能性があります。
たとえば、プラットフォームには 3 つの異なる HubSpot コネクタがあります。

手順 4e: カスタムコネクタファイルを検証する

paconn validate --api-def [Location of apiDefinition.swagger.json]を実行します。このツールは、コネクタの定義を検証し、送信前に修正する必要のあるエラーが通知されます。

コネクタで認証の種類として OAuth が使用されている場合は、許可されている次のリダイレクト URL をアプリに追加します。

https://global.consent.azure-apim.net/redirect/{apiname}
https://global-test.consent.azure-apim.net/redirect/{apiname}

手順 5: コネクタの成果物を準備する

このステップは、完了するまでに約 1 週間ほどかかります。

注意

認定前に、ご自身のコネクタが仕様に準拠していること、およびその品質が確保されていることを確認してください。これを怠ると変更を求められるため、認定の遅れが生じます。
ホスト URL の製品版を提供します。ステージング、開発、テストのホスト URL は許可されていません。

Microsoft が提供するコマンドラインインターフェイス (CLI) ツールを使ってダウンロードした、コネクタアーティファクト と呼ばれるファイルのセットを Microsoft に送信します。このツールによって、コネクタの破損エラーを検証します。

開始するには、次の手順に従います。

インストール手順に従って、Microsoft Power Platform コネクタ CLI ツールをインストールします。
paconn login を実行して、コマンドラインを使用して Microsoft Power Platform にサインインします。指示に従って、Microsoft のデバイスコードプロセスを使用してサインインします。
認証されたら、カスタムコネクタファイルをダウンロードします。
- paconn downloadを実行します。コマンドラインで番号を指定してカスタムコネクタがある環境を選択し、カスタムコネクタ名を選択します。
ツールによって、フォルダー内のコネクタアーティファクトが、paconn を実行したファイルシステムの場所にダウンロードされます。発行元のタイプに応じて、さまざまなアーティファクトが表示されます:

発行者	アーティファクト
認証済	`apiDefinition.swagger.json` `apiProperties.json` `settings.json` コネクタのアイコン
独立	`apiDefinition.swagger.json` `apiProperties.json`

認証済みの発行元と独立系発行元の両方が、アーティファクトで apiProperties.json をダウンロードします。このファイルで IconBrandColor を設定する必要があります。

確認済みの発行元: iconBrandColor を apiProperties ファイルのブランドカラーに設定します。
独立系発行元: iconBrandColor を apiProperties ファイルで "#da3b01" に設定します。

Readme ファイルアーティファクトを作成する

Readme.md ファイルは、独立発行者と検証済み発行者の両方に必要です。コネクタの機能を文書化するには、Readme.md ファイルを作成する必要があります。含めるドキュメントの例については、Readme.md の例をご覧ください。Readme.mdファイルの作成については、当社の GitHub リポジトリ他の Readme.md ファイルをご覧ください。

独立系発行元であり、コネクタが OAuth を使用している場合は、資格情報を取得する方法の説明が含まれていることを確認してください。

ヒント

既知の問題と制限 は、ユーザーを最新の状態に保つために維持するのに最適なセクションです。

手順 6: 展開用にコネクタを送信する

送信プロセス中に、Microsoft Power Platform コネクタリポジトリにコネクタをオープンソース化します。

Microsoft 認定のためにコネクタを送信するの手順に従って、GitHub と認定ポータルに送信します。

確認済みの発行元で、カスタムコードを使用している場合は、script.csx ファイルを送信する必要があります。
オープンソースリポジトリにプル要求を送信すると、Microsoft は 1 - 2 週間以内にコネクタを展開して検証します。更新が必要な場合は、さらに 1 - 2 週間かかります。

**コネクタに OAuth がある場合は、ISV Studio でパッケージを送信し、コネクタの送信要求から APIname を取得してアプリを更新します。

提出処理の一環として、Microsoft は CLA-bot、Swagger Validator、Breaking Change Detector の各ツールを使用してコネクタの検証を行います。 Swagger エラーのトラブルシューティングが必要な場合は、Swagger 検証エラーの修正を参照してください。

手順 7: 検証済み発行者によるテストの想定

コネクタを検証した後、徹底したテストを実行するように求められます。

コネクタの認定テストをするに記載されている指示に従って、テスト準備に備えてプレビュー領域に環境を作成します。
1 週間以内に、Microsoft の担当者にテストが完了したことを通知して、展開を開始できるようにします。
コネクタの機能とコンテンツが Microsoft とユーザーの両方によって検証された後、テストのためにプレビューリージョンに展開するためにコネクタをステージングします。

ステップ 8: 展開を待機

コネクタがテストで検証された後、すべての製品と地域に展開します。

重要

コネクタの展開には、平均して 3 週間から 4 週間かかります。これは、コネクタのサイズや複雑さ、または新規か更新かに関係なく必要です。整合性を保護するために、コネクタには、すべての展開で実行される機能とコンテンツをテストするための同じ検証タスクが適用されます。

リージョンへの展開は段階的に行われるため、コネクタが展開されるリージョンの名前をメールで通知します。展開の遅延または凍結がある場合は、検証済み発行者は、ISV ポータルの 活動コントロール で状態を確認できます。独立した発行元には電子メールで通知されます。

運用環境の展開

運用環境のコネクタ展開スケジュールは、金曜日の朝、PST/PDT に始まります。運用展開の準備ができたら、少なくとも 24 時間前に Microsoft に通知して、次のスケジュールされた展開にコネクタを含めてください。検証済み発行者は、ISV ポータルの 活動コントロール で通知できます。独立した発行元は、Microsoft の連絡先に通知できます。

リージョン展開

さまざまなリージョンへの展開は、事前に決定された日単位のシーケンスで行われます。リージョンは次のとおりです:

テスト。
米国のプレビュー。
日本とインドを除くアジア。
英国を除くヨーロッパ。
ブラジル、カナダ、日本、インド。
オーストラリア、英国、米国。

たとえば、コネクタが月曜日に展開するようにスケジュールされている場合、コネクタは 1 日目にテストリージョンに展開されます。その後、2 日目に米国のプレビューリージョンに展開されます。コネクタが 6 つのリージョンすべてに展開されるまで、展開は毎日続行されます。

土曜日、日曜日、および米国の祝日には展開しません。

コネクタの認定が終了すると、Power Automate ブログでコネクタのマーケティング営業案件についてお知らせします。

手順 9: 展開後のオプションを調べる

コネクタのデプロイ後に検討できるオプションを以下に示します:

コネクタのテレメトリは、ISV ポータルでいつでも確認できます。コネクタの状態と使用状況を表示するには、 ISV ポータルで認定コネクタに関する重要な分析情報を得るにアクセスしてください。
コネクタの更新を提出します。詳細については、認定コネクタの更新を参照してください。
コミュニティディスカッションフォーラムでコネクタを監視して、問題が発生していないか、顧客からのコネクタの機能要求があるかどうかを確認します。
プレビュー タブの削除を要求します。コネクタがしばらくの間公開され、特定の要件を満たした後、一般提供タグを再割り当てされる資格を得ることができます。このタグは、コネクタが運用準備のできている製品であることを示します。詳細については、コネクタをプレビュー版から一般提供版に移行するにアクセスします。

送信前の確認事項

コネクタを提出してマイクロソフトの認定を受けるに進む前に、以下を確認します:

コネクタは、ステップ 2: 送信要件を満たすおよびステップ 4: メタデータの追加で設定されたすべての標準を満たしています。
概要、解説、可視性情報の操作が欠落していない。
カスタムコネクタのテストを行い、期待通りの動作を確認している (各操作ごとに少なくとも10回の呼び出しが成功している)。
カスタムコネクタウィザードのテストセクションに、ランタイムエラーやスキーマ検証エラーが表示されない。

ヒント

YouTube ビデオ、ブログまたはその他のコネクタを作成して、コネクタの使用を開始する方法のサンプルまたはスクリーンショットを共有します。
- Readme.md ファイルにこのリンクを含め、ドキュメントに追加できるようにします。
追加ツールチップユーザーの成功を支援するために、Swaggerファイルに追加します。

検証済み発行者 (独立発行者ではない) の場合は、Microsoft 認定の申請時に、パートナー契約と機密保持契約に同意するよう求められます。提出前にこれらの条件と言語を確認したい場合は、マイクロソフトの担当者に連絡してください。

次のステップ

Microsoft の認定資格を受けるためにコネクタを提出する

フィードバックを提供する

コネクタプラットフォームの問題点や新機能のアイデアなどのフィードバックをお待ちしています。フィードバックを提供するには、「問題を送信するか、コネクタに関するヘルプを入手する」にアクセスし、フィードバックの種類を選択します。