Dapr Secret bemeneti kötés az Azure Functionshez

Fontos

Az Azure Functions Dapr-bővítménye jelenleg előzetes verzióban érhető el, és csak az Azure Container Apps-környezetekben támogatott.

A Dapr titkos bemeneti kötése lehetővé teszi a titkos kulcsok adatainak beolvasását bemenetként a függvény végrehajtása során.

A Dapr-bővítmény beállítási és konfigurációs részleteiről a Dapr bővítmény áttekintésében olvashat.

Példa

A C#-függvények a következő C#-módok egyikével hozhatók létre:

Végrehajtási modell	Leírás
Izolált feldolgozói modell	A függvénykód egy külön .NET-feldolgozófolyamatban fut. A .NET és a .NET-keretrendszer támogatott verzióival használható. További információ: .NET izolált feldolgozói folyamatfüggvények fejlesztése.
Folyamaton belüli modell	A függvénykód ugyanabban a folyamatban fut, mint a Functions gazdafolyamata. Csak a .NET hosszú távú támogatási (LTS) verzióit támogatja. További információ: .NET-osztálykódtár-függvények fejlesztése.

Folyamatban

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

Izolált folyamat

A Dapr bemeneti titkos kód kötéséhez további minták érhetők el a GitHub-adattárban.

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

}

Az alábbi példa egy függvényt "RetreveSecret" hoz létre a DaprSecretInput következő kötéssel 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

A következő példában a Dapr titkos bemeneti kötés egy Dapr-meghívási eseményindítóval van párosítva, amelyet az app objektum regisztrál:

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

Az alábbi példák a Dapr-eseményindítókat mutatják be egy function.json fájlban és a kötéseket használó JavaScript-kódban.

A következő function.json fájl:daprServiceInvocationTrigger

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

A function.json fájltulajdonságokról a Konfiguráció szakaszban talál további információt.

A JavaScript-kód a következő:

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

Az alábbi példák a Dapr-eseményindítókat mutatják be egy function.json fájlban és a PowerShell-kódban, amely ezeket a kötéseket használja.

A következő function.json fájl:daprServiceInvocationTrigger

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

A function.json fájltulajdonságokról a Konfiguráció szakaszban talál további információt.

Kódban:

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

Az alábbi példa egy Dapr Secret bemeneti kötést mutat be, amely a v2 Python programozási modellt használja. A kötés és a daprServiceInvocationTrigger Python-függvényalkalmazás kódjának használatadaprSecret:

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

Az alábbi példa egy Dapr Secret bemeneti kötést mutat be, amely az 1. verziós Python programozási modellt használja.

A következő function.json fájl:daprSecret

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

A function.json fájltulajdonságokról a Konfiguráció szakaszban talál további információt.

A Python-kód a következő:

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

Attribútumok

Folyamatban

A folyamatban lévő modellben a dapr titkos bemeneti kötés definiálásához használja a DaprSecret következő paramétereket:

Paraméter	Leírás
SecretStoreName	A titkos tár neve a titkos kulcs lekéréséhez.
Kulcs	A lekérni kívánt titkos kód nevét azonosító kulcs.
Metaadatok	Opcionális. Metaadat-tulajdonságok tömbje az űrlapon "key1=value1&key2=value2".

Izolált folyamat

Az izolált feldolgozói modellben a dapr titkos bemeneti kötés definiálásához használja a DaprSecretInput következő paramétereket:

Paraméter	Leírás
SecretStoreName	A titkos tár neve a titkos kulcs lekéréséhez.
Kulcs	A lekérni kívánt titkos kód nevét azonosító kulcs.
Metaadatok	Opcionális. Metaadat-tulajdonságok tömbje az űrlapon "key1=value1&key2=value2".

Jegyzetek

A DaprSecretInput széljegyzet lehetővé teszi, hogy a függvény hozzáférjen egy titkos kódhoz.

Elem	Leírás
secretStoreName	A Dapr titkos üzlet neve.
key	A titkos kulcs értéke.
metaadatok	Választható. A metaadatok értékei.

Konfiguráció

Node.js v4

Az alábbi táblázat a kódban beállított kötéskonfigurációs tulajdonságokat ismerteti.

Tulajdonság	Leírás
key	A titkos kulcs értéke.
secretStoreName	A local-secret-store.yaml összetevőfájlban definiált titkos tár neve.
metaadatok	A metaadat-névtér.

Node.js v3

Az alábbi táblázat a function.json fájlban beállított kötéskonfigurációs tulajdonságokat ismerteti.

function.json tulajdonság	Leírás
key	A titkos kulcs értéke.
secretStoreName	A local-secret-store.yaml összetevőfájlban definiált titkos tár neve.
metaadatok	A metaadat-névtér.

Az alábbi táblázat a function.json fájlban beállított kötéskonfigurációs tulajdonságokat ismerteti.

function.json tulajdonság	Leírás
key	A titkos kulcs értéke.
secretStoreName	A local-secret-store.yaml összetevőfájlban definiált titkos tár neve.
metaadatok	A metaadat-névtér.

Python v2

Az alábbi táblázat a Python-kódban beállított kötéskonfigurációs tulajdonságokat @dapp.dapr_secret_input ismerteti.

Tulajdonság	Leírás
secret_store_name	A titkos tár neve.
key	A titkos kulcs értéke.
metaadatok	A metaadat-névtér.

Python v1

Az alábbi táblázat a function.json fájlban beállított kötéskonfigurációs tulajdonságokat ismerteti.

function.json tulajdonság	Leírás
key	A titkos kulcs értéke.
secretStoreName	A local-secret-store.yaml összetevőfájlban definiált titkos tár neve.
metaadatok	A metaadat-névtér.

A teljes példákért tekintse meg a Példa szakaszt .

Használat

A Dapr titkos kód bemeneti kötésének használatához először állítson be egy Dapr titkos tár összetevőt. A hivatalos Dapr-dokumentációban többet is megtudhat arról, hogy melyik összetevőt használja, és hogyan állíthatja be.

• A Dapr titkos tár összetevőjének specifikációi
• Útmutató: Titkos kód lekérése

Python v2

A Python v2-ben való daprSecret használatához állítsa be a projektet a megfelelő függőségekkel.

1. Virtuális környezet létrehozása és aktiválása.

2. requirements.text A fájlban adja hozzá a következő sort:

   azure-functions==1.18.0b3
   

3. Telepítse a Python-kódtárat a terminálban.

   pip install -r .\requirements.txt
   

4. Módosítsa a local.setting.json fájlt a következő konfigurációval:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

A Python v1 modell nem igényel további módosításokat a titkos tár beállításán kívül.

Következő lépések

További információ a Dapr titkos kulcsairól.