ApiCenterOnboardingPlugin

Article
03/07/2025

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

Définition de l’instance de plug-in

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

Exemple de configuration

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

Propriétés de configuration

Propriété	Description	Faire défaut
`createApicEntryForNewApis`	Définissez sur `true` pour que le proxy de développement crée de nouvelles entrées d’API pour les API qu’elle a détectées et qui ne sont pas encore inscrites dans le Centre d’API. Lorsqu’il est défini sur `false` Proxy de développement répertorie uniquement les API non inscrites dans l’invite de commandes.	`true`
`resourceGroupName`	Nom du groupe de ressources où se trouve le Centre d’API Azure.	Aucun
`serviceName`	Nom de l’instance du Centre des API Azure que le proxy de développement doit utiliser pour vérifier si les API utilisées dans l’application sont inscrites.	Aucun
`subscriptionId`	ID de l’abonnement Azure où se trouve l’instance du Centre des API Azure.	Aucun
`workspace`	Nom de l’espace de travail Du Centre des API Azure à utiliser.	`default`

Options de ligne de commande

Aucun

Remarques

Le plug-in ApiCenterOnboardingPlugin vérifie si les API utilisées dans une application sont inscrites dans l’instance du Centre d’API Azure spécifiée. Si les API ne sont pas inscrites, le plug-in peut créer de nouvelles entrées d’API dans l’instance du Centre des API.

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
Azure PowerShell
Azure Developer CLI

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 ApiCenterOnboardingPlugin.

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 :

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

Dans cet exemple, le plug-in ApiCenterOnboardingPlugin 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.

Partager via