ApiCenterProductionVersionPlugin

Vérifie si les API utilisées dans une application sont une version de production des API inscrites dans l’instance du Centre d’API Azure spécifiée.

Définition de l’instance de plug-in

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

Exemple de configuration

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

Propriétés de configuration

Options de ligne de commande

Aucun

Remarques

Le plug-in ApiCenterProductionVersionPlugin vérifie si les API utilisées dans une application sont une version de production des API inscrites dans l’instance du Centre d’API Azure spécifiée. Si les API correspondent à des versions hors production, le plug-in affiche un avertissement.

Pour vous connecter au Centre des API Azure, le plug-in utilise les informations d’identification Azure (dans cet ordre) :

• Environnement
• Identité de charge de travail
• Identité managée
• Visual Studio
• Visual Studio Code
• Azure CLI (Interface de ligne de commande Azure)
• Azure PowerShell
• Interface en ligne de commande Azure pour les développeurs

Si le plug-in ne parvient pas à obtenir un jeton d’accès pour accéder à Azure, il affiche une erreur et le proxy de développement le désactive. Connectez-vous à Azure à l’aide de l’un de ces outils et redémarrez le proxy de développement pour utiliser le plug-in ApiCenterProductionVersionPlugin.

Si vous utilisez le proxy de développement dans des pipelines CI/CD, vous pouvez transmettre des valeurs pour les subscriptionId, resourceGroupName, serviceNameet workspaceName propriétés en tant que variables d’environnement. Pour utiliser des variables d’environnement, ajoutez le nom de la valeur avec un @, par exemple :

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

Dans cet exemple, le plug-in ApiCenterProductionVersionPlugin définit subscriptionId, resourceGroupName, serviceNameet workspaceName propriétés sur les valeurs de la AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEet AZURE_APIC_WORKSPACE_NAME variables d’environnement, respectivement.

Étape suivante