如何在 azure 函数中读取 C# startup.cs class 中的 azure app 配置值

Question

我在 Azure 应用程序配置中添加了键值对，并尝试在 Startup.cs class 文件中读取它。请建议如何做到这一点。

public class Startup : FunctionsStartup
{
    private static readonly string url= "*******************";
   
    public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
    {
        string connectionString=????? //How to get this value from Azure app config
        builder.Services.AddDbContext<DbContext, Context>(
            options => SqlServerDbContextOptionsExtensions.UseSqlServer(options, connectionString));
       builder.ConfigurationBuilder.AddAzureAppConfiguration(url);
    }
}

Answer 1

ConfigureAppConfiguration 方法应该专门用于配置应用程序的 IConfiguration 对象。还有另一种专用方法 Configure 应该用于配置应用程序本身（例如依赖注入）。

这是一个简单的例子：

public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
{
    FunctionsHostBuilderContext context = builder.GetContext();

    builder.ConfigurationBuilder
        .SetBasePath(context.ApplicationRootPath)
        .AddJsonFile("appsettings.json")
        .AddEnvironmentVariables();
}

public override void Configure(IFunctionsHostBuilder builder)
{
    IConfiguration configuration = builder.Services.BuildServiceProvider().GetRequiredService<IConfiguration>();

    // use configuration object 
}

如果由于某种原因这对您不起作用，您可以随时回退以从环境变量中获取值，因为设置已添加到 Environment

Environment.GetEnvironmentVariable("DatabaseConnectionString"))

Answer 2

您需要从应用程序服务的注册中分离出您的配置配置。换句话说，Azure 应用程序配置的设置应该在 ConfigureAppConfiguration 中完成，而 DbContext 的注册应该在 Configure 方法中完成。这将允许您在 Configure 方法中访问 FunctionsHostBuilderContext 的 Configuration 属性以检索您的连接字符串：

public class Startup : FunctionsStartup
{
    private static readonly string url= "*******************";
   
    public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
    {
        // register AzureAppConfiguration only
        builder.ConfigurationBuilder.AddAzureAppConfiguration(url);
    }

    public override void Configure(IFunctionsHostBuilder builder)
    {
        var context = build.GetContext();
        var config = context.Configuration;

        string connectionString = config["AzureAppConfigKeyName"];
        builder.Services.AddDbContext<DbContext, Context>(
            options => SqlServerDbContextOptionsExtensions.UseSqlServer(options, connectionString)
        );
    }
}

您传递给 config 对象的索引器的值将取决于您在 Azure 应用程序配置中为密钥命名的内容。假设您将其称为“DatabaseConnectionString”，那么这正是您要传递的内容，即：config["DatabaseConnectionString"].

前缀

Azure App Configuration 有一些功能可以控制应用程序处理键名的方式，特别是“Trim Prefixes”的能力。您在这里没有使用它（因为您只是传递 URL），但假设您在 Azure 应用程序配置中有密钥，例如 MyFunction:DatabaseConnectionString。默认情况下，您将使用它的全名访问它：

var cs1 = config["MyFunction:DatabaseConnectionString"];
// or
var cs2 = config.GetSection("MyFunction")["DatabaseConnectionString"];

但是您可以指定 long-form 连接选项。这将允许您仅 select 以该前缀开头的键，并可选择 trim 关闭它们：

builder.ConfigurationBuilder.AddAzureAppConfiguration(s => 
{
    s.Connect(url, new DefaultAzureCredential());
    s.Select("MyFunction:*");
    s.TrimKeyPrefix("MyFunction:");
});

这将使您的连接字符串可用更短的密钥：

string connectionString = config["DatabaseConnectionString"];

如果您的 Azure 应用程序配置实例中有很多不同的设置并且只想提取与您的应用程序特别相关的设置（标签也可用于此目的），则此功能特别有用。

Azure App Config 连接 - 环境变量

最后提个建议。不要在应用程序中存储 url 或 Azure 应用程序配置实例 hard-coded 的连接详细信息。为此使用环境变量。 Azure App 中的“应用程序设置”Service/Azure 函数会作为环境变量自动添加到您的应用程序中。

在 ConfigureAppConfiguration 之前运行，一组默认配置源已经添加到 context/builder。这些包括 host.json、appsettings.json、local.settings.json（当在本地运行ning 时）和环境变量。将 link 配置为 Azure 应用程序配置的“更好”方法是使用此机制。

例如，您可以添加名为 AzureAppConfigUrl 的 FunctionApp 应用程序设置，其中包含此值：

在本地 您需要在 local.settings.json 文件中添加相应的条目：

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "AzureAppConfigUrl": "https://your-configuration.azconfig.io"
  }
}

然后您将在配置 Azure 应用程序配置时引用此值。在本地，它将从 JSON 文件中提取，当在 Azure 中运行ning 时，它将从应用程序设置（或者更确切地说，环境变量）中读取：

public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
{
   var context = build.GetContext();
   var url = context.Configuration["AzureAppConfigUrl"];
   builder.ConfigurationBuilder.AddAzureAppConfiguration(url);
}

Answer 3

下面的文档将带您了解如何在 Azure Functions 中使用 Azure App Configuration https://docs.microsoft.com/azure/azure-app-configuration/quickstart-azure-functions-csharp

如何在 azure 函数中读取 C# startup.cs class 中的 azure app 配置值

how to read azure app config values in C# startup.cs class in azure function

c#

azure-functions

azure-app-configuration

前缀

Azure App Config 连接 - 环境变量