如何修复Azure函数应用local.settings.json连接字符串及无硬编码配置？

一、修复含特殊字符的SQL连接字符串 #

当密码包含=、%等特殊字符时，直接写入local.settings.json会导致连接字符串解析异常，需对密码部分进行URL编码：

1. 使用Python的urllib.parse.quote_plus工具编码密码：

import urllib.parse
password = "your-password-with-=%"
encoded_password = urllib.parse.quote_plus(password)
print(encoded_password)

2. 将编码后的密码替换到连接字符串中，更新local.settings.json：

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "",
        "FUNCTIONS_WORKER_RUNTIME": "python",
        "SQLConnectionString": "Server=tcp:test.database.windows.net,1433;Database=your-db-name;User Id=testuser;Password=encoded-password-here"
    }
}

注：SQL驱动会自动解码编码后的密码，无需在代码中额外处理

二、SQL触发器避免硬编码配置 #

在function_app.py中，直接通过配置键名引用连接字符串，无需硬编码：

import azure.functions as func
import logging

@app.function_name(name="SqlTriggerExample")
@app.sql_trigger(
    table_name="TargetTable",
    connection_string_setting="SQLConnectionString",  # 直接引用配置项键名
    schema_name="dbo"
)
def sql_trigger(events: func.SqlList[func.SqlRow]):
    for event in events:
        logging.info(f"Detected row change: {event}")
    return func.HttpResponse("Trigger processed events successfully")

三、集成Azure Key Vault实现安全配置传递 #

本地开发环境 #

1. 确保已安装Azure CLI并登录（az login），且拥有Key Vault的访问权限
2. 在local.settings.json中配置Key Vault引用和认证信息：

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "",
        "FUNCTIONS_WORKER_RUNTIME": "python",
        "SQLConnectionString": "@Microsoft.KeyVault(SecretUri=https://your-key-vault-name.vault.azure.net/secrets/sql-connection-string-secret/)",
        "AzureServicesAuthConnectionString": "RunAs=Developer;DeveloperTool=AzureCli"
    }
}

其中SecretUri是Key Vault中存储完整SQL连接字符串（已编码密码）的秘密地址

云端部署环境 #

1. 给函数应用的系统分配身份（或用户分配身份）授予Key Vault的Secret User权限
2. 在函数应用的配置页中添加应用设置：
   • 名称：SQLConnectionString
   • 值：@Microsoft.KeyVault(SecretUri=https://your-key-vault-name.vault.azure.net/secrets/sql-connection-string-secret/)
3. 保存配置后，函数应用会自动从Key Vault拉取秘密值，无需在配置中存储敏感信息

内容的提问来源于stack exchange，提问作者sudip