ApiCenterOnboardingPlugin

Článek
05/25/2024

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

Definice instance modulu plug-in

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

Příklad konfigurace

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

Vlastnosti konfigurace

Vlastnost	Popis	Default
`createApicEntryForNewApis`	Nastavte na, `true` aby dev proxy vytvořilo nové položky rozhraní API pro rozhraní API, která zjistila a která ještě nejsou zaregistrovaná v Centru rozhraní API. Pokud je nastavená možnost `false` Dev Proxy, zobrazí se na příkazovém řádku jenom neregistrovaná rozhraní API.	`true`
`resourceGroupName`	Název skupiny prostředků, ve které se nachází Centrum rozhraní Azure API.	Žádné
`serviceName`	Název instance Azure API Center, kterou by měl proxy vývoj použít ke kontrole, jestli jsou zaregistrovaná rozhraní API používaná 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žívaná 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 CENTRA ROZHRANÍ API.

Pro připojení k Azure API Center používá modul plug-in přihlašovací údaje Azure (v tomto pořadí):

Prostředí
Identita úlohy
Spravovaná identita
Visual Studio
Visual Studio Code
Azure CLI
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 proxy pro vývoj, aby se modul plug-in ApiCenterOnboardingPlugin používal.

Pokud používáte dev Proxy v kanálech CI/CD, můžete předat hodnoty vlastností subscriptionId, resourceGroupName, serviceNamea workspaceName jako proměnné prostředí. Pokud chcete použít proměnné prostředí, předejděte název hodnoty @pomocí , například:

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

V tomto příkladu ApiCenterOnboardingPlugin modul plug-in nastaví subscriptionIdvlastnosti , serviceNameresourceGroupName, a workspaceName na hodnoty proměnných AZURE_SUBSCRIPTION_IDprostředí , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEa AZURE_APIC_WORKSPACE_NAME .

Sdílet prostřednictvím