ApiCenterProductionVersionPlugin

Kontrollerar om DE API:er som används i en app är produktionsversion av API:erna som registrerats i den angivna Azure API Center-instansen.

Definition av plugin-instans

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

Konfigurationsexempel

{
  "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"
  }
}

Konfigurationsegenskaper

Kommandoradsalternativ

Ingen

Anmärkningar

Det ApiCenterProductionVersionPlugin plugin-programmet kontrollerar om DE API:er som används i en app är produktionsversion av DE API:er som registrerats i den angivna Azure API Center-instansen. Om API:erna matchar icke-produktionsversioner visar plugin-programmet en varning.

För att ansluta till Azure API Center använder plugin-programmet Azure-autentiseringsuppgifter (i den här ordningen):

• Miljö
• Arbetsbelastningsidentitet
• Hanterad identitet
• Visual Studio
• Visual Studio Code
• Azure CLI (kommandoradsgränssnittet för Azure)
• Azure PowerShell
• Azure Developer CLI (kommandoradsgränssnitt)

Om plugin-programmet inte hämtar en åtkomsttoken för åtkomst till Azure visas ett fel och Dev Proxy inaktiverar det. Logga in på Azure med något av dessa verktyg och starta om Dev Proxy för att använda plugin-programmet ApiCenterProductionVersionPlugin.

Om du använder Dev Proxy i CI/CD-pipelines kan du skicka värden för egenskaperna subscriptionId, resourceGroupName, serviceNameoch workspaceName som miljövariabler. Om du vill använda miljövariabler förbereder du namnet på värdet med en @, till exempel:

{
  "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"
  }
}

I det här exemplet anger ApiCenterProductionVersionPlugin-plugin-programmet subscriptionId, resourceGroupName, serviceNameoch workspaceName egenskaper för värdena för AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEoch AZURE_APIC_WORKSPACE_NAME miljövariabler.

Nästa steg