Desarrollo de Azure Functions mediante Visual Studio Code

La extensión Azure Functions para Visual Studio Code permite desarrollar funciones localmente e implementarlas en Azure. Si esta experiencia es la primera con Azure Functions, puede obtener más información en Introducción a Azure Functions.

La extensión Azure Functions proporciona estas ventajas:

• Editar, compilar y ejecutar funciones en el equipo de desarrollo local.
• Publique el proyecto de Azure Functions directamente en Azure.
• Escriba las funciones en varios lenguajes y aproveche las ventajas de Visual Studio Code.

Requisitos previos

• Visual Studio Code instalado en una de las plataformas compatibles.

• Extensión de Azure Functions. También puede instalar el paquete de extensión Azure Tools, que se recomienda para trabajar con recursos de Azure.

• Una suscripción activa Azure. Si aún no tiene una cuenta, puede crear una a partir de la extensión en Visual Studio Code.

También necesitará estos requisitos previos para ejecutar y depurar las funciones localmente. No es necesario que solo creen o publiquen proyectos en Azure Functions.

• El Azure Functions Core Tools, que permite una experiencia de depuración local integrada. Cuando tenga instalada la extensión Azure Functions, la manera más fácil de instalar o actualizar Core Tools es ejecutando el comando Azure Functions: Install or Update Azure Functions Core Tools desde la paleta de comandos.

Creación de un proyecto de Azure Functions

La extensión de Functions le permite crear el proyecto de aplicación de funciones requerido, cuando cree su primera función. Siga estos pasos para crear una función desencadenada por HTTP en un nuevo proyecto. Un desencadenador HTTP es la plantilla de desencadenador de función más sencilla de mostrar.

1. En Visual Studio Code, presione F1 para abrir la paleta de comandos. Busque y ejecute el comando Azure Functions: Create New Project.... Seleccione la ubicación del directorio para el área de trabajo del proyecto y, después, seleccione Seleccionar.

   Puede crear una nueva carpeta o elegir una carpeta vacía para el área de trabajo del proyecto, pero no elija una carpeta de proyecto que ya forme parte de un área de trabajo.

   En su lugar, puede ejecutar el comando Azure Functions: Create New Containerized Project... para obtener también un Dockerfile generado para el proyecto.

2. Cuando se le solicite, Seleccione un idioma para el proyecto. Si es necesario, elija una versión de idioma específica.

3. Seleccione la plantilla de función de desencadenador HTTP o seleccione Omitir por ahora para crear un proyecto sin una función. Siempre puede agregar una función al proyecto en otro momento.

   Sugerencia

   Para ver plantillas adicionales, seleccione la opción Cambiar filtro de plantilla y establezca el valor en Core o All.

4. En el nombre de la función, escriba HttpExample, seleccione Entrar y, a continuación, seleccione Autorización de funciones .

   Este nivel de autorización requiere que proporcione un valor para la clave de función al llamar al punto de conexión de la función.

5. En la lista desplegable, seleccione Agregar al área de trabajo.

6. En la ventana ¿Confía en los autores de los archivos de esta carpeta?, seleccione Sí.

Visual Studio Code crea una función en el lenguaje elegido y en la plantilla para una función desencadenada por HTTP.

Archivos de proyecto generados

La plantilla de proyecto crea un proyecto en el idioma elegido e instala las dependencias necesarias. Para cualquier lenguaje, el proyecto nuevo contiene los archivos siguientes:

• host.json: permite configurar el host de Functions. Esta configuración se aplica cuando se ejecutan funciones localmente y cuando se ejecutan en Azure. Para más información, consulte la referencia sobre host.json.

• local.settings.json: mantiene la configuración que se usa cuando se ejecutan localmente las funciones. Esta configuración solo se utiliza al ejecutar las funciones de forma local. Para más información, consulte Archivo de configuración local.

  Importante

  Debido a que el archivo local.settings.json puede contener secretos, tiene que excluirlo del control de origen del proyecto.

• Dockerfile (opcional): permite crear una aplicación de funciones en contenedor desde el proyecto mediante una imagen base aprobada para el proyecto. Este archivo solo se obtiene al ejecutar el comando Azure Functions: Create New Containerized Project.... Puede agregar un Dockerfile a un proyecto existente mediante el comando en Core Tools.

En este momento, puede ejecutar la función desencadenadora HTTP localmente.

Incorporación de una función al proyecto

Puede agregar una nueva función a un proyecto existente mediante una de las plantillas de desencadenador de Functions predefinidas. Para agregar un nuevo desencadenador de función, seleccione F1 para abrir la paleta de comandos y, a continuación, busque y ejecute el comando Azure Functions: Create Function. Siga las indicaciones para elegir el tipo de desencadenador y definir los atributos necesarios del desencadenador. Si el disparador requiere una clave de acceso o una cadena de conexión para conectarse a un servicio, tenga listo ese elemento antes de crear el disparador de función.

Conexión a los servicios

Puede conectar la función a otros servicios de Azure agregando enlaces de entrada y salida. Los enlaces conectan la función a otros servicios sin que sea preciso escribir el código de conexión.

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

En el ejemplo siguiente se muestra la definición de la función después de agregar un Enlace de salida de Queue Storage a una función de desencadenador 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"
    }
  ]
}

Iniciar sesión en Azure

Para poder crear Azure recursos o publicar la aplicación, debe iniciar sesión en Azure.

1. Si aún no ha iniciado sesión, en la barra Activity, seleccione el icono de Azure. A continuación, en Resources, seleccione Sign in to Azure.

   

   Si ya ha iniciado sesión y puede ver las suscripciones existentes, vaya a la siguiente sección. Si aún no tiene una cuenta de Azure, seleccione Crear una cuenta de Azure. Los alumnos pueden seleccionar Crear un Azure para la cuenta de estudiantes.

2. Cuando se le solicite en el explorador, seleccione la cuenta de Azure e inicie sesión con las credenciales de la cuenta de Azure. Si opta por crear una cuenta, podrá iniciar sesión una vez que haya completado el proceso de creación.

3. Después de iniciar sesión correctamente, puede cerrar la nueva ventana del explorador. Las suscripciones que pertenecen a la cuenta de Azure se muestran en la barra lateral.

Creación de recursos de Azure

Para poder publicar el proyecto de Functions en Azure, debe tener una aplicación de funciones y recursos relacionados en la suscripción de Azure para ejecutar el código. La aplicación de función proporciona un contexto de ejecución para sus funciones. Al publicar desde Visual Studio Code en una aplicación de funciones en Azure, el proyecto se empaqueta e implementa en la aplicación de funciones seleccionada en la suscripción de Azure.

Al crear una aplicación de funciones en Azure, puede elegir una ruta de acceso de creación rápida de la aplicación de funciones mediante valores predeterminados o una ruta de acceso que le proporcione opciones avanzadas, como el uso de recursos de Azure existentes. De este modo, tendrá más control sobre la creación de los recursos remotos.

Creación de una implementación de Azure Container Apps

Use Visual Studio Code para crear recursos de Azure para un proyecto de código contenedorizado. Cuando la extensión detecta la presencia de un Dockerfile durante la creación de recursos, se le pregunta si desea implementar la imagen de contenedor en lugar de simplemente el código. Visual Studio Code crea un entorno de Azure Container Apps para el proyecto de código en contenedor integrado con Azure Functions. Para obtener más información, consulte el alojamiento de Azure Functions en Azure Container Apps.

El proceso de creación depende de si elige una creación rápida o necesita usar opciones avanzadas:

Para obtener más información sobre los recursos necesarios para ejecutar las funciones en contenedor en Container Apps, consulte Recursos necesarios.

Implementación de los archivos de proyecto

Configure la implementación continua para que tu aplicación de funciones de Azure se actualice cuando actualices los archivos de origen en la ubicación de origen conectada. También puede implementar los archivos del proyecto desde Visual Studio Code. Al publicar desde Visual Studio Code, puede aprovechar las ventajas de la tecnología de implementación Zip.

1. En la paleta de comandos, escriba y seleccione Azure Functions: Implementar en Function App.

2. Seleccione la aplicación de funciones que acaba de crear. Cuando se le solicite sobrescribir las implementaciones anteriores, seleccione Implementar para implementar el código de función en el nuevo recurso de aplicación de funciones.

3. Cuando se complete la implementación, seleccione View Output para ver los resultados de creación e implementación, incluidos los recursos de Azure que creó. Si se pierde la notificación, seleccione el icono de campana en la esquina inferior derecha para verlo de nuevo.

   Recorte de pantalla de la ventana Ver salida.

Obtener la dirección URL de una función desencadenada por HTTP en Azure

Para llamar a una función desencadenada por HTTP desde un cliente, necesitará la dirección URL de la función, que está disponible cuando se realiza la implementación en la aplicación de funciones. Esta dirección URL incluye todas las teclas de función necesarias. Puede usar la extensión para obtener estas direcciones URL para las funciones implementadas. Si solo desea ejecutar la función remota en Azure, utilice la funcionalidad Ejecutar ahora de la extensión.

1. Seleccione F1 para abrir la paleta de comandos y, a continuación, busque y ejecute el comando Azure Functions: Copy Function URL.

2. Siga las indicaciones para seleccionar la aplicación de funciones en Azure y, a continuación, el desencadenador HTTP específico que desea invocar.

La dirección URL de la función se copia en el Portapapeles, junto con las claves necesarias pasadas mediante el parámetro de consulta . Use una herramienta de HTTP para enviar las solicitudes POST, o un explorador para enviar solicitudes GET a la función remota.

Cuando la extensión obtiene la dirección URL de una función en Azure, usa la cuenta de Azure para recuperar automáticamente las claves necesarias para iniciar la función. Más información sobre las claves de acceso de las funciones. El inicio de funciones no desencadenadas por HTTP requiere el uso de la clave de administración.

Ejecución de funciones

La extensión Azure Functions permite ejecutar funciones individuales. Puede ejecutar funciones en el proyecto en el equipo de desarrollo local o en la suscripción de Azure.

En el caso de las funciones de desencadenador HTTP, la extensión llama al punto de conexión HTTP. En los restantes tipos de desencadenadores, la extensión llama a las API de administrador para iniciar la función. El cuerpo del mensaje de la solicitud enviada a la función depende del tipo de desencadenador. Si un desencadenador requiere datos de prueba, se le pedirá que escriba los datos en un formato JSON específico.

Ejecución de funciones en Azure

Para ejecutar una función en Azure desde Visual Studio Code, siga estos pasos:

1. En la paleta de comandos, escriba Azure Functions: Ejecutar función ahora y seleccione la suscripción de Azure.

2. En la lista, elija la aplicación de funciones en Azure. Si no ve la aplicación de funciones, asegúrese de que ha iniciado sesión en la suscripción correcta.

3. En la lista, elija la función que quiere ejecutar. En Especificar cuerpo de la solicitud, escriba el cuerpo del mensaje de la solicitud y presione Entrar para enviar este mensaje de solicitud a la función.

   El texto predeterminado de Especificar cuerpo de la solicitud indica el formato del cuerpo. Si la aplicación de funciones no tiene funciones, se muestra un error de notificación con este error.

   Cuando la función se ejecuta en Azure y devuelve una respuesta, Visual Studio Code muestra una notificación.

También puede ejecutar la función desde el área Azure: Functions abriendo el menú contextual de la función que desea ejecutar desde la aplicación de funciones de la suscripción de Azure y seleccionando Execute Function Now... .

Al ejecutar las funciones en Azure desde Visual Studio Code, la extensión usa la cuenta de Azure para recuperar automáticamente las claves necesarias para iniciar la función. Más información sobre las claves de acceso de las funciones. El inicio de funciones no desencadenadas por HTTP requiere el uso de la clave de administración.

Ejecución local de funciones

El tiempo de ejecución local es el mismo tiempo de ejecución que hospeda la aplicación de funciones en Azure. El tiempo de ejecución lee la configuración local del archivo local.settings.json. Para ejecutar el proyecto de Functions localmente, debe cumplir más requisitos.

Configuración del proyecto para que se ejecute localmente

El tiempo de ejecución de Functions usa una cuenta de Azure Storage internamente para todos los tipos de desencadenadores, excepto HTTP y webhooks. Establezca la clave Values.AzureWebJobsStorage en una cadena de conexión de cuenta de almacenamiento de Azure válida.

En esta sección se usa la extensión Azure Storage para Visual Studio Code con Azure Storage Explorer para conectarse y recuperar la cadena de conexión de almacenamiento.

Para establecer la cadena de conexión de la cuenta de almacenamiento:

1. En Visual Studio, abra Cloud Explorer, expanda Cuenta de almacenamiento>Su cuenta de almacenamiento, seleccione Properties y copie el valor Primary Connection String.

2. En el proyecto, abra el archivo local.settings.json y establezca el valor de la clave AzureWebJobsStorage en el connection string que copió.

3. Repita el paso anterior para agregar claves únicas a la matriz de valores para cualquier otra conexión que requieran sus funciones.

Para más información, consulte Archivo de configuración local.

Depuración local de funciones

Para depurar las funciones, seleccione F5. Si Core Tools no está disponible, se le pedirá que lo instale. Una vez que Core Tools esté instalado y en ejecución, la salida se muestra en el Terminal. Este paso equivale a ejecutar el comando de Core Tools desde el terminal, pero con tareas de compilación adicionales y un depurador asociado.

Cuando se ejecuta el proyecto, puede usar la función Execute Now... característica de la extensión para desencadenar las funciones como lo haría cuando el proyecto se implementa en Azure. Con el proyecto ejecutándose en modo de depuración, los puntos de interrupción se alcanzan en Visual Studio Code tal como se esperaría.

1. En la paleta de comandos, escriba Azure Functions: Execute function now y elija Proyecto local.

2. Elija en el proyecto la función que desea ejecutar y escriba el cuerpo del mensaje de la solicitud en Enter request body (Especificar cuerpo de la solicitud). Presione Entrar para enviar este mensaje de solicitud a la función. El texto predeterminado de Enter request body (Especificar cuerpo de la solicitud) debe indicar el formato del cuerpo. Si la aplicación de funciones no tiene funciones, se muestra un error de notificación con este error.

3. Cuando la función se ejecuta localmente y después de recibir la respuesta, se genera una notificación en Visual Studio Code. La información sobre la ejecución de la función se muestra en el panel Terminal.

Las claves no son necesarias al ejecutarse localmente. Esta regla se aplica tanto a las claves de función como a las claves de nivel de administrador.

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

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.

De forma predeterminada, esta configuración no se migra automáticamente al publicar el proyecto en Azure. Una vez finalizada la publicación, puede elegir publicar la configuración de local.settings.json a la aplicación de funciones en Azure. Para más información, consulte Publicación de la configuración de la aplicación.

Los valores de ConnectionStrings nunca se publican.

Configuración de la aplicación en Azure

La configuración del archivo local.settings.json del proyecto debe coincidir con la configuración de la aplicación en la aplicación de funciones en Azure. Debe agregar cualquier nueva configuración tanto a local.settings.json como a la aplicación de funciones en Azure. Esta configuración no se carga automáticamente cuando publica el proyecto. Del mismo modo, debe descargar cualquier configuración que cree en la aplicación de funciones en el portal a su proyecto local.

Publicación de la configuración de la aplicación

La manera más fácil de publicar la configuración necesaria en su app de función en Azure es usar el vínculo Upload settings que aparece después de publicar su proyecto.

Captura de pantalla para cargar la configuración de la aplicación.

También puede publicar la configuración mediante el comando Azure Functions: Cargar configuración local en la paleta de comandos. Puede agregar configuraciones individuales a la configuración de la aplicación en Azure mediante el comando Azure Functions: Agregar nueva configuración.

Si el archivo local está cifrado, el proceso lo descifra, lo publica y lo cifra de nuevo. Si existen valores en conflicto en las dos ubicaciones, se le pedirá que elija cómo continuar.

Vea la configuración de la aplicación existente en el área Azure: Functions expandiendo la suscripción, la aplicación de funciones y Configuración de la aplicación.

Descargar la configuración de Azure

Si crea la configuración de la aplicación en Azure, puede descargarlos en el archivo local.settings.json mediante el comando Azure Functions: Descargar configuración remota.

Al igual que con la carga, si el archivo local está cifrado, el proceso lo descifra, lo actualiza y lo cifra de nuevo. Si existen valores en conflicto en las dos ubicaciones, se le pedirá que elija cómo continuar.

Instalación de extensiones de enlace

Excepto los desencadenadores HTTP y del temporizador, los enlaces se implementan como paquetes de extensión.

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

dotnet add package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.*, 4.0.0)"
    }
}

Supervisión de funciones

Al ejecutar funciones localmente, Core Tools transmite datos de registro a la consola de Terminal. También puede obtener datos de registro cuando el proyecto de Functions se ejecuta en una aplicación de funciones en Azure. Puede conectarse a los registros de streaming en Azure para ver datos de registro casi en tiempo real. Debe habilitar Application Insights para obtener una comprensión más completa de cómo se comporta la aplicación de funciones.

Application Insights

Debería supervisar la ejecución de las funciones mediante la integración de la aplicación de funciones con Application Insights. Al crear una aplicación de funciones en el portal de Azure, esta integración se produce de forma predeterminada. Al crear su aplicación de funciones durante la publicación en Visual Studio, debe integrar Application Insights usted mismo. Para conocer más, consulte Habilitación de la integración de Application Insights.

Para más información sobre la supervisión mediante Application Insights, consulte Monitor Azure Functions.

Referencia de la paleta de comandos

La extensión Azure Functions proporciona una interfaz gráfica útil para interactuar con las aplicaciones de función en Azure. La misma funcionalidad también está disponible como comandos en la paleta de comandos (F1). Estos comandos Azure Functions están disponibles:

Pasos siguientes

Para obtener más información sobre Azure Functions Core Tools, consulte Work with Azure Functions Core Tools.

Para obtener más información sobre el desarrollo de funciones como bibliotecas de clases de .NET, consulte Azure Functions referencia para desarrolladores de C#. En este artículo también se proporcionan vínculos a ejemplos de cómo usar atributos para declarar los distintos tipos de enlaces admitidos por Azure Functions.