ApiCenterProductionVersionPlugin

Checks if the APIs used in an app are production version of the APIs registered in the specified Azure API Center instance.

Plugin instance definition

{
  "name": "ApiCenterProductionVersionPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "apiCenterProductionVersionPlugin"
}

Configuration example

{
  "apiCenterProductionVersionPlugin": {
    "subscriptionId": "cdae2297-7aa6-4195-bbb1-dcd89153cc72",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default"
  }
}

Configuration properties

Property	Description	Default
excludeDevCredentials	Set to true for Dev Proxy not to use Azure dev tools credentials to connect to Azure API Center.	false
excludeProdCredentials	Set to true for Dev Proxy not to use Azure production credentials to connect to Azure API Center.	true
resourceGroupName	Name of the resource group where the Azure API Center is located.	None
serviceName	Name of the Azure API Center instance that Dev Proxy should use to check if the APIs used in the app are registered.	None
subscriptionId	ID of the Azure subscription where the Azure API Center instance is located.	None
workspace	Name of the Azure API Center workspace to use.	default

Command line options

None

Remarks

The ApiCenterProductionVersionPlugin plugin checks if the APIs used in an app are production version of the APIs registered in the specified Azure API Center instance. If the APIs match nonproduction versions, the plugin shows a warning.

To connect to Azure API Center, the plugin uses Azure credentials. If you configure the excludeDevCredentials property to false (default), the plugin uses the following credentials (in this order):

• Shared Token Cache
• Visual Studio
• Visual Studio Code
• Azure CLI
• Azure PowerShell
• Azure Developer CLI

If you configure the excludeProdCredentials property to false, the plugin uses the following credentials (in this order):

• Environment
• Workload Identity
• Managed Identity

For local use, we recommend configuring the excludeDevCredentials property to false and the excludeProdCredentials property to true to use the development credentials. For use in CI/CD environments, configure the excludeDevCredentials property to true and the excludeProdCredentials property to false to use the production credentials.

If the plugin fails to get an access token to access Azure, it shows an error and Dev Proxy disables it. Sign in to Azure using either of these tools, and restart Dev Proxy to use the ApiCenterProductionVersionPlugin plugin.