Azure Functions 的 Dapr 祕密輸入繫結

Dapr 祕密輸入繫結可讓您在函式執行期間讀取作為輸入的祕密資料。

如需 Dapr 延伸模組的安裝和設定詳細資料，請參閱 Dapr 延伸模組概觀。

範例

您可以使用下列其中一種 C# 模式來建立 C# 函式：

執行模型	描述
隔離式背景工作模型	您的函數程式碼在個別的 .NET 背景工作處理序中執行。 搭配支援的 .NET 和 .NET Framework 版本使用。 若要深入了解，請參閱開發 .NET 隔離式背景工作處理序函數。
同處理序模型	您的函數程式碼執行的處理序與 Functions 主機處理序相同。 僅支援長期支援 (LTS) 的 .NET 版本。 若要深入了解，請參閱開發 .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.");
}

隔離式程序

Dapr 輸入祕密繫結的其他範例可在 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);
    }

}

下列範例會使用 DaprSecretInput 繫結搭配 DaprServiceInvocationTrigger 來建立 "RetrieveSecret" 函式：

@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

在下列範例中，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]}`);
        }
    }
});

Node.js v3

下列範例顯示 function.json 檔案中的 Dapr 觸發程序，以及使用這些繫結的 JavaScript 程式碼。

以下是 daprServiceInvocationTrigger 的 function.json 檔案：

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

如需 function.json 檔案屬性的詳細資訊，請參閱設定一節。

以下是 JavaScript 程式碼：

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

下列範例顯示 function.json 檔案中的 Dapr 觸發程序，以及使用這些繫結的 PowerShell 程式碼。

以下是 daprServiceInvocationTrigger 的 function.json 檔案：

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

如需 function.json 檔案屬性的詳細資訊，請參閱設定一節。

程式碼：

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

下列範例示範使用 v2 Python 程式設計模型的 Dapr 祕密輸入繫結。 若要在 Python 函式應用程式程式碼中搭配 daprServiceInvocationTrigger 使用 daprSecret 繫結：

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

下列範例示範使用 v1 Python 程式設計模型的 Dapr 祕密輸入繫結。

以下是 daprSecret 的 function.json 檔案：

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

如需 function.json 檔案屬性的詳細資訊，請參閱設定一節。

以下是 Python 程式碼：

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

屬性

內含式

在內含式模型中，使用 DaprSecret 來定義 Dapr 祕密輸入繫結，其支援下列參數：

參數	描述
SecretStoreName	用來取得祕密的祕密存放區名稱。
索引鍵	用來識別要取得之祕密名稱的金鑰。
中繼資料	選擇性。 格式為 "key1=value1&key2=value2" 的中繼資料屬性陣列。

隔離式程序

在隔離的背景工作模型中，使用 DaprSecretInput 來定義 Dapr 祕密輸入繫結，支援下列參數：

參數	描述
SecretStoreName	用來取得祕密的祕密存放區名稱。
索引鍵	用來識別要取得之祕密名稱的金鑰。
中繼資料	選擇性。 格式為 "key1=value1&key2=value2" 的中繼資料屬性陣列。

註釋

DaprSecretInput 註釋可讓您允許函式存取祕密。

元素	描述
secretStoreName	Dapr 祕密存放區的名稱。
key	祕密金鑰值。
中繼資料	選擇性。 中繼資料值。

組態

Node.js v4

下表說明您在程式碼中設定的繫結設定屬性。

屬性	說明
key	祕密金鑰值。
secretStoreName	在 local-secret-store.yaml 元件檔案中定義的祕密存放區名稱。
中繼資料	中繼資料命名空間。

Node.js v3

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性	描述
key	祕密金鑰值。
secretStoreName	在 local-secret-store.yaml 元件檔案中定義的祕密存放區名稱。
中繼資料	中繼資料命名空間。

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性	描述
key	祕密金鑰值。
secretStoreName	在 local-secret-store.yaml 元件檔案中定義的祕密存放區名稱。
中繼資料	中繼資料命名空間。

Python v2

下表說明您在 Python 程式碼中設定的 @dapp.dapr_secret_input 繫結組態屬性。

屬性	說明
secret_store_name	祕密存放區的名稱。
key	祕密金鑰值。
中繼資料	中繼資料命名空間。

Python v1

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性	描述
key	祕密金鑰值。
secretStoreName	在 local-secret-store.yaml 元件檔案中定義的祕密存放區名稱。
中繼資料	中繼資料命名空間。

如需完整範例，請參閱範例一節。

使用方式

若要使用 Dapr 祕密輸入繫結，請先設定 Dapr 祕密存放區元件。 您可以在官方 Dapr 文件中深入了解要使用哪個元件，以及如何進行設定。

• Dapr 祕密存放區元件規格
• 操作說明：擷取祕密

Python v2

若要在 Python v2 中使用 daprSecret，請設定您的專案使其具備正確的相依性。

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
   

Python v1

除了設定祕密存放區之外，Python v1 模型不需要任何其他變更。

下一步

深入了解 Dapr 祕密。(英文)