ApiCenterOnboardingPlugin (Plugin de incorporación)

Comprueba si las API usadas en una aplicación se registran en la instancia especificada del Centro de API de Azure.

Definición de instancia del complemento

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

Ejemplo de configuración

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

Propiedades de configuración

Propiedad	Descripción	Predeterminado
createApicEntryForNewApis	Establézcalo en true para que el proxy de desarrollo 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 en false proxy de desarrollo solo muestra 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.	Ninguno
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.	Ninguno
subscriptionId	Identificador de la suscripción de Azure donde se encuentra la instancia del Centro de API de Azure.	Ninguno
workspace	Nombre del área de trabajo del Centro de API de Azure que se va a usar.	default

Opciones de línea de comandos

Ninguno

Observaciones

El complemento ApiCenterOnboardingPlugin comprueba si las API usadas en una aplicación están registradas en la instancia de Azure API Center especificada. 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 credenciales de Azure (en este orden):

• Medio ambiente
• Identidad de carga de trabajo
• Identidad administrada
• Visual Studio
• Visual Studio Code
• CLI de Azure
• Azure PowerShell
• CLI para desarrolladores 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 complemento ApiCenterOnboardingPlugin.

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

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "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 complemento de ApiCenterOnboardingPlugin establece subscriptionId, resourceGroupName, serviceNamey workspaceName propiedades en los valores de las AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEy AZURE_APIC_WORKSPACE_NAME variables de entorno, respectivamente.

Paso siguiente

Búsqueda de api de instantáneas