Delen via

ApiCenterOnboardingPlugin

Controleert of de API's die in een app worden gebruikt, zijn geregistreerd in het opgegeven Azure API Center-exemplaar.

Schermopname van een opdrachtprompt met Dev Proxy-controle of de geregistreerde API-aanvragen zijn geregistreerd in Azure API Center.

Definitie van invoegtoepassingexemplaren

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

Configuratievoorbeeld

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

Configuratie-eigenschappen

Eigenschap Beschrijving Verstek
createApicEntryForNewApis Stel deze optie in op true om nieuwe API-vermeldingen te maken voor de API's die zijn gedetecteerd en die nog niet zijn geregistreerd in API Center. Wanneer deze instelling is ingesteld op false Dev Proxy worden alleen de niet-geregistreerde API's vermeld in de opdrachtprompt. true
resourceGroupName Naam van de resourcegroep waar het Azure API Center zich bevindt. Geen
serviceName De naam van het Azure API Center-exemplaar dat dev proxy moet gebruiken om te controleren of de API's die in de app worden gebruikt, zijn geregistreerd. Geen
subscriptionId Id van het Azure-abonnement waar het Azure API Center-exemplaar zich bevindt. Geen
workspace De naam van de Azure API Center-werkruimte die moet worden gebruikt. default

Opdrachtregelopties

Geen

Opmerkingen

De ApiCenterOnboardingPlugin-invoegtoepassing controleert of de API's die in een app worden gebruikt, zijn geregistreerd in het opgegeven Azure API Center-exemplaar. Als de API's niet zijn geregistreerd, kan de invoegtoepassing nieuwe API-vermeldingen maken in het API Center-exemplaar.

Als u verbinding wilt maken met Azure API Center, gebruikt de invoegtoepassing Azure-referenties (in deze volgorde):

  • Milieu
  • Workloadidentiteit
  • Beheerde identiteit
  • Visual Studio
  • Visual Studio Code
  • Azure-opdrachtregelinterface (CLI)
  • Azure PowerShell
  • Azure-ontwikkelaars-CLI

Als de invoegtoepassing geen toegangstoken voor toegang tot Azure krijgt, wordt er een fout weergegeven en wordt deze uitgeschakeld door Dev Proxy. Meld u aan bij Azure met een van deze hulpprogramma's en start dev proxy opnieuw om de ApiCenterOnboardingPlugin-invoegtoepassing te gebruiken.

Als u Dev Proxy in CI/CD-pijplijnen gebruikt, kunt u waarden doorgeven voor de eigenschappen subscriptionId, resourceGroupName, serviceNameen workspaceName als omgevingsvariabelen. Als u omgevingsvariabelen wilt gebruiken, prepeneert u de naam van de waarde met een @, bijvoorbeeld:

{
  "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 dit voorbeeld stelt de ApiCenterOnboardingPlugin-invoegtoepassing respectievelijk subscriptionId, resourceGroupName, serviceNameen workspaceName eigenschappen in op de waarden van de AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEen AZURE_APIC_WORKSPACE_NAME omgevingsvariabelen.

Volgende stap

Schaduw-API's zoeken