Associação de entrada do Segredo do Dapr para o Azure Functions

  • Artigo

A associação de entrada do segredo do Dapr permite que você leia dados de segredos como entrada durante a execução da função.

Para obter mais informações sobre detalhes de instalação e configuração da extensão Dapr, consulte a Visão geral da extensão Dapr.

Exemplo

A função C# pode ser criada usando um dos seguintes modos C#:

Modelo de execução Descrição
Modelo de trabalho isolado O código de função é executado em um processo de trabalho do .NET separado. Use com versões com suporte do .NET e do .NET Framework. Para saber mais, confira Desenvolver funções de processo de trabalho isolado no .NET.
Modelo em processo Seu código de função é executado no mesmo processo que o processo de host do Functions. Dá suporte apenas a versões LTS (suporte de longo prazo) do .NET. Para saber mais, confira Desenvolver funções de biblioteca de classes do .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.");
}

O seguinte exemplo cria uma função "RetreveSecret" usando a associação DaprSecretInput com 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)

No exemplo a seguir, a associação de entrada secreta do Dapr é emparelhada com um gatilho de invocação do Dapr, que é registrado pelo objeto app:

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]}`);
        }
    }
});

Os exemplos a seguir mostram gatilhos do Dapr em um arquivo function.json e o código do PowerShell que usa essas associações.

Aqui está o arquivo function.json para o daprServiceInvocationTrigger:

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

Para obter mais informações sobre as propriedades do arquivo function.json, consulte a seção Configuração.

No 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"

O exemplo a seguir mostra uma associação de entrada do Segredo do Dapr, que usa o modelo de programação do Python v2. Para usar a associação daprSecret junto com daprServiceInvocationTrigger no código do aplicativo de funções do 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

No modelo em processo, use DaprSecret para definir uma associação de entrada do segredo do Dapr, que dá suporte a esses parâmetros:

Parâmetro Descrição
SecretStoreName O nome do repositório de segredo para obter o segredo.
Chave A chave que identifica o nome do segredo a ser obtido.
Metadados Opcional. Uma matriz de propriedades dos metadados na forma "key1=value1&key2=value2".

Anotações

A anotação DaprSecretInput permite que sua função acesse um segredo.

Elemento Descrição
secretStoreName O nome do repositório de segredo do Dapr.
chave O valor da chave secreta.
metadados Opcional. Os valores de metadados.

Configuração

A tabela a seguir explica as propriedades de configuração de associação que você definiu no código.

Propriedade Descrição
chave O valor da chave secreta.
secretStoreName Nome do repositório de segredo conforme definido no arquivo de componente local-secret-store.yaml.
metadados O namespace de metadados.

A tabela a seguir explica as propriedades de configuração de associação que você define no arquivo function.json.

Propriedade function.json Descrição
chave O valor da chave secreta.
secretStoreName Nome do repositório de segredo conforme definido no arquivo de componente local-secret-store.yaml.
metadados O namespace de metadados.

A tabela a seguir explica as propriedades de configuração de associação para @dapp.dapr_secret_input definidas no código do Python.

Propriedade Descrição
secret_store_name O nome do repositório de segredo.
chave O valor da chave secreta.
metadados O namespace de metadados.

Consulte a Seção de exemplo para obter exemplos completos.

Uso

Para usar a associação de entrada do segredo do Dapr, comece configurando um componente de repositório do segredo do Dapr. Saiba mais sobre qual componente usar e como configurá-lo na documentação oficial do Dapr.

Para usar daprSecret no Python v2, configure seu projeto com as dependências corretas.

  1. Criar e ativar um ambiente virtual.

  2. No arquivo requirements.text, adicione a seguinte linha:

    azure-functions==1.18.0b3

  3. No terminal, instale a biblioteca do Python.

    pip install -r .\requirements.txt

  4. Modifique seu arquivo local.setting.json com a seguinte configuração:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Próximas etapas

Saiba mais sobre segredos do Dapr.