Compartir vía

Inicio rápido: Creación de una función de TypeScript en Azure desde la línea de comandos

  • Artículo

En este artículo se usan herramientas de línea de comandos para crear una función de TypeScript que responda a solicitudes HTTP. Después de probar el código localmente, se implementa en el entorno sin servidor de Azure Functions.

Importante

El contenido de este artículo cambiará en función de la elección del modelo de programación de Node.js en el selector de la parte superior de la página. El modelo v4 está disponible de forma general y está diseñado para que los desarrolladores de JavaScript y TypeScript tengan una experiencia más flexible e intuitiva. Obtenga más información sobre las diferencias entre v3 y v4 en la guía de migración.

Completar este inicio rápido supone un pequeño costo de algunos céntimos de USD en su cuenta de Azure.

También está disponible una de versión este artículo basada en Visual Studio Code.

Configuración del entorno local

Antes de comenzar, debe cumplir los siguientes requisitos previos:

Instalación de Azure Functions Core Tools

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

En los pasos siguientes se utiliza Windows Installer (MSI) para instalar Core Tools v4.x. Para más información sobre otros instaladores basados en paquetes, consulte el archivo Léame de Core Tools.

Descargue y ejecute el instalador de Core Tools según su versión de Windows:

Si ha usado previamente Windows Installer (MSI) para instalar Core Tools en Windows, debe desinstalar la versión anterior desde Agregar/Quitar programas antes de instalar la versión más reciente.

  • Asegúrese de instalar la versión v4.0.5382 de Core Tools o una versión posterior.

Creación de un proyecto de función local

En Azure Functions, un proyecto de función es un contenedor para una o varias funciones individuales que responden a un desencadenador específico. Todas las funciones de un proyecto comparten las mismas configuraciones locales y de hospedaje. En esta sección, se crea un proyecto de función que contiene una sola función.

  1. En una carpeta adecuada, ejecute el comando func init de la siguiente manera para crear un proyecto Node.js v3 de TypeScript en la carpeta actual:

    func init --typescript --model V3

    Esta carpeta contiene ahora varios archivos del proyecto, incluidos los archivos de configuración denominados local.settings.json y host.json. Como local.settings.json puede contener secretos descargados de Azure, el archivo se excluye del control de código fuente de forma predeterminada en el archivo .gitignore.

  2. Agregue una función al proyecto mediante el comando siguiente, donde el argumento --name es el nombre único de la función (HttpExample) y el argumento --template especifica el desencadenador de esta (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"

    func new crea una subcarpeta que coincide con el nombre de la función que contiene un archivo de código apropiado para el lenguaje elegido del proyecto y un archivo de configuración denominado function.json.

(Opcional) Examen del contenido del archivo

Si lo desea, puede ir a Ejecución local de la función y examine el contenido del archivo posteriormente.

index.ts

index.ts exporta una función que se desencadena de acuerdo con la configuración de function.json.

import { AzureFunction, Context, HttpRequest } from "@azure/functions"

const httpTrigger: AzureFunction = async function (context: Context, req: HttpRequest): Promise<void> {
    context.log('HTTP trigger function processed a request.');
    const name = (req.query.name || (req.body && req.body.name));
    const responseMessage = name
        ? "Hello, " + name + ". This HTTP triggered function executed successfully."
        : "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.";

    context.res = {
        // status: 200, /* Defaults to 200 */
        body: responseMessage
    };

};

export default httpTrigger;

Con un desencadenador HTTP, la función recibe datos de solicitud en la variable req de tipo HttpRequest, como se define en function.json. El objeto devuelto, definido como $return en function.json, es la respuesta.

function.json

function.json es un archivo de configuración que define la entrada y salida bindings de la función, lo que incluye el tipo de desencadenador.

{
    "bindings": [
        {
            "authLevel": "function",
            "type": "httpTrigger",
            "direction": "in",
            "name": "req",
            "methods": [
                "get",
                "post"
            ]
        },
        {
            "type": "http",
            "direction": "out",
            "name": "res"
        }
    ]
}

Cada enlace requiere una dirección, un tipo y un nombre único. El desencadenador HTTP tiene un enlace de entrada de tipo httpTrigger y un enlace de salida de tipo http.

  1. En una carpeta adecuada, ejecute el comando func init de la siguiente manera para crear un proyecto Node.js v4 de TypeScript en la carpeta actual:

    func init --typescript

    Esta carpeta contiene ahora varios archivos para el proyecto, incluidos los archivos de configuración denominados local.settings.json y host.json. Como local.settings.json puede contener secretos descargados de Azure, el archivo se excluye del control de código fuente de forma predeterminada en el archivo .gitignore. Los paquetes npm necesarios también se instalan en node_modules.

  2. Agregue una función al proyecto mediante el comando siguiente, donde el argumento --name es el nombre único de la función (HttpExample) y el argumento --template especifica el desencadenador de esta (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"

    func new crea un archivo denominado httpExample.ts en el directorio src/functions, que contiene el código de la función.

  3. Agregue información de conexión de Azure Storage en local.settings.json.

    {
    "Values": {       
        "AzureWebJobsStorage": "<Azure Storage connection information>",
        "FUNCTIONS_WORKER_RUNTIME": "node"
    }
}

  4. (Opcional) Si desea obtener más información sobre una función determinada, por ejemplo, el desencadenador HTTP, puede ejecutar el siguiente comando:

    func help httptrigger

Ejecución local de la función

  1. Para ejecutar una función, inicie el host en tiempo de ejecución local de Azure Functions desde la carpeta LocalFunctionProj:

    npm install
npm start

    npm start

    Hacia el final de la salida, deberían aparecer los registros siguientes:

    Captura de pantalla de la salida de la ventana de terminal al ejecutar la función localmente.

    Nota

    Si HttpExample no aparece como se ha mostrado en los registros, es probable que haya iniciado el host desde fuera de la carpeta raíz del proyecto. En ese caso, use Ctrl+c para detener el host, vaya a la carpeta raíz del proyecto y vuelva a ejecutar el comando anterior.

  2. Copie la dirección URL de la función HttpExample de esta salida en un explorador y anexe la cadena de consulta ?name=<your-name>, lo que hará que la dirección URL completa sea http://localhost:7071/api/HttpExample?name=Functions. El explorador debe mostrar un mensaje como este Hello Functions:

    Resultado de la ejecución de la función localmente en el explorador

    El terminal en el que inició el proyecto también muestra la salida del registro cuando realiza solicitudes.

  3. Cuando esté listo, presione Ctrl+c y elija y para detener el host de funciones.

Creación de recursos auxiliares de Azure para la función

Antes de poder implementar el código de la función en Azure, debe crear tres recursos:

  • Un grupo de recursos, que es un contenedor lógico de recursos relacionados.
  • Una cuenta de almacenamiento, que se usa para mantener el estado y otra información sobre sus funciones.
  • Una aplicación de funciones, que proporciona el entorno para ejecutar el código de función. Una aplicación de funciones se asigna al proyecto de funciones y le permite agrupar funciones como una unidad lógica para facilitar la administración, la implementación y el uso compartido de recursos.

Utilice los comandos siguientes para crear los elementos. Se admiten las CLI de Azure y de PowerShell.

  1. Si todavía no lo ha hecho, inicie sesión en Azure:

    az login

    El comando az login inicia sesión en su cuenta de Azure.

  2. Cree un grupo de recursos denominado AzureFunctionsQuickstart-rg en la región elegida:

    az group create --name AzureFunctionsQuickstart-rg --location <REGION>

    El comando az group create crea un grupo de recursos. En el comando anterior, reemplace <REGION> por una región cercana mediante un código de región disponible devuelto por el comando az account list-locations.

  3. Cree una cuenta de almacenamiento de uso general en su grupo de recursos y región:

    az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false

    El comando az storage account create crea la cuenta de almacenamiento.

    En el ejemplo anterior, reemplace <STORAGE_NAME> por un nombre que sea apropiado para usted y único en Azure Storage. Los nombres deben contener entre 3 y 24 caracteres y solo letras minúsculas. Standard_LRS especifica una cuenta de uso general, que es compatible con Functions.

Importante

La cuenta de almacenamiento se usa para almacenar datos importantes de la aplicación, a veces incluido el propio código de la aplicación. Debe limitar el acceso desde otras aplicaciones y usuarios a la cuenta de almacenamiento.

  1. Cree la aplicación de funciones en Azure:

    az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime node --runtime-version 18 --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>

    El comando az functionapp create crea la aplicación de funciones en Azure. Se recomienda usar la última versión de Node.js, que actualmente es 18. Puede especificar la versión estableciendo --runtime-version en 18.

    En el ejemplo anterior, reemplace <STORAGE_NAME> por el nombre de la cuenta que usó en el paso anterior y reemplace <APP_NAME> por un nombre único global que le resulte adecuado. <APP_NAME> también es el dominio DNS predeterminado de la aplicación de función.

    Este comando crea una aplicación de funciones que se ejecuta en el entorno de ejecución del lenguaje especificado en el plan de consumo de Azure Functions, que es gratuito para la cantidad de uso que se realiza aquí. El comando también crea una instancia asociada de Application Insights de Azure en el mismo grupo de recursos con la que puede supervisar la aplicación de funciones y ver registros. Para más información, consulte Supervisión de Azure Functions. La instancia no incurrirá en ningún costo hasta que se active.

Implementación del proyecto de función en Azure

Antes de usar Core Tools para implementar el proyecto en Azure, creará una compilación lista para producción de archivos de JavaScript a partir de los archivos de origen de TypeScript.

  1. Use el siguiente comando para preparar el proyecto de TypeScript para la implementación:

    npm run build

  2. Con los recursos necesarios en vigor, ya está listo para implementar el proyecto de funciones local en la aplicación de funciones de Azure mediante el comando publish. En el ejemplo siguiente, reemplace <APP_NAME> por el nombre de su aplicación.

    func azure functionapp publish <APP_NAME>

    Si aparece el error "Can't find app with name..." (No se encuentra la aplicación...), espere unos segundos e inténtelo de nuevo, ya que es posible que Azure no haya inicializado completamente la aplicación después del comando az functionapp create anterior.

    El comando de publicación muestra un resultado similar a lo que se muestra a continuación (se ha truncado para que resulte más simple):

     ...

 Getting site publishing info...
 Creating archive for current directory...
 Performing remote build for functions project.

 ...

 Deployment successful.
 Remote build succeeded!
 Syncing triggers...
 Functions in msdocs-azurefunctions-qs:
     HttpExample - [httpTrigger]
         Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample?code=KYHrydo4GFe9y0000000qRgRJ8NdLFKpkakGJQfC3izYVidzzDN4gQ==

Invocación de la función en Azure

Como la función usa un desencadenador HTTP, para invocarla es preciso realizar una solicitud HTTP a su dirección URL en el explorador o con una herramienta como CURL.

Copie la dirección URL de invocación completa que se muestra en la salida del comando de publicación en una barra de direcciones del explorador, y anexe el parámetro de consulta ?name=Functions. El explorador debe mostrar una salida similar a cuando ejecutó la función localmente.

La salida de la función ejecutada en Azure en un explorador

Ejecute el siguiente comando para ver registros de streaming casi en tiempo real:

func azure functionapp logstream <APP_NAME>

En una ventana de terminal independiente o en el explorador, vuelva a llamar a la función remota. En la ventana de terminal, se mostrará un registro detallado de la ejecución de la función en Azure.

Limpieza de recursos

Si continúa con el paso siguiente y agrega un enlace de salida de la cola de Azure Storage, conserve todos los recursos intactos, ya que va a crear a partir de lo que ya ha hecho.

De lo contrario, use el siguiente comando para eliminar el grupo de recursos y todos los recursos que contiene para evitar incurrir en costos adicionales.

az group delete --name AzureFunctionsQuickstart-rg

Pasos siguientes

Conexión a una cola de Azure Storage