Desarrollo de Azure Functions localmente mediante Core Tools

Azure Functions Core Tools le permite desarrollar y probar las funciones en el equipo local. Cuando esté listo, también puede usar Core Tools para implementar el proyecto de código en Azure y trabajar con la configuración de la aplicación.

Instalación de Azure Functions Core Tools

La manera recomendada de instalar Core Tools depende del sistema operativo del equipo de desarrollo local.

Para obtener ayuda con problemas relacionados con la versión, consulte Versiones de Core Tools.

Creación del proyecto local

En la ventana de terminal, o desde un símbolo del sistema, ejecute el siguiente comando para crear un proyecto en la carpeta :

func init MyProjFolder --worker-runtime dotnet-isolated 

func init MyProjFolder --worker-runtime dotnet 

func init MyProjFolder --worker-runtime javascript --model V4

func init MyProjFolder --worker-runtime javascript --model V3

func init MyProjFolder --worker-runtime typescript --model V4

func init MyProjFolder --worker-runtime typescript --model V3

func init MyProjFolder --worker-runtime powershell

func init MyProjFolder --worker-runtime python --model V2

func init MyProjFolder --worker-runtime python

Cuando se ejecuta sin la opción , se le pedirá que elija el lenguaje del proyecto. Para obtener más información sobre las opciones disponibles para el comando , consulte la referencia de .

Creación de una función

Para agregar una función al proyecto, ejecute el comando con la opción para seleccionar la plantilla de desencadenador. En el siguiente ejemplo, se crea un desencadenador HTTP denominado :

func new --template "Http Trigger" --name MyHttpTrigger

En este ejemplo se crea un desencadenador de Queue Storage denominado :

func new --template "Azure Queue Storage Trigger" --name MyQueueTrigger

Al agregar funciones deben tenerse en cuenta las consideraciones siguientes:

• Cuando se ejecuta sin la opción , se le pedirá que elija una plantilla.

• Use el comando para ver la lista completa de plantillas disponibles para su lenguaje.

• Al agregar un desencadenador que se conecta a un servicio, también deberá agregar una configuración de aplicación que haga referencia a un cadena de conexión o una identidad administrada al archivo local.settings.json. El uso de la configuración de la aplicación de esta manera evita que tenga que insertar credenciales en el código. Para más información, consulte Trabajar con la configuración de la aplicación localmente.

Para obtener más información sobre las opciones disponibles para el comando , consulte la referencia de .

Agregar un enlace a su función

Functions proporciona un conjunto de enlaces de entrada y salida específicos del servicio, lo que facilita la conexión de la función a otros servicios de Azure sin tener que usar los SDK de cliente específicos del servicio. Para obtener más información, consulte conceptos de activadores y enlaces de Azure Functions.

Para agregar un enlace de entrada o salida a una función existente, debe actualizar manualmente la definición de la función.

En el ejemplo siguiente se muestra la definición de función después de agregar un Enlace de salida de Queue Storage a una función desencadenada por HTTP:

[Function("HttpExample")]
public MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

const { app, output } = require('@azure/functions');

const sendToQueue = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  extraOutputs: [sendToQueue],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());
      context.log(`Name: ${name}`);

      if (name) {
        const msg = `Name passed to the function ${name}`;
        context.extraOutputs.set(sendToQueue, [msg]);
        return { body: msg };
      } else {
        context.log('Missing required data');
        return { status: 404, body: 'Missing required data' };
      }
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

import {
  app,
  output,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  StorageQueueOutput,
} from '@azure/functions';

const sendToQueue: StorageQueueOutput = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

export async function HttpExample(
  request: HttpRequest,
  context: InvocationContext,
): Promise<HttpResponseInit> {
  try {
    context.log(`Http function processed request for url "${request.url}"`);

    const name = request.query.get('name') || (await request.text());
    context.log(`Name: ${name}`);

    if (name) {
      const msg = `Name passed to the function ${name}`;
      context.extraOutputs.set(sendToQueue, [msg]);
      return { body: msg };
    } else {
      context.log('Missing required data');
      return { status: 404, body: 'Missing required data' };
    }
  } catch (error) {
    context.log(`Error: ${error}`);
    return { status: 500, body: 'Internal Server Error' };
  }
}

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  handler: HttpExample,
});

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

Las consideraciones siguientes se aplican al agregar enlaces a una función:

• Al agregar enlaces que se conectan a un servicio, también debe agregar una configuración de aplicación que haga referencia a una cadena de conexión o a una identidad administrada en el fichero local.settings.json. Para más información, consulte Trabajar con la configuración de la aplicación localmente.

Iniciar el runtime de Functions

Para poder ejecutar o depurar las funciones del proyecto, debe iniciar el host de Functions desde el directorio raíz del proyecto. El host habilita desencadenadores para todas las funciones del proyecto. Use este comando para iniciar el runtime local:

mvn clean package 
mvn azure-functions:run

func start

func start

func start

npm install
npm start     

Cuando se inicia el host de Functions, genera una lista de funciones en el proyecto, incluidas las direcciones URL de cualquier función desencadenada por HTTP, como en este ejemplo:

Found the following functions:
Host.Functions.MyHttpTrigger

Job host started
Http Function MyHttpTrigger: http://localhost:7071/api/MyHttpTrigger

Tenga en cuenta las siguientes consideraciones al ejecutar las funciones localmente:

• De manera predeterminada, no se aplica la autorización local para puntos de conexión HTTP. Esto significa que todas las solicitudes HTTP locales se tratan como . Para más información, consulte Nivel de autorización. Puede usar la opción para requerir autorización al ejecutarse localmente. Para obtener más información, consulte:

• Puede usar el emulador de Azurite local cuando se ejecutan localmente funciones que requieren acceso a servicios de Azure Storage (Queue Storage, Blob Storage y Table Storage) sin tener que conectarse a estos servicios en Azure. Al usar la emulación local, asegúrese de iniciar Azurite antes de iniciar el host local (func.exe). Para obtener más información, consulte Emulador de almacenamiento local.

• Puede desencadenar funciones que no son HTTP localmente sin conectarse a un servicio activo. Para obtener más información, consulte Ejecutar una función local.

• Al incluir la información de conexión de Application Insights en el archivo local.settings.json, los datos de registro locales se escriben en la instancia específica de Application Insights. Para mantener los datos de telemetría locales separados de los datos de producción, considere la posibilidad de usar una instancia independiente de Application Insights para desarrollo y pruebas.

Ejecutar una función local

Con el host local de Functions (func.exe) en ejecución, ahora puede desencadenar funciones individuales para ejecutar y depurar el código de función. La forma en que se ejecuta una función individual depende de su tipo de desencadenador.

http://localhost:<PORT>/api/<FUNCTION_NAME>

curl --get http://localhost:7071/api/MyHttpTrigger?name=Azure%20Rocks

curl --request POST http://localhost:7071/api/MyHttpTrigger --data '{"name":"Azure Rocks"}'

curl --request POST http://localhost:7071/api/MyHttpTrigger --data "{'name':'Azure Rocks'}"

http://localhost:<PORT>/admin/functions/<FUNCTION_NAME>

{
    "input": "<TRIGGER_INPUT>"
}

curl --request POST -H "Content-Type:application/json" --data '{"input":"sample queue data"}' http://localhost:7071/admin/functions/QueueTrigger

curl --request POST -H "Content-Type:application/json" --data "{'input':'sample queue data'}" http://localhost:7071/admin/functions/QueueTrigger

Publicar en Azure

Core Tools de Azure Functions admite tres tipos de implementación:

Debe tener el CLI de Azure o Azure PowerShell instalado localmente para poder publicar en Azure desde Core Tools. De forma predeterminada, Core Tools usa estas herramientas para autenticarse con su cuenta de Azure.

Si no tiene instaladas estas herramientas, debe obtener un token de acceso válido para usarlo durante la implementación. Puede presentar un token de acceso mediante la opción en los comandos de implementación.

Implementación de los archivos de proyecto

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

Despliegue de contenedores

Core Tools permite implementar la aplicación de funciones containerized tanto en entornos de Azure Container Apps administrados como en clústeres de Kubernetes que administra.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> [--registry-password] [--registry-server] [--registry-username]

func kubernetes deploy --name <DEPLOYMENT_NAME> --registry <REGISTRY_USERNAME> 

Trabajar localmente con la configuración de la aplicación

Cuando la aplicación de funciones se ejecuta en Azure, la configuración necesaria para tus funciones se almacena cifrada en la configuración de la aplicación. Durante el desarrollo local, estas configuraciones se agregan a la colección en el archivo local.settings.json. El archivo local.settings.json también almacena la configuración que usan las herramientas de desarrollo local.

Los elementos de la colección Values del archivo local.settings.json de tu proyecto están diseñados para reflejar elementos en la configuración de la aplicación de tu función en Azure.

Las consideraciones siguientes se aplican al trabajar con el archivo de configuración local:

• Dado que local.settings.json puede contener secretos, como cadenas de conexión, nunca debe almacenarlo en un repositorio remoto. Core Tools le ayuda a cifrar este archivo de configuración local para mejorar la seguridad. Para más información, consulte Archivo de configuración local. También puede cifrar el archivo local.settings.json para mayor seguridad.

• De forma predeterminada, la configuración local no se migra automáticamente cuando el proyecto se publica en Azure. Use la opción --publish-local-settings al publicar los archivos del proyecto para asegurarse de que esta configuración se agrega a la aplicación de funciones en Azure. Los valores de la sección no se publican nunca. También puede cargar la configuración desde el archivo local.settings.json en cualquier momento.

• Puede descargar y sobrescribir las configuraciones de su archivo local.settings.json con las configuraciones de su aplicación de funciones en Azure. Para más información, vea Descargar la configuración de la aplicación.

• Cuando no se establece una cadena de conexión de almacenamiento válida para AzureWebJobsStorage y no se usa un emulador de almacenamiento local, se muestra un error. Puede usar Core Tools para descargar una cadena de conexión específica desde cualquiera de sus cuentas de almacenamiento de Azure.

Descargar la configuración de la aplicación

En la raíz del proyecto, use el comando siguiente para descargar toda la configuración de la aplicación desde la aplicación myfunctionapp12345 en Azure:

func azure functionapp fetch-app-settings myfunctionapp12345

Este comando sobrescribe cualquier configuración existente en el archivo local.settings.json con valores de Azure. Cuando aún no están presente, se agregan nuevos elementos a la colección. Para obtener más información, vea el comando .

Descargar una cadena de conexión de almacenamiento

Core Tools también facilita la obtención del cadena de conexión de cualquier cuenta de almacenamiento a la que tenga acceso. En la raíz del proyecto, use el comando siguiente para descargar el cadena de conexión desde una cuenta de almacenamiento denominada mystorage12345.

func azure storage fetch-connection-string mystorage12345

Este comando agrega un valor denominado mystorage12345_STORAGE al archivo local.settings.json, que contiene el cadena de conexión de la cuenta de mystorage12345. Para obtener más información, vea el comando .

Para mejorar la seguridad durante el desarrollo, considere cifrar el archivo local.settings.json.

Carga de la configuración local en Azure

Al publicar los archivos del proyecto en Azure sin usar la opción --publish-local-settings, la configuración del archivo local.settings.json no se establece en la aplicación de funciones. Siempre puede volver a ejecutar con la opción para cargar solo la configuración sin volver a publicar los archivos del proyecto.

En el ejemplo siguiente se cargan solo los ajustes de la colección Values del archivo local.settings.json en la aplicación de funciones de Azure denominada myfunctionapp12345.

func azure functionapp publish myfunctionapp12345 --publish-settings-only

Cifrado del archivo de configuración local

Para mejorar la seguridad de las cadenas de conexión y otros datos valiosos en la configuración local, Core Tools le permite cifrar el archivo local.settings.json. Cuando se cifra este archivo, el tiempo de ejecución descifra automáticamente la configuración cuando es necesario de la misma manera que lo hace con la configuración de la aplicación en Azure. También puede descifrar un archivo cifrado localmente para trabajar con la configuración.

Use el siguiente comando para cifrar el archivo de configuración local del proyecto:

func settings encrypt

Use el siguiente comando para descifrar una configuración local cifrada, de modo que pueda trabajar con ella:

func settings decrypt

Cuando el archivo de configuración se cifra y descifra, la configuración del archivo también se actualiza.

Configuración de extensiones de enlace

Funciones, los desencadenadores y los enlaces se implementan como paquetes de extensión de .NET (NuGet). Para poder usar una extensión de enlace específica, esa extensión debe instalarse en el proyecto.

Versiones de Core Tools

Las versiones principales de Azure Functions Core Tools están vinculadas a versiones principales específicas del entorno de ejecución de Azure Functions. Por ejemplo, la versión 4.x de Core Tools admite la versión 4.x del entorno de ejecución de Functions. Esta versión es la versión principal recomendada de runtime de Functions y de Core Tools. Puede determinar la versión más reciente de Core Tools en el repositorio Azure Functions Core Tools.

Ejecute el siguiente comando para determinar la versión de la instalación actual de Core Tools:

func --version

A menos que se indique lo contrario, los ejemplos de este artículo son para la versión 4.x.

Las siguientes consideraciones se aplican a las instalaciones de Core Tools:

• Solo puede instalar una versión de Core Tools en un equipo determinado.

• Al actualizar a la versión más reciente de Core Tools, debe usar el mismo método que usó en la instalación original para realizar la actualización. Por ejemplo, si usó una MSI en Windows, desinstale la MSI actual e instale la más reciente. O bien, si ha usado npm, vuelva a ejecutar el .

• Las versiones 2.x y 3.x de Core Tools se usaron con las versiones 2.x y 3.x del entorno de ejecución de Functions, cuyo soporte técnico se terminó. Para obtener más información, consulte la descripción general de las versiones del tiempo de ejecución de Azure Functions.

Pasos siguientes

Aprenda a desarrollar, probar y publicar funciones de Azure mediante las herramientas principales de Azure Functions. Azure Functions Core Tools se código abierto y se hospeda en GitHub. Para reportar un error o una solicitud de función, abre un problema de GitHub.