ApiCenterProductionVersionPlugin

Zkontroluje, jestli jsou rozhraní API použitá v aplikaci produkční verzí rozhraní API zaregistrovaných v zadané instanci služby Azure API Center.

Definice instance modulu plug-in

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

Příklad konfigurace

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

Vlastnosti konfigurace

Vlastnost	Popis	Výchozí
resourceGroupName	Název skupiny prostředků, ve které se nachází Azure API Center.	Žádný
serviceName	Název instance Azure API Center, kterou by měl dev proxy server použít ke kontrole, jestli jsou zaregistrovaná rozhraní API použitá v aplikaci.	Žádný
subscriptionId	ID předplatného Azure, ve kterém se nachází instance Azure API Center.	Žádný
workspace	Název pracovního prostoru Azure API Center, který se má použít.	default

Možnosti příkazového řádku

Žádný

Poznámky

Modul plug-in ApiCenterProductionVersionPlugin zkontroluje, jestli jsou rozhraní API použitá v aplikaci produkční verzí rozhraní API zaregistrovaných v zadané instanci Azure API Center. Pokud rozhraní API odpovídají neprodukčním verzím, zobrazí se v modulu plug-in upozornění.

K připojení ke službě Azure API Center používá modul plug-in přihlašovací údaje Azure (v tomto pořadí):

• Životní prostředí
• Identita úloh
• Spravovaná identita
• Vizuální studio
• Visual Studio Code
• Azure CLI (příkazový řádek nástroje Azure)
• Azure PowerShell
• CLI pro vývojáře Azure

Pokud se modulu plug-in nepodaří získat přístupový token pro přístup k Azure, zobrazí se chyba a Dev Proxy ho zakáže. Přihlaste se k Azure pomocí některého z těchto nástrojů a restartujte Dev Proxy a použijte modul plug-in ApiCenterProductionVersionPlugin.

Pokud v kanálech CI/CD používáte Dev Proxy, můžete předat hodnoty pro subscriptionId, resourceGroupName, serviceNamea workspaceName vlastnosti jako proměnné prostředí. Pokud chcete použít proměnné prostředí, předpřipravený název hodnoty pomocí @, například:

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

V tomto příkladu modul plug-in ApiCenterProductionVersionPlugin nastaví vlastnosti subscriptionId, resourceGroupName, serviceNamea workspaceName na hodnoty AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEa AZURE_APIC_WORKSPACE_NAME proměnných prostředí.

Další krok

Jak zkontrolovat, jestli moje aplikace používá rozhraní API na úrovni produkčního prostředí