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

@azure/app-configuration package

参考

类

Azure 应用配置服务的客户端。

接口

AddConfigurationSettingOptions	添加 ConfigurationSetting 时使用的选项。
AddConfigurationSettingResponse	添加 ConfigurationSetting 的响应。
AppConfigurationClientOptions	为 AppConfigurationClient 提供配置选项。
ConfigurationSettingId	唯一标识配置设置的字段
ConfigurationSettingsFilter	启用键值筛选。语法参考：https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot	快照详细信息包括名称、筛选器、expiresOn、sizeInBytes、status、itemCount 等
CreateSnapshotOptions	创建快照时使用的选项。
CreateSnapshotResponse	更新快照的响应。
DeleteConfigurationSettingOptions	用于删除 ConfigurationSetting 的选项。
DeleteConfigurationSettingResponse	删除 ConfigurationSetting 的响应。
EtagEntity	具有 etag 的实体。
FeatureFlagValue	功能标志的值
GetConfigurationHeaders	从获取 ConfigurationSetting 的标头。
GetConfigurationSettingOptions	用于获取 ConfigurationSetting 的选项。
GetConfigurationSettingResponse	从检索 ConfigurationSetting 的响应。
GetSnapshotOptions	获取快照时使用的选项。
GetSnapshotResponse	获取快照的响应。
HttpOnlyIfChangedField	用于为 HTTP 请求提供 if-none 匹配的选项
HttpOnlyIfUnchangedField	用于为 HTTP 请求提供 if-match 的选项
HttpResponseField	HTTP 响应相关信息 - 标头和原始正文。
HttpResponseFields	在单个 HTTP 响应字段对于用户在处理 http 状态代码 204 或 304 等常见用例中非常重要的情况下，从对象的_response字段中启动的字段。
ListConfigurationSettingPage	配置设置的页面和相应的 HTTP 响应
ListConfigurationSettingsForSnapshotOptions	AppConfig 中用于指定通配符和接受日期时间标头的“list”样式 API 的常见选项。
ListConfigurationSettingsOptions	允许基于键、标签和其他字段进行筛选的 listConfigurationSettings 的选项。还提供 `fields`，以便有选择地选择结果中填充的字段。
ListLabelsOptions	listLabels 的选项
ListLabelsPage	配置设置的页面和相应的 HTTP 响应
ListRevisionsOptions	允许基于键、标签和其他字段进行筛选的 listRevisions 选项。还提供 `fields`，以便有选择地选择结果中填充的字段。
ListRevisionsPage	配置设置的页面和相应的 HTTP 响应
ListSettingsOptions	AppConfig 中用于指定通配符和接受日期时间标头的“list”样式 API 的常见选项。
ListSnapshots	AppConfig 中用于指定通配符和接受日期时间标头的“list”样式 API 的常见选项。
ListSnapshotsOptions	允许基于键、标签和其他字段进行筛选的 listConfigurationSettings 的选项。还提供 `fields`，以便有选择地选择结果中填充的字段。
ListSnapshotsPage	配置设置的页面和相应的 HTTP 响应
OptionalFields	当 API 支持有选择地返回字段时使用。
OptionalLabelsFields	当 API 支持选择性地返回标签字段时使用。
OptionalSnapshotFields	当 API 支持有选择地返回字段时使用。
PageSettings	跟踪分页迭代设置的接口
RetryOptions	控制如何重试失败请求的选项。
SecretReferenceValue	用于更新或创建新机密引用的必要字段。
SetConfigurationSettingOptions	保存 ConfigurationSetting 时使用的选项。
SetConfigurationSettingResponse	设置 ConfigurationSetting 的响应。
SetReadOnlyOptions	setReadOnly 的选项
SetReadOnlyResponse	将值设置为只读时做出响应。
SettingLabel	标签详细信息，名称属性只能由服务器填充
SnapshotInfo	唯一标识快照的字段
SnapshotResponse	添加快照的响应。
SyncTokenHeaderField	同步令牌标头字段
UpdateSnapshotOptions	更新快照时使用的选项。
UpdateSnapshotResponse	更新快照的响应。

类型别名

AddConfigurationSettingParam	用于添加新配置设置的参数
ConfigurationSetting	具有服务器额外元数据的配置设置，指示其 etag、当前是否为 readOnly 以及上次修改时间。
ConfigurationSettingParam	更新或创建新配置设置的必要字段
ConfigurationSettingResponse	用于获取、删除或更新配置设置的标准基本响应
ConfigurationSnapshotStatus	定义 ConfigurationSnapshotStatus 的值。 KnownConfigurationSnapshotStatus 可与 ConfigurationSnapshotStatus 互换使用，此枚举包含服务支持的已知值。服务支持的已知值预配就绪存档失败
SetConfigurationSettingParam	用于创建新配置设置或更新的参数
SnapshotComposition	定义 SnapshotComposition 的值。 KnownSnapshotComposition 可与 SnapshotComposition 互换使用，此枚举包含服务支持的已知值。服务支持的已知值密钥 key_label

枚举

KnownConfigurationSnapshotStatus	ConfigurationSnapshotStatus 服务的已知值。
KnownSnapshotComposition	服务接受的 SnapshotComposition 的已知值。

函数

isFeatureFlag(ConfigurationSetting<string>)	告知你 ConfigurationSetting 是否为功能标志。 [检查内容类型是否为 featureFlagContentType `"application/vnd.microsoft.appconfig.ff+json;charset=utf-8"`]
isSecretReference(ConfigurationSetting<string>)	告知你 ConfigurationSetting 是否为机密引用。 [检查内容类型是否为 secretReferenceContentType `"application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"`]
parseFeatureFlag(ConfigurationSetting<string>)	将 ConfigurationSetting 作为输入，并通过分析值字符串返回 ConfigurationSetting。
parseSecretReference(ConfigurationSetting<string>)	将 ConfigurationSetting 作为输入，并通过分析值字符串返回 ConfigurationSetting。

函数详细信息

isFeatureFlag(ConfigurationSetting<string>)

告知你 ConfigurationSetting 是否为功能标志。

[检查内容类型是否为 featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

function isFeatureFlag(setting: ConfigurationSetting<string>): setting

参数

setting: ConfigurationSetting<string>

setting

isSecretReference(ConfigurationSetting<string>)

告知你 ConfigurationSetting 是否为机密引用。

[检查内容类型是否为 secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

function isSecretReference(setting: ConfigurationSetting<string>): setting

参数

setting: ConfigurationSetting<string>

setting

parseFeatureFlag(ConfigurationSetting<string>)

将 ConfigurationSetting 作为输入，并通过分析值字符串返回 ConfigurationSetting。

function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>

参数

setting: ConfigurationSetting<string>

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)