ApiCenterProductionVersionPlugin

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

Definicja wystąpienia wtyczki

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

Przykład konfiguracji

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

Właściwości konfiguracji

Właściwość	Opis	Default
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 powinien używać serwer proxy deweloperów, aby sprawdzić, 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 ApiCenterProductionVersionPlugin sprawdza, czy interfejsy API używane w aplikacji są wersją produkcyjną interfejsów API zarejestrowanych w określonym wystąpieniu centrum interfejsów API platformy Azure. Jeśli interfejsy API są zgodne z wersjami nieprodukcyjnymi, wtyczka wyświetli ostrzeżenie.

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ę do platformy Azure przy użyciu dowolnego z tych narzędzi i uruchom ponownie serwer proxy deweloperów, aby użyć wtyczki ApiCenterProductionVersionPlugin .

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

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

W tym przykładzie wtyczka ApiCenterOnboardingPlugin ustawia subscriptionIdodpowiednio wartości zmiennych środowiskowych AZURE_APIC_INSTANCE_NAMEAZURE_RESOURCE_GROUP_NAME, resourceGroupName, serviceName, i AZURE_APIC_WORKSPACE_NAME i workspaceName na wartości AZURE_SUBSCRIPTION_ID.