ApiCenterProductionVersionPlugin
アプリで使用される API が、指定した Azure API Center インスタンスに登録されている API の実稼働バージョンであるかどうかを確認します。
プラグイン インスタンスの定義
{
"name": "ApiCenterProductionVersionPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
"configSection": "apiCenterProductionVersionPlugin"
}
構成の例
{
"apiCenterProductionVersionPlugin": {
"subscriptionId": "cdae2297-7aa6-4195-bbb1-dcd89153cc72",
"resourceGroupName": "resource-group-name",
"serviceName": "apic-instance",
"workspaceName": "default"
}
}
構成プロパティ
| プロパティ | 説明 | Default |
|---|---|---|
resourceGroupName |
Azure API Center が配置されているリソース グループの名前。 | なし |
serviceName |
アプリで使用される API が登録されている場合に、開発プロキシがチェックするために使用する Azure API Center インスタンスの名前。 | なし |
subscriptionId |
Azure API Center インスタンスが配置されている Azure サブスクリプションの ID。 | なし |
workspace |
使用する Azure API Center ワークスペースの名前。 | default |
コマンド ライン オプション
なし
解説
プラグインは ApiCenterProductionVersionPlugin 、アプリで使用される API が、指定された Azure API Center インスタンスに登録されている 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 を再起動してプラグインを ApiCenterProductionVersionPlugin 使用します。
CI/CD パイプラインで開発プロキシを使用する場合は、、および workspaceName プロパティの値をresourceGroupNamesubscriptionIdserviceName環境変数として渡すことができます。 環境変数を使用するには、値の名前の前に を付 @けます。次に例を示します。
{
"apiCenterOnboardingPlugin": {
"subscriptionId": "@AZURE_SUBSCRIPTION_ID",
"resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
"serviceName": "@AZURE_APIC_INSTANCE_NAME",
"workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
}
}
この例では、プラグインはApiCenterOnboardingPlugin、、resourceGroupName、serviceName、および workspaceName の各プロパティを、AZURE_RESOURCE_GROUP_NAMEAZURE_APIC_INSTANCE_NAMEおよび AZURE_APIC_WORKSPACE_NAME 環境変数のAZURE_SUBSCRIPTION_ID値に設定subscriptionIdします。
Dev Proxy