ApiCenterオンボーディングプラグイン

アプリで使用される API が、指定された Azure API Center インスタンスに登録されているかどうかを確認します。

プラグイン インスタンスの定義

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

構成の例

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

構成プロパティ

コマンド ライン オプション

何一つ

備考

ApiCenterOnboardingPlugin プラグインは、アプリで使用される API が指定された Azure API Center インスタンスに登録されているかどうかを確認します。 API が登録されていない場合、プラグインは API センター インスタンスに新しい API エントリを作成できます。

Azure API Center に接続するために、プラグインは (この順序で) Azure 資格情報を使用します。

• 環境
• ワークロード ID
• マネージド ID
• Visual Studio
• Visual Studio Code
• Azure CLI（Azure コマンドライン インターフェイス）
• Azure PowerShell
• Azure 開発者コマンドラインインターフェース

プラグインが Azure にアクセスするためのアクセス トークンを取得できない場合は、エラーが表示され、Dev Proxy によって無効になります。 これらのツールのいずれかを使用して Azure にサインインし、開発プロキシを再起動して ApiCenterOnboardingPlugin プラグインを使用します。

CI/CD パイプラインで開発プロキシを使用する場合は、subscriptionId、resourceGroupName、serviceName、および workspaceName プロパティの値を環境変数として渡すことができます。 環境変数を使用するには、値の名前の前に @を付けます。次に例を示します。

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

この例では、ApiCenterOnboardingPlugin プラグインは、subscriptionId、resourceGroupName、serviceName、および workspaceName プロパティをそれぞれ、AZURE_SUBSCRIPTION_ID、AZURE_RESOURCE_GROUP_NAME、AZURE_APIC_INSTANCE_NAME、および AZURE_APIC_WORKSPACE_NAME 環境変数の値に設定します。

次のステップ