ApiCenterProductionVersionPlugin

Artikel
05/25/2024

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

Definition av plugin-instans

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

Konfigurationsexempel

{
  "apiCenterProductionVersionPlugin": {
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default"
  }
}

Konfigurationsegenskaper

Egenskap	Beskrivning	Standardvärde
`resourceGroupName`	Namnet på resursgruppen där Azure API Center finns.	Ingen
`serviceName`	Namnet på den Azure API Center-instans som Dev Proxy ska använda för att kontrollera om de API:er som används i appen är registrerade.	Ingen
`subscriptionId`	ID för Den Azure-prenumeration där Azure API Center-instansen finns.	Ingen
`workspace`	Namnet på den Azure API Center-arbetsyta som ska användas.	`default`

Kommandoradsalternativ

Ingen

Kommentarer

Plugin-programmet ApiCenterProductionVersionPlugin kontrollerar om de API:er som används i en app är produktionsversioner av DE API:er som är registrerade 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
Visuell Studio-kod
Azure CLI
Azure PowerShell
Azure Developer CLI

Om plugin-programmet inte kan hämta 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 subscriptionIdegenskaperna , resourceGroupName, serviceNameoch workspaceName som miljövariabler. Om du vill använda miljövariabler lägger du till namnet på värdet med ett @, till exempel:

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

I det här exemplet ApiCenterOnboardingPlugin anger subscriptionIdplugin-programmet egenskaperna , resourceGroupName, serviceNameoch workspaceName till värdena AZURE_SUBSCRIPTION_IDför miljövariablerna , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMErespektive AZURE_APIC_WORKSPACE_NAME .

Dela via