ApiCenterOnboardingPlugin

Controlla se le API usate in un'app vengono registrate nell'istanza del Centro API di Azure specificata.

Definizione dell'istanza del plug-in

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

Esempio di configurazione

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

Proprietà di configurazione

Proprietà	Descrizione	Predefinito
createApicEntryForNewApis	Impostare su true per fare in modo che Dev Proxy crei nuove voci API per le API rilevate e che non sono ancora registrate nel Centro API. Se impostato su false Proxy di sviluppo elenca solo le API non registrati nel prompt dei comandi.	true
resourceGroupName	Nome del gruppo di risorse in cui si trova il Centro API di Azure.	Nessuno
serviceName	Nome dell'istanza del Centro API di Azure che Dev Proxy deve usare per verificare se le API usate nell'app sono registrate.	Nessuno
subscriptionId	ID della sottoscrizione di Azure in cui si trova l'istanza del Centro API di Azure.	Nessuno
workspace	Nome dell'area di lavoro del Centro API di Azure da usare.	default

Opzioni della riga di comando

Nessuno

Osservazioni

Il plug-in ApiCenterOnboardingPlugin controlla se le API usate in un'app vengono registrate nell'istanza del Centro API di Azure specificata. Se le API non sono registrate, il plug-in può creare nuove voci API nell'istanza di Centro API.

Per connettersi al Centro API di Azure, il plug-in usa le credenziali di Azure (in questo ordine):

• Ambiente
• Identità del carico di lavoro
• Identità gestita
• Visual Studio
• Visual Studio Code
• Interfaccia della riga di comando di Azure
• Azure PowerShell
• Interfaccia della riga di comando per sviluppatori di Azure

Se il plug-in non riesce a ottenere un token di accesso ad Azure, viene visualizzato un errore e Dev Proxy lo disabilita. Accedere ad Azure usando uno di questi strumenti e riavviare Dev Proxy per usare il plug-in ApiCenterOnboardingPlugin.

Se si usa Dev Proxy nelle pipeline CI/CD, è possibile passare valori per le proprietà subscriptionId, resourceGroupName, serviceNamee workspaceName come variabili di ambiente. Per usare le variabili di ambiente, anteporre il nome del valore con un @, ad esempio:

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

In questo esempio, il plug-in ApiCenterOnboardingPlugin imposta le proprietà subscriptionId, resourceGroupName, serviceNamee workspaceName rispettivamente sui valori delle variabili di ambiente AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEe AZURE_APIC_WORKSPACE_NAME.

Passo successivo

Come trovare le API shadow