ApiCenterBevezetőPlugin

Ellenőrzi, hogy az alkalmazásban használt API-k regisztrálva vannak-e a megadott Azure API Center-példányban.

Beépülő modulpéldány definíciója

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

Példa konfigurációra

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

Konfigurációs tulajdonságok

Ingatlan	Leírás	Alapértelmezett
createApicEntryForNewApis	Állítsa be true, hogy a Dev Proxy új API-bejegyzéseket hozzon létre az észlelt API-khoz, és amelyek még nincsenek regisztrálva az API Centerben. Ha false Dev Proxy értékre van állítva, a parancssorban csak a nem regisztrált API-k jelennek meg.	true
resourceGroupName	Annak az erőforráscsoportnak a neve, amelyben az Azure API Center található.	Egyik sem
serviceName	Annak az Azure API Center-példánynak a neve, amellyel a Dev Proxynak ellenőriznie kell, hogy az alkalmazásban használt API-k regisztrálva vannak-e.	Egyik sem
subscriptionId	Annak az Azure-előfizetésnek az azonosítója, ahol az Azure API Center-példány található.	Egyik sem
workspace	A használni kívánt Azure API Center-munkaterület neve.	default

Parancssori beállítások

Egyik sem

Megjegyzések

A ApiCenterOnboardingPlugin beépülő modul ellenőrzi, hogy az alkalmazásban használt API-k regisztrálva vannak-e a megadott Azure API Center-példányban. Ha az API-k nincsenek regisztrálva, a beépülő modul új API-bejegyzéseket hozhat létre az API Center-példányban.

Az Azure API Centerhez való csatlakozáshoz a beépülő modul Azure-hitelesítő adatokat használ (ebben a sorrendben):

• Környezet
• Számítási feladatok identitása
• Felügyelt identitás
• Visual Studio
• Visual Studio Code
• Azure CLI (Az Azure parancssori felülete)
• Azure PowerShell
• Azure fejlesztői parancssori felület

Ha a beépülő modul nem tud hozzáférési jogkivonatot lekérni az Azure eléréséhez, hibaüzenet jelenik meg, és a Dev Proxy letiltja. Jelentkezzen be az Azure-ba ezen eszközök bármelyikével, és indítsa újra a Dev Proxyt a ApiCenterOnboardingPlugin beépülő modul használatához.

Ha dev proxyt használ a CI/CD-folyamatokban, környezeti változóként átadhatja a subscriptionId, resourceGroupName, serviceNameés workspaceName tulajdonságait. Környezeti változók használatához az érték nevét egy @kell előre felerősíteni, például:

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

Ebben a példában a ApiCenterOnboardingPlugin beépülő modul a subscriptionId, resourceGroupName, serviceNameés workspaceName tulajdonságokat a AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEés AZURE_APIC_WORKSPACE_NAME környezeti változók értékeihez állítja be.

Következő lépés

Árnyék API-k keresése