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

Artículo
11/16/2021
Tiempo de lectura: 10 minutos

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

En este artículo se admite la creación de ambos tipos de funciones de C# compiladas:

Modelo de ejecución	Descripción
En proceso	El código de función se ejecuta en el mismo proceso que el proceso de host de Functions. Admite .NET Core 3.1 y .NET 6.0. Para más información, consulte Desarrollo de funciones de la biblioteca de clases de C# con Azure Functions.
Proceso aislado	El código de función se ejecuta en un proceso de trabajo de .NET independiente. Admite .NET 5.0 y .NET 6.0. Para más información, consulte Guía para la ejecución de funciones en .NET 5.0 en Azure.

En este artículo, se crea una función desencadenada por HTTP que se ejecuta en .NET 6.0. También hay una versión basada en Visual Studio Code de este artículo.

Este inicio rápido supone un pequeño costo en su cuenta de Azure.

Configuración del entorno local

Antes de empezar, debe disponer de lo siguiente:

SDK de .NET 6.0
Azure Functions Core Tools, versión 4.x.
Una de las siguientes herramientas para crear recursos de Azure:
- CLI de Azure, versión 2.4 o posterior.
- El módulo Azure PowerShell, versión 5.9.0 o posterior.

También necesita una cuenta de Azure con una suscripción activa. Cree una cuenta gratuita.

Comprobación de requisitos previos

Compruebe los requisitos previos, que dependen de si usa la CLI de Azure o Azure PowerShell para crear recursos de Azure:

CLI de Azure
Azure PowerShell

En una ventana de terminal o de comandos, ejecute func --version para comprobar que la versión de Azure Functions Core Tools sea la 4.x.
Ejecute dotnet --list-sdks para comprobar que estén instaladas las versiones necesarias.
Ejecute az --version para comprobar que la versión de la CLI de Azure es la 2.4 o posterior.
Ejecute az login para iniciar sesión en Azure y comprobar una suscripción activa.

En una ventana de terminal o de comandos, ejecute func --version para comprobar que la versión de Azure Functions Core Tools sea la 4.x.
Ejecute dotnet --list-sdks para comprobar que estén instaladas las versiones necesarias.
Ejecute (Get-Module -ListAvailable Az).Version y compruebe que es la versión 5.0 o posterior.
Ejecute Connect-AzAccount para iniciar sesión en Azure y comprobar una suscripción activa.

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.

Ejecute el comando func init, de la manera siguiente, para crear un proyecto de funciones en una carpeta llamada LocalFunctionProj con el entorno de ejecución especificado:
- En proceso
- Proceso aislado
```
func init LocalFunctionProj --dotnet
```
```
func init LocalFunctionProj --worker-runtime dotnet-isolated
```
Vaya a la carpeta del proyecto:
```
cd LocalFunctionProj
```
Esta carpeta contiene varios archivos del proyecto, incluidos los archivos de configuración 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.
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 de código HttpExample.cs.

(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.

HttpExample.cs

El código de función generado a partir de la plantilla depende del tipo de proyecto de C# compilado.

En proceso
Proceso aislado

HttpExample.cs contiene un método Run que recibe datos de solicitud en la variable req de tipo HttpRequest que está decorado con HttpTriggerAttribute, que define el comportamiento del desencadenador.

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace LocalFunctionProj
{
    public static class HttpExample
    {
        [FunctionName("HttpExample")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            string name = req.Query["name"];

            string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
            dynamic data = JsonConvert.DeserializeObject(requestBody);
            name = name ?? data?.name;

            return name != null
                ? (ActionResult)new OkObjectResult($"Hello, {name}")
                : new BadRequestObjectResult("Please pass a name on the query string or in the request body");
        }
    }
}

El objeto de devolución es un objeto ActionResult que devuelve un mensaje de respuesta OkObjectResult (200) o BadRequestObjectResult (400).

HttpExample.cs contiene un método Run que recibe los datos de la solicitud en la variable req y es un objeto HttpRequest que está decorado con HttpTriggerAttribute, que define el comportamiento del desencadenador. Debido al modelo de proceso aislado, HttpRequestData es una representación del objeto HttpRequest real y no del propio objeto de la solicitud.

using System.Collections.Generic;
using System.Net;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.Extensions.Logging;

namespace FunctionApp10
{
    public static class HttpExample
    {
        [Function("HttpExample")]
        public static HttpResponseData Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
            FunctionContext executionContext)
        {
            var logger = executionContext.GetLogger("HttpExample");
            logger.LogInformation("C# HTTP trigger function processed a request.");

            var response = req.CreateResponse(HttpStatusCode.OK);
            response.Headers.Add("Content-Type", "text/plain; charset=utf-8");

            response.WriteString("Welcome to Azure Functions!");

            return response;
        }
    }
}

El objeto devuelto es un objeto HttpResponseData que contiene los datos que se devuelven a la respuesta HTTP.

Para más información, vea Enlaces y desencadenadores HTTP de Azure Functions.

Ejecución local de la función

Para ejecutar una función, inicie el host en tiempo de ejecución local de Azure Functions desde la carpeta LocalFunctionProj:
```
func start
```
Hacia el final de la salida, deberían aparecer las líneas siguientes:
```
 ...

 Now listening on: http://0.0.0.0:7071
 Application started. Press Ctrl+C to shut down.

 Http Functions:

         HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
 ...

 
```
Nota

Si HttpExample no aparece como se ha mostrado arriba, 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.
Copie la dirección URL de la función HttpExample de esta salida en un explorador:
- En proceso
- Proceso aislado
En la dirección URL de la función, anexe la cadena de consulta ?name=<YOUR_NAME>, lo que hace que la dirección URL completa sea http://localhost:7071/api/HttpExample?name=Functions. El explorador debe mostrar un mensaje de respuesta que devuelve el valor de la cadena de consulta. El terminal en el que inició el proyecto también muestra la salida del registro cuando realiza solicitudes.

Vaya a la dirección URL de la función y debería recibir el mensaje Bienvenido a Azure Functions.
Cuando termine, presione Ctrl+C y seleccione y para detener el host de Functions.

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.

Si todavía no lo ha hecho, inicie sesión en Azure:
- CLI de Azure
- Azure PowerShell
```
az login
```
El comando az login inicia sesión en su cuenta de Azure.
```
Connect-AzAccount
```
El cmdlet Connect-AzAccount inicia sesión en su cuenta de Azure.
Cree un grupo de recursos denominado AzureFunctionsQuickstart-rg en la región elegida:
- CLI de Azure
- Azure PowerShell
```
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.
```
New-AzResourceGroup -Name AzureFunctionsQuickstart-rg -Location <REGION>
```
El comando New-AzResourceGroup crea un grupo de recursos. Por lo general, los recursos y los grupos de recursos se crean en una región cerca de usted, y se utiliza alguna de las regiones devueltas por el cmdlet Get-AzLocation.
Cree una cuenta de almacenamiento de uso general en su grupo de recursos y región:
- CLI de Azure
- Azure PowerShell
```
az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS
```
El comando az storage account create crea la cuenta de almacenamiento.
```
New-AzStorageAccount -ResourceGroupName AzureFunctionsQuickstart-rg -Name <STORAGE_NAME> -SkuName Standard_LRS -Location <REGION>
```
El cmdlet New-AzStorageAccount 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.

Cree la aplicación de funciones en Azure:
```
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime dotnet --functions-version 3 --name <APP_NAME> --storage-account <STORAGE_NAME>
```
El comando az functionapp create crea la aplicación de funciones en Azure.
```
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime dotnet-isolated --functions-version 3 --name <APP_NAME> --storage-account <STORAGE_NAME>
```
El comando az functionapp create crea la aplicación de funciones en Azure.
```
New-AzFunctionApp -Name <APP_NAME> -ResourceGroupName AzureFunctionsQuickstart-rg -StorageAccount <STORAGE_NAME> -Runtime dotnet -FunctionsVersion 3 -Location '<REGION>'
```
El cmdlet New-AzFunctionApp crea la aplicación de funciones en Azure.
```
New-AzFunctionApp -Name <APP_NAME> -ResourceGroupName AzureFunctionsQuickstart-rg -StorageAccount <STORAGE_NAME> -Runtime dotnet-isolated -FunctionsVersion 3 -Location '<REGION>'
```
El cmdlet New-AzFunctionApp crea la aplicación de funciones en Azure.
Nota

Este comando crea una aplicación de funciones con la versión 3.x del entorno de ejecución de Azure Functions. El comando func azure functionapp publish que ejecutará más adelante actualiza la aplicación a la versión 4.x.

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 aprovisiona una instancia asociada de Azure Application Insights 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

Después de haber creado correctamente su aplicación de funciones en Azure, estará listo para implementar el proyecto de funciones local mediante el comando func azure functionapp publish.

En el ejemplo siguiente, reemplace <APP_NAME> por el nombre de su aplicación.

func azure functionapp publish <APP_NAME>

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

Invocación de la función en Azure

Como la función usa un desencadenador HTTP y admite solicitudes GET, realice una solicitud HTTP a su dirección URL para invocarla. Es más fácil hacerlo en un explorador.

En proceso
Proceso aislado

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. Cuando vaya a esta dirección URL, el explorador debe mostrar una salida similar a cuando ejecutó la función localmente.

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.

CLI de Azure
Azure PowerShell

az group delete --name AzureFunctionsQuickstart-rg

Remove-AzResourceGroup -Name AzureFunctionsQuickstart-rg

Conexión a Azure Queue Storage