Compartir a través de

ApiCenterProductionVersionPlugin

  • Artículo

Comprueba si las API usadas en una aplicación son la versión de producción de las API registradas en la instancia especificada del Centro de API de Azure.

Captura de pantalla de un símbolo del sistema que muestra la comprobación del proxy de desarrollo si las solicitudes de API grabadas coinciden con las API de versión de producción registradas en el Centro de API de Azure.

Definición de instancia del complemento

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

Ejemplo de configuración

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

Propiedades de configuración

Propiedad Descripción Default
resourceGroupName Nombre del grupo de recursos donde se encuentra el Centro de API de Azure. None
serviceName Nombre de la instancia del Centro de API de Azure que debe usar Dev Proxy para comprobar si las API usadas en la aplicación están registradas. None
subscriptionId Identificador de la suscripción de Azure donde se encuentra la instancia del Centro de API de Azure. None
workspace Nombre del área de trabajo del Centro de API de Azure que se va a usar. default

Opciones de línea de comandos

None

Observaciones

El ApiCenterProductionVersionPlugin complemento comprueba si las API usadas en una aplicación son la versión de producción de las API registradas en la instancia especificada del Centro de API de Azure. Si las API coinciden con versiones que no son de producción, el complemento muestra una advertencia.

Para conectarse al Centro de API de Azure, el complemento usa credenciales de Azure (en este orden):

  • Entorno
  • Identidad de carga de trabajo
  • Identidad administrada
  • Visual Studio
  • Visual Studio Code
  • Azure CLI
  • Azure PowerShell
  • CLI de desarrollo de Azure

Si el complemento no puede obtener un token de acceso para acceder a Azure, muestra un error y dev Proxy lo deshabilita. Inicie sesión en Azure con cualquiera de estas herramientas y reinicie Dev Proxy para usar el ApiCenterProductionVersionPlugin complemento.

Si usa Dev Proxy en canalizaciones de CI/CD, puede pasar valores para las subscriptionIdpropiedades , resourceGroupName, serviceNamey workspaceName como variables de entorno. Para usar variables de entorno, anteponga el nombre del valor con , @por ejemplo:

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

En este ejemplo, el ApiCenterOnboardingPlugin complemento establece subscriptionIdlas propiedades , resourceGroupName, serviceNamey workspaceName en los valores de las AZURE_SUBSCRIPTION_IDvariables de entorno , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEy AZURE_APIC_WORKSPACE_NAME , respectivamente.