ApiCenterProductionVersionPlugin

Überprüft, ob die in einer App verwendeten APIs die Produktionsversion der APIs sind, die in der angegebenen Azure API Center-Instanz registriert sind.

Definition der Plug-In-Instanz

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

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigentum	Beschreibung	Vorgabe
resourceGroupName	Name der Ressourcengruppe, in der sich das Azure API Center befindet.	Nichts
serviceName	Name der Azure API Center-Instanz, die Dev Proxy verwenden soll, um zu überprüfen, ob die in der App verwendeten APIs registriert sind.	Nichts
subscriptionId	ID des Azure-Abonnements, in dem sich die Azure API Center-Instanz befindet.	Nichts
workspace	Name des zu verwendenden Azure API Center-Arbeitsbereichs.	default

Befehlszeilenoptionen

Nichts

Bemerkungen

Das ApiCenterProductionVersionPlugin-Plug-In überprüft, ob die in einer App verwendeten APIs die Produktionsversion der APIs sind, die in der angegebenen Azure API Center-Instanz registriert sind. Wenn die APIs mit Nichtproduktionsversionen übereinstimmen, zeigt das Plug-In eine Warnung an.

Um eine Verbindung mit Azure API Center herzustellen, verwendet das Plug-In Azure-Anmeldeinformationen (in dieser Reihenfolge):

• Umwelt
• Workload-Identität
• Verwaltete Identität
• Visual Studio
• Visual Studio Code
• Azure-Befehlszeilenschnittstelle (Azure CLI)
• Azure PowerShell
• Azure Developer CLI (Befehlszeilenschnittstelle für Entwickler)

Wenn das Plug-In kein Zugriffstoken für den Zugriff auf Azure erhält, wird ein Fehler angezeigt, und Der Dev-Proxy deaktiviert es. Melden Sie sich mit einem dieser Tools bei Azure an, und starten Sie Dev Proxy neu, um das ApiCenterProductionVersionPlugin-Plug-In zu verwenden.

Wenn Sie Dev Proxy in CI/CD-Pipelines verwenden, können Sie Werte für die subscriptionId, resourceGroupName, serviceNameund workspaceName Eigenschaften als Umgebungsvariablen übergeben. Um Umgebungsvariablen zu verwenden, stellen Sie dem Namen des Werts ein @voran, z. B.:

{
  "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 diesem Beispiel legt das ApiCenterProductionVersionPlugin-Plug-In subscriptionId, resourceGroupName, serviceNameund workspaceName Eigenschaften auf die Werte der Variablen AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEund AZURE_APIC_WORKSPACE_NAME Umgebung fest.

Nächster Schritt

So überprüfen Sie, ob meine App APIs auf Produktionsebene verwendet