ApiCenterOnboardingPlugin

Artikel
05/25/2024

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

Definitie van invoegtoepassingsexemplaren

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

Configuratievoorbeeld

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

Configuratie-eigenschappen

Eigenschap	Beschrijving	Standaard
`createApicEntryForNewApis`	Stel in op `true` om Dev Proxy nieuwe API-vermeldingen te laten maken voor de API's die zijn gedetecteerd en die nog niet zijn geregistreerd in API Center. Wanneer deze optie is ingesteld op `false` Dev Proxy, worden alleen de niet-geregistreerde API's weergegeven in de opdrachtprompt.	`true`
`resourceGroupName`	Naam van de resourcegroep waarin het Azure API Center zich bevindt.	Geen
`serviceName`	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 waarin 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.

Om verbinding te maken met Azure API Center gebruikt de invoegtoepassing Azure-referenties (in deze volgorde):

Omgeving
Workloadidentiteit
Beheerde identiteit
Visual Studio
Visual Studio Code
Azure CLI
Azure PowerShell
Azure Developer CLI

Als de invoegtoepassing geen toegangstoken kan ophalen om toegang te krijgen tot Azure, wordt er een fout weergegeven en wordt dit door Dev Proxy uitgeschakeld. 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 gebruikt in CI/CD-pijplijnen, kunt u waarden voor de subscriptionIdeigenschappen , resourceGroupName, serviceNameen workspaceName doorgeven als omgevingsvariabelen. Als u omgevingsvariabelen wilt gebruiken, moet u de naam van de waarde vooraf laten gaan door een @, bijvoorbeeld:

{
  "apiCenterOnboardingPlugin": {
    "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 invoegtoepassing de ApiCenterOnboardingPlugin eigenschappen , resourceGroupName, serviceNameen workspaceName in op de waarden van respectievelijk de AZURE_SUBSCRIPTION_IDomgevingsvariabelen , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEen AZURE_APIC_WORKSPACE_NAME .subscriptionId

Delen via