Usar cualquier paquete NuGet en Azure Functions

En esta entrada voy a tratar de explicar de forma sencilla como utilizar paquetes NuGet dentro de nuestras Azure Functions sin referenciarlos desde Azure Functions.
Recordemos que dentro del código de nuestras Azure Functions, podemos referenciar a un paquete determinado mediante el uso de #r, como por ejemplo: #r “Newtonsoft.Json”.

Sin embargo, la referencia no existe para todos los paquetes NuGet y solo para unos pocos.
Para más información al respecto, te sugiero visitar este enlace.

Por lo tanto, si dentro de nuestra Azure Function queremos utilizar un paquete NuGet que no está dentro de la lista de los utilizables bajo una referencia, ¿cómo podemos hacerlo?.

Bastará con llevar a cabo las siguientes operaciones que voy a describir.

Lo primero de todo, partiremos de una Azure Function existente.
En concreto la típica Azure Function “Hello World”.

Dentro del portal de Azure, haremos clic sobre nuestra Azure Function, y en la parte derecha de la web, encontraremos un panel sobre el que podemos hacer clic para desplegar los ficheros que forman parte de nuestra Azure Functions.

Por defecto, encontraremos algo parecido a lo que se muestra en la siguiente imagen:

Aquí vemos que tenemos tres ficheros:

• function.json
• readme.md
• run.csx

El fichero run.csx contiene el código de nuestra Azure Function, pero para referenciar a un paquete NuGet externo, deberemos tener “algo” que ayude a run.csx a localizar el paquete.

Esto lo conseguimos en el fichero project.json.

Como podemos ver, no existe, por lo que tendremos que crearlo.

Para ello, pulsaremos el botón Add de la parte superior en la que localizamos los ficheros de nuestra Azure Function.

Una vez creado el fichero project.json (demorará unos segundo en crearse), podremos escribir dentro de él lo que consideremos oportuno.

En nuestro caso, y dado que queremos utilizar un paquete NuGet externo, como por ejemplo ISO3166 (versión 1.0.1 por ejemplo) que encontraremos aquí y que nos permite extraer el nombre de los países según el Iso3166, el contenido de nuestro project.json quedará de la siguiente forma.

{
“frameworks”: {
“net46”:{
“dependencies”: {
“ISO3166”: “1.0.1”
}
}
}
}

Para editar el fichero project.json, basta con seleccionarlo y en el editor, escribir el contenido del fichero y pulsar el botón Save.

Al pulsar el botón Save, se iniciará el proceso de descarga del paquete NuGet indicado en project.json.
(Es recomendable mirar el log por si se hubiera producido algún error a la hora de restaurar los paquetes NuGet).

Si refrescamos nuestra Azure Function y accedemos a la lista de ficheros de la misma, encontraremos también un fichero de nombre project.lock.json.
Este fichero es un fichero que se usa para comprobar si se ha restaurado los paquetes NuGet recientemente o si hay cambios, etc.
Mi recomendación es que no toques este fichero ni lo subas al repositorio de código.

A continuación, haremos clic sobre el fichero run.csx y modificaremos el código de la siguiente forma:

Añadiremos un using para usar este paquete:

using ISO3166;

Para usar esta librería (a modo de ejemplo), he preparado esta pequeña porción de código:

var countries = String.Empty;
foreach(var item in Country.List)
{
countries += $”{item.Name} “;
}

En definitiva, el código completo de nuestra Azure Function usando un paquete NuGet externo, es el que se indica a continuación:

using ISO3166;
using System;
using System.Collections.Generic;
using System.Net;
using System.Text;

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log)
{
    log.Info("C# HTTP trigger function processed a request.");

    // parse query parameter
    string name = req.GetQueryNameValuePairs()
        .FirstOrDefault(q => string.Compare(q.Key, "name", true) == 0)
        .Value;

    // Get request body
    dynamic data = await req.Content.ReadAsAsync<object>();

    // Set name to query string or body data
    name = name ?? data?.name;

    var countries = String.Empty;
    foreach(var item in Country.List)
    {
        countries += $"{item.Name} ";
    }

    return name == null
        ? req.CreateResponse(HttpStatusCode.BadRequest, "Please pass a name on the query string or in the request body")
        : req.CreateResponse(HttpStatusCode.OK, countries);
}

Lógicamente, la llamada es la de siempre en el típico “Hello World” de una Azure Function.

https://geeksazurefunction.azurewebsites.net/api/HttpTriggerCSharp1?code=r8Guva8xaYso59bob26Mn4pX3YdxeptWTmoVyf58ZXri1K81ImJxdA==&name=Jorge

Al ejecutar nuestra Azure Function, ésta funcionará correctamente y usará el paquete externo que queremos utilizar.

Como vemos, es bastante fácil utilizar paquetes NuGet externos en Azure Functions.
Sólo debemos tener cuidado con las versiones soportadas por los paquetes NuGet para que no tengamos ninguna incompatibilidad, así como revisar el log al guardar el fichero project.json para que al restaurar los paquetes, comprobemos que se han restaurado correctamente.

¡Happy Coding!