ApiCenterOnboardingPlugin
アプリで使用されている API が、指定した Azure API Center インスタンスに登録されているかどうかを確認します。
プラグイン インスタンスの定義
{
"name": "ApiCenterOnboardingPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
"configSection": "apiCenterOnboardingPlugin"
}
構成の例
{
"apiCenterOnboardingPlugin": {
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"resourceGroupName": "resource-group-name",
"serviceName": "apic-instance",
"workspaceName": "default",
"createApicEntryForNewApis": true
}
}
構成プロパティ
| プロパティ | 説明 | Default |
|---|---|---|
createApicEntryForNewApis |
を に true 設定すると、検出され、まだ API センターに登録されていない API の新しい API エントリが Dev Proxy によって作成されます。 [Dev Proxy]\(開発プロキシ\) に false 設定すると、コマンド プロンプトに登録されていない API のみが一覧表示されます。 |
true |
resourceGroupName |
Azure API センターが配置されているリソース グループの名前。 | なし |
serviceName |
アプリで使用される API が登録されている場合に、Dev Proxy がチェックするために使用する Azure API Center インスタンスの名前。 | なし |
subscriptionId |
Azure API Center インスタンスが配置されている Azure サブスクリプションの ID。 | なし |
workspace |
使用する Azure API センター ワークスペースの名前。 | default |
コマンド ライン オプション
なし
解説
プラグインは ApiCenterOnboardingPlugin 、アプリで使用されている API が、指定された Azure API Center インスタンスに登録されているかどうかを確認します。 API が登録されていない場合、プラグインは API センター インスタンスに新しい API エントリを作成できます。
Azure API Center に接続するために、プラグインは Azure 資格情報を (この順序で) 使用します。
- 環境
- ワークロード ID
- マネージド ID
- Visual Studio
- Visual Studio Code
- Azure CLI
- Azure PowerShell
- Azure Developer CLI
プラグインが Azure にアクセスするためのアクセス トークンを取得できない場合は、エラーが表示され、Dev Proxy によって無効になります。 これらのツールのいずれかを使用して Azure にサインインし、Dev Proxy を再起動してプラグインを ApiCenterOnboardingPlugin 使用します。
CI/CD パイプラインで Dev Proxy を使用する場合は、、および workspaceName の各プロパティの値をserviceNamesubscriptionIdresourceGroupName環境変数として渡すことができます。 環境変数を使用するには、値の名前の前に を付 @けます。次に例を示します。
{
"apiCenterOnboardingPlugin": {
"subscriptionId": "@AZURE_SUBSCRIPTION_ID",
"resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
"serviceName": "@AZURE_APIC_INSTANCE_NAME",
"workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
"createApicEntryForNewApis": true
}
}
この例では、プラグインは、ApiCenterOnboardingPlugin、resourceGroupName、serviceName、および workspaceName の各プロパティを、AZURE_APIC_INSTANCE_NAMEAZURE_RESOURCE_GROUP_NAMEおよび AZURE_APIC_WORKSPACE_NAME 環境変数のAZURE_SUBSCRIPTION_ID値に設定subscriptionIdします。
Dev Proxy