ApiCenterProductionVersionPlugin

Controleert of de API's die in een app worden gebruikt, een productieversie zijn van de API's die zijn geregistreerd in het opgegeven Azure API Center-exemplaar.

Definitie van invoegtoepassingexemplaren

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

Configuratievoorbeeld

{
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default"
  }
}

Configuratie-eigenschappen

Opdrachtregelopties

Geen

Opmerkingen

De ApiCenterProductionVersionPlugin-invoegtoepassing controleert of de API's die in een app worden gebruikt, een productieversie zijn van de API's die zijn geregistreerd in het opgegeven Azure API Center-exemplaar. Als de API's overeenkomen met niet-productieversies, wordt in de invoegtoepassing een waarschuwing weergegeven.

Als u verbinding wilt maken met Azure API Center, gebruikt de invoegtoepassing Azure-referenties (in deze volgorde):

• Milieu
• Workloadidentiteit
• Beheerde identiteit
• Visual Studio
• Visual Studio Code
• Azure-opdrachtregelinterface (CLI)
• Azure PowerShell
• Azure-ontwikkelaars-CLI

Als de invoegtoepassing geen toegangstoken voor toegang tot Azure krijgt, wordt er een fout weergegeven en wordt deze uitgeschakeld door Dev Proxy. Meld u aan bij Azure met een van deze hulpprogramma's en start dev proxy opnieuw om de ApiCenterProductionVersionPlugin-invoegtoepassing te gebruiken.

Als u Dev Proxy in CI/CD-pijplijnen gebruikt, kunt u waarden doorgeven voor de eigenschappen subscriptionId, resourceGroupName, serviceNameen workspaceName als omgevingsvariabelen. Als u omgevingsvariabelen wilt gebruiken, prepeneert u de naam van de waarde met een @, bijvoorbeeld:

{
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

In dit voorbeeld stelt de ApiCenterProductionVersionPlugin-invoegtoepassing respectievelijk subscriptionId, resourceGroupName, serviceNameen workspaceName eigenschappen in op de waarden van de AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEen AZURE_APIC_WORKSPACE_NAME omgevingsvariabelen.

Volgende stap