Поделиться через

Входная привязка Dapr Secret для Функции Azure

Входная привязка секрета Dapr позволяет считывать данные секретов в качестве входных данных во время выполнения функции.

Сведения о настройке и настройке расширения Dapr см. в обзоре расширения Dapr.

Example

Функцию C# можно создать с помощью одного из следующих режимов C#:

Execution model Description
Изолированная рабочая модель Код функции выполняется в отдельном рабочем процессе .NET. Используйте поддерживаемые версии .NET и платформа .NET Framework. Дополнительные сведения см. в руководстве по запуску функций Azure C# в изолированной рабочей модели.
In-process model Код функции выполняется в том же процессе, что и хост-процесс Функций. Поддерживает только долгосрочные версии .NET. Дополнительные сведения см. в статье Разработка функций библиотеки классов C# с помощью службы "Функции Azure". 
[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.");
}

В следующем примере создается "RetrieveSecret" функция с помощью привязки DaprSecretInput с 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)

В следующем примере входная привязка секрета Dapr связана с триггером вызова Dapr, зарегистрированным 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]}`);
        }
    }
});

The following examples show Dapr triggers in a function.json file and PowerShell code that uses those bindings.

Here's the function.json file for daprServiceInvocationTrigger:

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

For more information about function.json file properties, see the Configuration section.

In code:

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"

В следующем примере показана входная привязка Dapr Secret, которая использует модель программирования Python версии 2. Чтобы использовать привязку daprSecret вместе с daprServiceInvocationTrigger кодом приложения-функции 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])

Attributes

In the in-process model, use the DaprSecret to define a Dapr secret input binding, which supports these parameters:

Parameter Description
SecretStoreName Имя хранилища секретов для получения секрета.
Key Ключ, определяющий имя секрета для получения.
Metadata Optional. Массив свойств метаданных в форме "key1=value1&key2=value2".

Annotations

Заметка DaprSecretInput позволяет получить доступ к секрету функции.

Element Description
secretStoreName Имя хранилища секретов Dapr.
key Значение секретного ключа.
metadata Optional. Значения метаданных.

Configuration

В следующей таблице описываются свойства конфигурации привязки, заданные в коде.

Property Description
key Значение секретного ключа.
secretStoreName Name of the secret store as defined in the local-secret-store.yaml component file.
metadata Пространство имен метаданных.

В следующей таблице описываются свойства конфигурации привязки, которые задаются в файле function.json.

function.json property Description
key Значение секретного ключа.
secretStoreName Name of the secret store as defined in the local-secret-store.yaml component file.
metadata Пространство имен метаданных.

В следующей таблице описываются свойства конфигурации привязки, заданные @dapp.dapr_secret_input в коде Python.

Property Description
secret_store_name Имя хранилища секретов.
key Значение секретного ключа.
metadata Пространство имен метаданных.

See the Example section for complete examples.

Usage

Чтобы использовать входную привязку секрета Dapr, начните с настройки компонента хранилища секретов Dapr. Дополнительные сведения о том, какой компонент следует использовать и как настроить его в официальной документации dapr.

To use the daprSecret in Python v2, set up your project with the correct dependencies.

  1. Создание и активация виртуальной среды.

  2. requirements.text В файле добавьте следующую строку:

    azure-functions==1.18.0b3

  3. В терминале установите библиотеку Python.

    pip install -r .\requirements.txt

  4. Измените local.setting.json файл со следующей конфигурацией:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Next steps

Узнайте больше о секретах Dapr.