Share via

Ligação de entrada Dapr Secret para o Azure Functions

  • Artigo

Importante

A Extensão Dapr para Azure Functions está atualmente em pré-visualização e apenas tem suporte em ambientes de Aplicativos de Contêiner do Azure.

A ligação de entrada secreta Dapr permite que você leia dados secretos como entrada durante a execução da função.

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

Exemplo

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

Modelo de execução Description
Modelo de trabalhador isolado Seu código de função é executado em um processo de trabalho .NET separado. Use com versões suportadas do .NET e .NET Framework. Para saber mais, consulte Desenvolver funções de processo de trabalho isoladas do .NET.
Modelo em processo Seu código de função é executado no mesmo processo que o processo de host de funções. Suporta apenas versões LTS (Long Term Support) do .NET. Para saber mais, consulte Desenvolver funções de biblioteca de classes .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 exemplo a seguir cria uma "RetreveSecret" função usando a DaprSecretInput associação com o 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 ligação de entrada secreta do Dapr é emparelhada com um gatilho app de invocação do Dapr, que é registrado pelo 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]}`);
        }
    }
});

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

Aqui está o arquivo function.json para daprServiceInvocationTrigger:

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

Para obter mais informações sobre function.json propriedades do arquivo, 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 ligação de entrada Dapr Secret, que usa o modelo de programação Python v2. Para usar a daprSecret associação ao lado do código do daprServiceInvocationTrigger aplicativo da função 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 o para definir uma ligação de entrada secreta DaprSecret Dapr, que suporta estes parâmetros:

Parâmetro Description
SecretStoreName O nome da loja secreta para obter o segredo.
Chave A chave que identifica o nome do segredo a obter.
Metadados Opcional. Uma matriz de propriedades de metadados no formato "key1=value1&key2=value2".

Anotações

A DaprSecretInput anotação permite que você tenha sua função acessando um segredo.

Elemento Description
secretStoreName O nome da loja secreta Dapr.
key O valor da chave secreta.
metadados Opcional. Os valores de metadados.

Configuração

A tabela a seguir explica as propriedades de configuração de vinculação definidas no código.

Property Description
key O valor da chave secreta.
secretStoreName Nome do armazenamento secreto, 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 vinculação definidas no arquivo function.json.

function.json propriedade Description
key O valor da chave secreta.
secretStoreName Nome do armazenamento secreto, 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 vinculação definidas @dapp.dapr_secret_input no código Python.

Property Description
secret_store_name O nome da loja secreta.
key O valor da chave secreta.
metadados O namespace de metadados.

Consulte a seção Exemplo para obter exemplos completos.

Utilização

Para usar a ligação de entrada secreta do Dapr, comece configurando um componente de armazenamento secreto do Dapr. Você pode saber mais sobre qual componente usar e como configurá-lo na documentação oficial do Dapr.

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

  1. Crie e ative um ambiente virtual.

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

    azure-functions==1.18.0b3

  3. No terminal, instale a biblioteca Python.

    pip install -r .\requirements.txt

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

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Próximos passos

Saiba mais sobre os segredos do Dapr.