Compartir a través de

ApiCenterOnboardingPlugin

  • Artículo

Comprueba si las API usadas en una aplicación están 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 registradas están registradas en el Centro de API de Azure.

Definición de instancia del complemento

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

Ejemplo de configuración

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

Propiedades de configuración

Propiedad Descripción Default
createApicEntryForNewApis true Establézcalo en para que Dev Proxy cree nuevas entradas de API para las API que detectó y que aún no están registradas en el Centro de API. Cuando se establece false en Proxy de desarrollo, solo se enumeran las API no registradas en el símbolo del sistema. true
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 el proxy de desarrollo debe usar 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 ApiCenterOnboardingPlugin complemento comprueba si las API usadas en una aplicación están registradas en la instancia especificada del Centro de API de Azure. Si las API no están registradas, el complemento puede crear nuevas entradas de API en la instancia del Centro de API.

Para conectarse al Centro de API de Azure, el complemento usa las 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 el proxy de desarrollo lo deshabilita. Inicie sesión en Azure con cualquiera de estas herramientas y reinicie Dev Proxy para usar el ApiCenterOnboardingPlugin complemento.

Si usa el proxy de desarrollo 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",
    "createApicEntryForNewApis": true
  }
}

En este ejemplo, el ApiCenterOnboardingPlugin complemento establece subscriptionIdlas propiedades , resourceGroupNameserviceName, y workspaceName en los valores de las AZURE_SUBSCRIPTION_IDvariables de entorno , AZURE_RESOURCE_GROUP_NAMEAZURE_APIC_INSTANCE_NAME, y AZURE_APIC_WORKSPACE_NAME , respectivamente.