Vstupní vazba dapr Secret pro Azure Functions

Vstupní vazba tajného kódu Dapr umožňuje číst data tajných kódů jako vstup během provádění funkce.

Informace o nastavení a konfiguraci rozšíření Dapr najdete v přehledu rozšíření Dapr.

Příklad

Funkci jazyka C# je možné vytvořit pomocí jednoho z následujících režimů jazyka C#:

Model spouštění	Popis
Izolovaný model pracovního procesu	Kód funkce se spouští v samostatném pracovním procesu .NET. Používá se s podporovanými verzemi rozhraní .NET a .NET Framework. Další informace najdete v tématu Vývoj funkcí izolovaného pracovního procesu .NET.
Model v procesu	Kód funkce se spouští ve stejném procesu jako hostitelský proces služby Functions. Podporuje pouze verze dlouhodobé podpory (LTS) rozhraní .NET. Další informace najdete v tématu Vývoj funkcí knihovny tříd .NET.

Probíhá proces

[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.");
}

Izolovaný proces

Další ukázky vstupní tajné vazby Dapr jsou k dispozici v úložišti GitHub.

[Function("RetrieveSecret")]
public static void Run(
    [DaprServiceInvocationTrigger] object args,
    [DaprSecretInput("kubernetes", "my-secret", Metadata = "metadata.namespace=default")] IDictionary<string, string> secret, 
    FunctionContext functionContext)
{
    var log = functionContext.GetLogger("RetrieveSecret");
    log.LogInformation("C# function processed a RetrieveSecret request from the Dapr Runtime.");

    // print the fetched secret value
    // this is only for demo purpose
    // please do not log any real secret in your production code        
    foreach (var kvp in secret)
    {
        log.LogInformation("Stored secret: Key = {0}, Value = {1}", kvp.Key, kvp.Value);
    }

}

Následující příklad vytvoří "RetreveSecret" funkci pomocí vazby DaprSecretInput s 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)

Node.js v4

V následujícím příkladu je vstupní vazba tajného kódu Dapr spárována s triggerem volání Dapr, který je registrován objektem 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]}`);
        }
    }
});

Node.js v3

Následující příklady ukazují triggery Dapr v souboru function.json a javascriptovém kódu, který tyto vazby používá.

Tady je soubor function.json pro daprServiceInvocationTrigger:

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

Další informace o function.json vlastnosti souboru naleznete v části Konfigurace .

Tady je javascriptový kód:

module.exports = async function (context) {
    context.log("Node function processed a RetrieveSecret request from the Dapr Runtime.");

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

Následující příklady ukazují triggery Dapr v souboru function.json a kódu PowerShellu, který tyto vazby používá.

Tady je soubor function.json pro daprServiceInvocationTrigger:

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

Další informace o function.json vlastnosti souboru naleznete v části Konfigurace .

V kódu:

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"

Python v2

Následující příklad ukazuje vstupní vazbu Dapr Secret, která používá programovací model Pythonu v2. daprSecret Použití vazby vedle kódu aplikace funkcí PythonudaprServiceInvocationTrigger:

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])

Python v1

Následující příklad ukazuje vstupní vazbu Dapr Secret, která používá programovací model Pythonu v1.

Tady je soubor function.json pro daprSecret:

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

Další informace o function.json vlastnosti souboru naleznete v části Konfigurace .

Tady je kód Pythonu:

import logging
import json
import azure.functions as func

def main (payload, secret) -> None:
    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])

Atributy

Probíhá proces

V modelu v procesu použijte DaprSecret k definování tajné vstupní vazby Dapr, která podporuje tyto parametry:

Parametr	Popis
SecretStoreName	Název úložiště tajných kódů pro získání tajného kódu.
Klíč	Klíč identifikující název tajného kódu, který se má získat.
Metadata	Nepovinné. Pole vlastností metadat ve formuláři "key1=value1&key2=value2".

Izolovaný proces

V izolovaném modelu pracovního procesu použijte DaprSecretInput k definování tajné vstupní vazby Dapr, která podporuje tyto parametry:

Parametr	Popis
SecretStoreName	Název úložiště tajných kódů pro získání tajného kódu.
Klíč	Klíč identifikující název tajného kódu, který se má získat.
Metadata	Nepovinné. Pole vlastností metadat ve formuláři "key1=value1&key2=value2".

Poznámky

Poznámka DaprSecretInput umožňuje, aby vaše funkce měla přístup k tajnému kódu.

Element (Prvek)	Popis
secretStoreName	Název úložiště tajných kódů Dapr.
key	Hodnota tajného klíče.
metadata	Volitelné. Hodnoty metadat.

Konfigurace

Node.js v4

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v kódu.

Vlastnost	Popis
key	Hodnota tajného klíče.
secretStoreName	Název úložiště tajných kódů definovaných v souboru komponenty local-secret-store.yaml .
metadata	Obor názvů metadat.

Node.js v3

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json.

vlastnost function.json	Popis
key	Hodnota tajného klíče.
secretStoreName	Název úložiště tajných kódů definovaných v souboru komponenty local-secret-store.yaml .
metadata	Obor názvů metadat.

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json.

vlastnost function.json	Popis
key	Hodnota tajného klíče.
secretStoreName	Název úložiště tajných kódů definovaných v souboru komponenty local-secret-store.yaml .
metadata	Obor názvů metadat.

Python v2

Následující tabulka vysvětluje vlastnosti konfigurace vazby, @dapp.dapr_secret_input které jste nastavili v kódu Pythonu.

Vlastnost	Popis
secret_store_name	Název úložiště tajných kódů.
key	Hodnota tajného klíče.
metadata	Obor názvů metadat.

Python v1

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json.

vlastnost function.json	Popis
key	Hodnota tajného klíče.
secretStoreName	Název úložiště tajných kódů definovaných v souboru komponenty local-secret-store.yaml .
metadata	Obor názvů metadat.

Kompletní příklady najdete v části Příklad.

Využití

Pokud chcete použít vstupní vazbu tajného klíče Dapr, začněte nastavením komponenty úložiště tajných kódů Dapr. Další informace o tom, kterou komponentu použít a jak ji nastavit, najdete v oficiální dokumentaci k Dapr.

• Specifikace komponent úložiště tajných kódů Dapr
• Postupy: Načtení tajného kódu

Python v2

Pokud chcete použít python daprSecret v2, nastavte projekt se správnými závislostmi.

1. Vytvoření a aktivace virtuálního prostředí

2. requirements.text Do souboru přidejte následující řádek:

   azure-functions==1.18.0b3
   

3. V terminálu nainstalujte knihovnu Pythonu.

   pip install -r .\requirements.txt
   

4. Upravte local.setting.json soubor pomocí následující konfigurace:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

Model Pythonu v1 nevyžaduje žádné další změny kromě nastavení úložiště tajných kódů.

Další kroky

Přečtěte si další informace o tajných kódech Dapr.