ApiCenterOnboardingPlugin

Artykuł
05/25/2024

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/dev-proxy-plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

Przykład konfiguracji

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

Właściwości konfiguracji

Właściwość	Opis	Default
`createApicEntryForNewApis`	Ustaw opcję , aby `true` 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. W przypadku wybrania opcji `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.	Brak
`serviceName`	Nazwa wystąpienia centrum interfejsu API platformy Azure, którego serwer proxy deweloperów powinien użyć do sprawdzenia, czy interfejsy API używane w aplikacji są zarejestrowane.	Brak
`subscriptionId`	Identyfikator subskrypcji platformy Azure, w której znajduje się wystąpienie centrum interfejsu API platformy Azure.	Brak
`workspace`	Nazwa obszaru roboczego Centrum interfejsów API platformy Azure do użycia.	`default`

Opcje wiersza polecenia

Brak

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
Azure Developer CLI

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

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

{
  "apiCenterOnboardingPlugin": {
    "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 subscriptionIdodpowiednio wartości , resourceGroupName, serviceNamei workspaceName na wartości AZURE_SUBSCRIPTION_IDzmiennych środowiskowych , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEi AZURE_APIC_WORKSPACE_NAME .

Udostępnij za pośrednictwem