ApiCenterOnboardingPlugin

Kontrollerar om DE API:er som används i en app är registrerade i den angivna Azure API Center-instansen.

Konfigurationsexempel

{
  "$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
  }
}

Konfigurationsegenskaper

Egenskap	Beskrivning	Standard
createApicEntryForNewApis	Ange till true om du vill att Dev Proxy ska skapa nya API-poster för de API:er som identifierades och som ännu inte har registrerats i API Center. När värdet är inställt på false Dev Proxy visas endast de oregistrerade API:erna i kommandotolken.	true
resourceGroupName	Namnet på resursgruppen där Azure API Center finns.	Ingen
serviceName	Namnet på den Azure API Center-instans som Dev Proxy ska använda för att kontrollera om DE API:er som används i appen är registrerade.	Ingen
subscriptionId	ID för Azure-prenumerationen där Azure API Center-instansen finns.	Ingen
workspace	Namnet på den Azure API Center-arbetsyta som ska användas.	default

Kommandoradsalternativ

Ingen

Anmärkningar

Det ApiCenterOnboardingPlugin plugin-programmet kontrollerar om API:erna som används i en app är registrerade i den angivna Azure API Center-instansen. Om API:erna inte är registrerade kan plugin-programmet skapa nya API-poster i API Center-instansen.

För att ansluta till Azure API Center använder plugin-programmet Azure-autentiseringsuppgifter (i den här ordningen):

• Miljö
• Arbetsbelastningsidentitet
• Hanterad identitet
• Visual Studio
• Visual Studio Code
• Azure CLI (kommandoradsgränssnittet för Azure)
• Azure PowerShell
• Azure Developer CLI (kommandoradsgränssnitt)

Om plugin-programmet inte hämtar en åtkomsttoken för åtkomst till Azure visas ett fel och Dev Proxy inaktiverar det. Logga in på Azure med något av dessa verktyg och starta om Dev Proxy för att använda plugin-programmet ApiCenterOnboardingPlugin.

Om du använder Dev Proxy i CI/CD-pipelines kan du skicka värden för egenskaperna subscriptionId, resourceGroupName, serviceNameoch workspace som miljövariabler. Om du vill använda miljövariabler förbereder du namnet på värdet med en @, till exempel:

{
  "$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
  }
}

I det här exemplet anger ApiCenterOnboardingPlugin-plugin-programmet subscriptionId, resourceGroupName, serviceNameoch workspace egenskaper för värdena för AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEoch AZURE_APIC_WORKSPACE_NAME miljövariabler.

Nästa steg

Så här hittar du skugg-API:er