你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

Azure机密账本中的服务器端编程

Azure机密账本提供服务器端编程功能,用于在账本中运行自定义逻辑。 通过使用这些功能,可以通过编写在机密环境中运行的自定义代码并与账本的数据交互来扩展账本的功能。

可以创建 用户定义的函数 (UDF)和 用户定义的终结点 (UDE),以使用不同的自定义级别执行各种操作。 UDF 和 UDE 以前分别称为简单的用户定义的函数和高级用户定义函数。 定义 UDF 和 UDE 后,可以从 Azure 机密账本客户端调用它们,以便直接在账本引擎内部运行。

UDF 和 UDE

Azure机密账本提供两种服务器端编程功能:

  • 用户定义的函数(UDF):UDF 是在账本中定义和执行的简单自定义函数。 它们允许你使用JavaScript API执行简单操作,并且可以与现有的账本写入 API 集成。 有关详细信息,请参阅Azure机密账本中的用户定义的函数。

  • 用户定义的终结点(UDE):UDE 是在账本应用程序中定义的和公开的自定义终结点。 使用这些终结点公开具有可自定义参数、数据格式和身份验证机制的更复杂的 API。 有关详细信息,请参阅Azure机密账本中的用户定义的终结点。

下面是 UDF 和 UDE 的主要特性和功能的比较:

能力 UDFs UDEs
运行自定义业务逻辑 是的 是的
自定义运行时参数 是的 是的
公开新的 API / 端点 否 是的
运行单个函数 是的 否
在总账条目写入操作之前/之后运行钩子 是的 否
创建和更新自定义代码 是(精细地更新/删除每个函数) 是(单个应用程序捆绑包更新适用于所有端点)
自定义 JavaScript 运行时选项 是(每执行一次) 是(全球)
在备份节点上执行 否 是的
支持用于输入和输出的多种数据格式 否 是的
自定义身份验证和授权 否 是的
目标方案 执行简单的自定义逻辑并与账本 API 集成 需要自定义 API 并控制高级 JavaScript 参数的高级用例

在 UDF 和 UDE 之间切换

UDF 和 UDE 是相互排斥的功能。 如果定义了 UDE,则无法创建或运行 UDF,反之亦然。 使用以下步骤在两个功能之间切换。

重要

在 UDF 和 UDE 之间切换是一项破坏性操作。 切换到其他功能时,将删除所有现有的 UDF 或 UDE。 在继续操作之前备份任何重要数据。

从 UDF 到 UDE

若要从 UDF 切换到 UDE,请删除所有现有的 UDF:

  1. 使用 API 列出账本中存储的GET /app/userDefinedFunctions。

  2. 使用 API 逐个DELETE /app/userDefinedFunctions/{functionId}。

从 UDEs 到 UDFs

若要从 UDE 切换到 UDF,请使用空模块和终结点定义定义 UDEs。

  1. 使用以下结构创建新的应用程序捆绑包:

    {
        "metadata": {
            "endpoints": {}
        }, 
       "modules": []
    }
    
  2. 使用 API 部署具有步骤 1 中定义的请求主体的PUT /app/userDefinedEndpoints。

后续步骤

若要开始Azure机密账本中的服务器端编程,请参阅以下文章: