Enlace de entrada secreto de Dapr para Azure Functions

  • Artículo

Importante

La extensión Dapr para Azure Functions se encuentra actualmente en versión preliminar y solo se admite en entornos de Azure Container Apps.

El enlace de entrada del secreto Dapr permite leer los datos de secretos como entrada durante la ejecución de la función.

Para obtener información sobre la configuración y los detalles de configuración de la extensión Dapr, consulte la introducción a la extensión Dapr.

Ejemplo

Se puede crear una función C# usando uno de los siguientes modos de C#:

Modelo de ejecución Descripción
Modelo de trabajo aislado El código de función se ejecuta en un proceso de trabajo de .NET independiente. Se usa con versiones compatibles de .NET y .NET Framework. Para obtener más información, consulte Desarrollo de funciones de procesos de trabajo aislados en .NET.
Modelo de proceso El código de función se ejecuta en el mismo proceso que el proceso de host de Functions. Solo admite versiones de .NET de compatibilidad a largo plazo (LTS). Para obtener más información, consulte Desarrollo de funciones de la biblioteca de clases de .NET. 
[FunctionName("RetrieveSecret")]
public static void Run(
    [DaprServiceInvocationTrigger] object args,
    [DaprSecret("kubernetes", "my-secret", Metadata = "metadata.namespace=default")] IDictionary<string, string> secret,
    ILogger log)
{
    log.LogInformation("C# function processed a RetrieveSecret request from the Dapr Runtime.");
}

En el ejemplo siguiente se crea una "RetreveSecret" función mediante el DaprSecretInput con el enlace DaprServiceInvocationTrigger:

@FunctionName("RetrieveSecret")
public void run(
    @DaprServiceInvocationTrigger(
        methodName = "RetrieveSecret") Object args,
    @DaprSecretInput(
        secretStoreName = "kubernetes", 
        key = "my-secret", 
        metadata = "metadata.namespace=default") 
        Map<String, String> secret,
    final ExecutionContext context)

En el ejemplo siguiente, el enlace de entrada del secreto dapr se empareja con un desencadenador de invocación de Dapr, que está registrado por el app objeto :

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

app.generic('RetrieveSecret', {
    trigger: trigger.generic({
        type: 'daprServiceInvocationTrigger',
        name: "payload"
    }),
    extraInputs: [daprSecretInput],
    handler: async (request, context) => {
        context.log("Node function processed a RetrieveSecret request from the Dapr Runtime.");
        const daprSecretInputValue = context.extraInputs.get(daprSecretInput);

        // print the fetched secret value
        for (var key in daprSecretInputValue) {
            context.log(`Stored secret: Key=${key}, Value=${daprSecretInputValue[key]}`);
        }
    }
});

En los ejemplos siguientes, se muestran desencadenadores de Dapr en un archivo function.json y código de PowerShell que usa esos enlaces.

Este es el archivo function.json para daprServiceInvocationTrigger:

{
  "bindings": 
    {
      "type": "daprSecret",
      "direction": "in",
      "name": "secret",
      "key": "my-secret",
      "secretStoreName": "localsecretstore",
      "metadata": "metadata.namespace=default"
    }
}

Para obtener más información sobre las propiedades del archivo function.json, consulte la sección de Configuración.

Mediante código:

using namespace System
using namespace Microsoft.Azure.WebJobs
using namespace Microsoft.Extensions.Logging
using namespace Microsoft.Azure.WebJobs.Extensions.Dapr
using namespace Newtonsoft.Json.Linq

param (
    $payload, $secret
)

# PowerShell function processed a CreateNewOrder request from the Dapr Runtime.
Write-Host "PowerShell function processed a RetrieveSecretLocal request from the Dapr Runtime."

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $secret | ConvertTo-Json

Write-Host "$jsonString"

En el ejemplo siguiente se muestra un enlace de entrada secreto de Dapr, que usa el modelo de programación de Python v2. Para usar el enlacedaprSecret junto con daprServiceInvocationTrigger en el código de la aplicación de la función Python:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="RetrieveSecret")
@app.dapr_service_invocation_trigger(arg_name="payload", method_name="RetrieveSecret")
@app.dapr_secret_input(arg_name="secret", secret_store_name="localsecretstore", key="my-secret", metadata="metadata.namespace=default")
def main(payload, secret: str) :
    # Function should be invoked with this command: dapr invoke --app-id functionapp --method RetrieveSecret  --data '{}'
    logging.info('Python function processed a RetrieveSecret request from the Dapr Runtime.')
    secret_dict = json.loads(secret)

    for key in secret_dict:
        logging.info("Stored secret: Key = " + key +
                     ', Value = ' + secret_dict[key])

Atributos

En el modelo en proceso, use DaprSecret para definir un enlace de entrada secreto de Dapr, que admite estos parámetros:

Parámetro Descripción
SecretStoreName Nombre del almacén de secretos para obtener el secreto.
Clave Clave que identifica el nombre del secreto que se va a obtener.
Metadata Opcional. Matriz de propiedades de metadatos con el formulario "key1=value1&key2=value2".

anotaciones

La DaprSecretInput anotación permite que la función tenga acceso a un secreto.

Elemento Descripción
secretStoreName El nombre del almacén secreto Dapr.
key Valor de clave secreta.
metadata Opcional. Valores de metadatos.

Configuración

En la tabla siguiente se explican las propiedades de configuración de enlace establecidas en el código.

Propiedad Descripción
key Valor de clave secreta.
secretStoreName Nombre del almacén secreto definido en el archivo de componentes local-secret-store.yaml.
metadata Espacio de nombres de metadatos.

En la siguiente tabla se explican las propiedades de configuración de enlace que se establecen en el archivo function.json.

Propiedad de function.json Descripción
key Valor de clave secreta.
secretStoreName Nombre del almacén secreto definido en el archivo de componentes local-secret-store.yaml.
metadata Espacio de nombres de metadatos.

En la tabla siguiente, se explican las propiedades de configuración de enlace para @dapp.dapr_secret_input que estableció en el código de Python.

Propiedad Descripción
secret_store_name El nombre del almacén secreto.
key Valor de clave secreta.
metadata Espacio de nombres de metadatos.

Consulte la sección de ejemplos para ver ejemplos completos.

Uso

Para usar el enlace de entrada del secreto de Dapr, empiece por configurar un componente de almacén de secretos de Dapr. Puede obtener más información sobre qué componente usar y cómo configurarlo en la documentación oficial de Dapr.

Para usar daprSecret enPython v2, configure el proyecto con las dependencias correctas.

  1. Creación y activación de un entorno virtual.

  2. En el archivo requirements.text, agregue la línea siguiente:

    azure-functions==1.18.0b3

  3. En el terminal, instale la biblioteca de Python.

    pip install -r .\requirements.txt

  4. Modifique el archivo local.setting.json con la siguiente configuración:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Pasos siguientes

Obtenga más información acerca de los secretos de Dapr.