ApiCenterOnboardingPlugin

Sprawdza, czy interfejsy API używane w aplikacji są zarejestrowane w określonym wystąpieniu centrum interfejsów API platformy Azure.

Definicja wystąpienia wtyczki

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

Przykład konfiguracji

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

Właściwości konfiguracji

Własność	Opis	Domyślny
createApicEntryForNewApis	Ustaw wartość na true, aby serwer proxy deweloperów utworzył nowe wpisy interfejsu API dla wykrytych interfejsów API i które nie zostały jeszcze zarejestrowane w Centrum interfejsów API. Po ustawieniu wartości false serwer proxy deweloperów wyświetla tylko niezarejestrowane interfejsy API w wierszu polecenia.	true
resourceGroupName	Nazwa grupy zasobów, w której znajduje się Centrum interfejsów API platformy Azure.	Żaden
serviceName	Nazwa wystąpienia centrum interfejsu API platformy Azure, którego serwer proxy dewelopera powinien użyć do sprawdzenia, czy interfejsy API używane w aplikacji są zarejestrowane.	Żaden
subscriptionId	Identyfikator subskrypcji platformy Azure, w której znajduje się wystąpienie centrum interfejsu API platformy Azure.	Żaden
workspace	Nazwa obszaru roboczego Centrum interfejsu API platformy Azure do użycia.	default

Opcje wiersza polecenia

Żaden

Uwagi

Wtyczka ApiCenterOnboardingPlugin sprawdza, czy interfejsy API używane w aplikacji są zarejestrowane w określonym wystąpieniu centrum interfejsów API platformy Azure. Jeśli interfejsy API nie są zarejestrowane, wtyczka może utworzyć nowe wpisy interfejsu API w wystąpieniu centrum interfejsu API.

Aby nawiązać połączenie z centrum interfejsów API platformy Azure, wtyczka używa poświadczeń platformy Azure (w tej kolejności):

• Środowisko
• Tożsamość obciążenia
• Tożsamość zarządzana
• Visual Studio
• Visual Studio Code
• Interfejs wiersza polecenia platformy Azure
• Azure PowerShell
• Interfejs wiersza polecenia dla deweloperów platformy Azure

Jeśli wtyczka nie może uzyskać tokenu dostępu w celu uzyskania dostępu do platformy Azure, zostanie wyświetlony błąd i serwer proxy dewelopera go wyłączy. Zaloguj się na platformie Azure przy użyciu jednego z tych narzędzi i uruchom ponownie serwer proxy deweloperów, aby użyć wtyczki ApiCenterOnboardingPlugin.

Jeśli używasz serwera proxy deweloperskiego w potokach ciągłej integracji/ciągłego wdrażania, możesz przekazać wartości dla właściwości subscriptionId, resourceGroupName, serviceNamei workspaceName jako zmiennych środowiskowych. Aby użyć zmiennych środowiskowych, należy wstępnie utworzyć nazwę wartości z @, na przykład:

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

W tym przykładzie wtyczka ApiCenterOnboardingPlugin ustawia właściwości subscriptionId, resourceGroupName, serviceNamei workspaceName na wartości odpowiednio zmiennych środowiskowych AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEi AZURE_APIC_WORKSPACE_NAME.

Następny krok

Jak znaleźć interfejsy API w tle