ApiCenterOnboardingPlugin

Artikel
05/25/2024

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

Definition von Plug-In-instance

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

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigenschaft	BESCHREIBUNG	Standard
`createApicEntryForNewApis`	Legen Sie diese Einstellung fest `true` , damit der Dev Proxy neue API-Einträge für die APIs erstellt, die er erkannt hat und die noch nicht im API Center registriert sind. Wenn 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.	Keine
`serviceName`	Name des Azure API Center-instance, den der Dev Proxy verwenden sollte, um zu überprüfen, ob die in der App verwendeten APIs registriert sind.	Keine
`subscriptionId`	ID des Azure-Abonnements, in dem sich das Azure API Center instance befindet.	Keine
`workspace`	Name des zu verwendenden Azure API Center-Arbeitsbereichs.	`default`

Befehlszeilenoptionen

Keine

Bemerkungen

Das ApiCenterOnboardingPlugin Plug-In überprüft, ob die in einer App verwendeten APIs im angegebenen Azure API Center-instance registriert sind. Wenn die APIs nicht registriert sind, kann das Plug-In neue API-Einträge im API Center-instance erstellen.

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

Environment
Workloadidentität
Verwaltete Identität
Visual Studio
Visual Studio Code
Azure CLI
Azure PowerShell
Azure Developer CLI

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

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

{
  "apiCenterOnboardingPlugin": {
    "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 subscriptionIddas Plug-In die ApiCenterOnboardingPlugin Eigenschaften , resourceGroupName, serviceNameund workspaceName auf die Werte der AZURE_SUBSCRIPTION_IDUmgebungsvariablen, AZURE_RESOURCE_GROUP_NAMEAZURE_APIC_INSTANCE_NAME, und AZURE_APIC_WORKSPACE_NAME fest.

Freigeben über