ApiCenterOnboardingPlugin

Zkontroluje, jestli jsou rozhraní API použitá v aplikaci zaregistrovaná v zadané instanci Azure API Center.

Příklad konfigurace

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterOnboardingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterOnboardingPlugin"
    }
  ],
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspace": "default",
    "createApicEntryForNewApis": true
  }
}

Vlastnosti konfigurace

Vlastnost	Popis	Výchozí
createApicEntryForNewApis	Nastavte na true, aby dev proxy vytvořil nové položky rozhraní API pro rozhraní API, která zjistila a které ještě nejsou zaregistrované ve službě API Center. Pokud je tato možnost nastavená na false Dev Proxy zobrazí seznam neregistrovaných rozhraní API pouze v příkazovém řádku.	true
resourceGroupName	Název skupiny prostředků, ve které se nachází Azure API Center.	Žádný
serviceName	Název instance Azure API Center, kterou by měl dev proxy server použít ke kontrole, jestli jsou zaregistrovaná rozhraní API použitá v aplikaci.	Žádný
subscriptionId	ID předplatného Azure, ve kterém se nachází instance Azure API Center.	Žádný
workspace	Název pracovního prostoru Azure API Center, který se má použít.	default

Možnosti příkazového řádku

Žádný

Poznámky

Modul plug-in ApiCenterOnboardingPlugin zkontroluje, jestli jsou rozhraní API použitá v aplikaci zaregistrovaná v zadané instanci azure API Center. Pokud rozhraní API nejsou zaregistrovaná, může modul plug-in vytvořit nové položky rozhraní API v instanci služby API Center.

K připojení ke službě Azure API Center používá modul plug-in přihlašovací údaje Azure (v tomto pořadí):

• Životní prostředí
• Identita úloh
• Spravovaná identita
• Visual Studio
• Visual Studio Code
• Azure CLI (příkazový řádek nástroje Azure)
• Azure PowerShell
• Azure Developer CLI

Pokud se modulu plug-in nepodaří získat přístupový token pro přístup k Azure, zobrazí se chyba a Dev Proxy ho zakáže. Přihlaste se k Azure pomocí některého z těchto nástrojů a restartujte Dev Proxy a použijte modul plug-in ApiCenterOnboardingPlugin.

Pokud v kanálech CI/CD používáte Dev Proxy, můžete předat hodnoty pro subscriptionId, resourceGroupName, serviceNamea workspace vlastnosti jako proměnné prostředí. Pokud chcete použít proměnné prostředí, předpřipravený název hodnoty pomocí @, například:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterOnboardingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterOnboardingPlugin"
    }
  ],
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspace": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

V tomto příkladu modul plug-in ApiCenterOnboardingPlugin nastaví vlastnosti subscriptionId, resourceGroupName, serviceNamea workspace na hodnoty AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEa AZURE_APIC_WORKSPACE_NAME proměnných prostředí.

Další krok

Jak najít stínová rozhraní API