ApiCenterProductionVersionPlugin

Articolo
05/25/2024

Controlla se le API usate in un'app sono una versione di produzione delle API registrate nell'istanza del Centro API di Azure specificata.

Definizione dell'istanza del plug-in

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

Esempio di configurazione

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

Proprietà di configurazione

Proprietà	Descrizione	Predefinito
`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 centro API di Azure da usare.	`default`

Opzioni della riga di comando

nessuno

Osservazioni

Il ApiCenterProductionVersionPlugin plug-in controlla se le API usate in un'app sono una versione di produzione delle API registrate nell'istanza del Centro API di Azure specificata. Se le API corrispondono a versioni non di produzione, il plug-in visualizza un avviso.

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 per accedere 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 ApiCenterProductionVersionPlugin plug-in.

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

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

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

Condividi tramite