Plugin für die Einführung in das ApiCenter

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

Definition der Plug-In-Instanz

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

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigentum	Beschreibung	Vorgabe
createApicEntryForNewApis	Legen Sie auf true fest, damit Dev Proxy neue API-Einträge für die von ihr erkannten APIs erstellt und die noch nicht im API Center registriert sind. Wenn dieser auf false Dev Proxy festgelegt ist, werden nur die nicht registrierten APIs in der Eingabeaufforderung aufgelistet.	true
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 ApiCenterOnboardingPlugin-Plug-In überprüft, ob die in einer App verwendeten APIs in der angegebenen Azure API Center-Instanz registriert sind. Wenn die APIs nicht registriert sind, kann das Plug-In neue API-Einträge in der API Center-Instanz erstellen.

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

• Umwelt
• Workload-Identität
• Verwaltete Identität
• Visuelles 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 ApiCenterOnboardingPlugin-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.:

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

In diesem Beispiel legt das ApiCenterOnboardingPlugin-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 finden Sie Schatten-APIs