Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration 3.0.0

前缀预留
dotnet add package Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration --version 3.0.0                
NuGet\Install-Package Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration -Version 3.0.0                
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" Version="3.0.0" />                
对于支持 PackageReference 的项目,将此 XML 节点复制到项目文件中引用该包。
paket add Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration --version 3.0.0                
#r "nuget: Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration, 3.0.0"                
#r 指令可用于 F# Interactive 和多语言笔记本。将其复制到交互式工具或脚本的源代码中以引用包。
// Install Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration as a Cake Addin
#addin nuget:?package=Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration&version=3.0.0

// Install Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration as a Cake Tool
#tool nuget:?package=Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration&version=3.0.0                

Azure AppConfiguration 配置构建器

此包提供了一个配置构建器,其值来源于 Azure App Configuration。构建器使用 DefaultAzureCredential 连接到 App Configuration 服务。更全面的文档可以在 MicrosoftConfigBuilders 项目 找到。

该构建器的基本用法如下。方括号[]内的参数是可选的。圆括号()内的参数互斥。以@符号开头的参数允许替换appSettings。参数的第一行对所有构建器都适用且为可选。它们的含义、用法和默认值在此处文档化。为了简洁起见,它们分组在一行上。当构建器使用与项目默认值不同的默认值时,不同的值也会列出。构建器特有的设置随后列出,并附带简要说明。

<add name="AzureAppConfig"
    [@mode|@enabled="enabled"|@charMap|@prefix|@stripPrefix|tokenPattern|@escapeExpandedValues]
    (@endpoint="https://your-appconfig-store.azconfig.io" | @connectionString="Endpoint=https://your-appconfig-store.azconfig.io;Id=XXXXXXXXXX;Secret=XXXXXXXXXX")
    [@keyFilter="string"]
    [@labelFilter="label"]
    [@acceptDateTime="DateTimeOffset"]
    [@useAzureKeyVault="bool"]
    type="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationBuilder, Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" />

:information_source: [注意]

当连接到Azure应用配置存储时,正在使用的标识必须被分配为Azure应用配置数据读取器角色或Azure应用配置数据所有者角色。否则,配置构建器将遇到Azure返回的“403禁止”响应,如果不可选,将抛出异常。

  • endpoint - 此指定要连接到的AppConfiguration存储。
  • connectionString - 建议使用endpoint此指定要连接到的AppConfiguration存储,以及访问服务的Id和Secret。如果您使用此方法进行连接,请小心不要将任何秘密暴露在您的代码、存储库或应用配置存储中。
  • keyFilter - 使用此参数选择一组与特定键模式的配置值。
  • labelFilter - 仅检索与特定标签匹配的配置值。
  • acceptDateTime - 与Azure Key Vault的版本不同,AppConfiguration使用时间戳。使用此属性可以回到过去以检索以前的状态的配置值。
  • useAzureKeyVault - 启用此功能以允许AzureAppConfigurationBuilder连接到Azure Key Vault并检索存储在该密钥保管库中的配置值。连接到AppConfiguration服务时使用的相同托管服务标识将用于连接到密钥保管库。密钥保管库URI作为AppConfiguration数据的一部分检索,因此在此处不需要指定。默认值为false

V3更新

更完整的更新列表在此。其中一些与此构建器最相关。

  • ⚠️ 重大更改 - Expand模式已删除。它已被Token模式替换。
  • 已更新Azure配置构建器,以默认要求更高版本的Azure.Identity,这允许更多地连接到Azure,例如通过用户分配的托管标识或通过环境变量进行的基于客户端证书的连接。还添加了一对重载(GetCredentialGetSecretClientOptions/GetConfigurationClientOptions),以供需要比默认的带有默认客户端选项的DefaultAzureCredential更长远的用户使用。
  • 属性optional已过时 ⇒ 提供更多灵活性的enabled属性。 (当不存在新的enabled属性时,仍然解析并识别属性optional,但构建器应在可能的情况下迁移到使用新的属性名称。安装脚本应尝试自动处理此问题。)
  • AzureAppConfiguration NuGet包版本已经升级,以匹配本套系列构建器的其余部分,而不是落后1个大版本。(即,AzureAppConfiguration:3.0现在依赖于Base:3.0而不是AzureAppConfiguration:1.0依赖于Base:2.0

V1 更新

更多更新列表请参阅此处。这些更新与本构建器相关性最高

  • Azure App Configuration 支持 - 添加了一个新的构建器,用于从新的 Azure App Configuration 服务中提取值。
产品 兼容的以及额外的计算目标框架版本。
.NET Framework net471 是兼容的。 net472 已计算。 net48 已计算。 net481 已计算。
兼容的目标框架
包含的目标框架(在包中)
有关目标框架.NET Standard的更多信息,请了解。

NuGet 包

此包未由任何 NuGet 包使用。

GitHub 仓库

此包未由任何流行 GitHub 仓库使用。

版本 下载 上次更新
3.0.0 150,519 4/12/2023
2.0.0-preview2 264 1/18/2023
2.0.0-preview1 784 4/1/2022
1.0.0 970,939 2/22/2020
1.0.0-rc 10,144 1/10/2020
1.0.0-beta 15,259 2/26/2019