通过

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

AppConfigurationClient class

  • 参考
包:
@azure/app-configuration

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

构造函数

AppConfigurationClient(string, AppConfigurationClientOptions)

初始化 AppConfigurationClient 类的新实例。
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

使用 TokenCredential 初始化 AppConfigurationClient 类的新实例。

方法

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)

将设置添加到 Azure 应用配置服务中，如果已存在，则失败。

示例用法：

const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)

存档就绪快照

示例用法：

const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

开始为 Azure 应用配置服务创建快照，如果已存在，则失败。
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

开始为 Azure 应用配置服务创建快照，等待它完成，如果已存在，则失败。
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

从 Azure 应用配置服务中删除设置

示例用法：

const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

从 Azure 应用配置服务获取设置。

示例代码：

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)

从 Azure 应用配置服务获取快照

示例用法：

const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)

列出 Azure 应用配置服务中的设置，可以选择按键名称、标签和接受日期/时间进行筛选。

示例代码：

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

列出 Azure 应用配置服务中基于名称的快照设置，可以选择按键名称、标签和接受日期时间进行筛选。

示例代码：

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)

从 Azure 应用配置服务获取标签列表

示例代码：

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)

列出一组键的修订，可以选择按键名称、标签和接受日期时间进行筛选。

示例代码：

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)

列出 Azure 应用配置服务中的所有快照

示例用法：

const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)

将存档的快照恢复回就绪状态

示例用法：

const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

在 Azure 应用配置服务中设置密钥的值，允许可选的 etag。
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

设置或清除密钥的只读状态。
updateSyncToken(string)

添加外部同步令牌，以确保服务请求接收 up-to日期值。

构造函数详细信息

AppConfigurationClient(string, AppConfigurationClientOptions)

初始化 AppConfigurationClient 类的新实例。

new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)

参数

connectionString

string

客户端连接到 Azure 所需的连接字符串。

options
AppConfigurationClientOptions

AppConfigurationClient 的选项。

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

使用 TokenCredential 初始化 AppConfigurationClient 类的新实例。

new AppConfigurationClient(endpoint: string, tokenCredential: TokenCredential, options?: AppConfigurationClientOptions)

参数

endpoint

string

应用配置服务的终结点（例如：https://sample.azconfig.io）。

tokenCredential
TokenCredential

实现用于对服务的请求进行身份验证的 TokenCredential 接口的对象。 使用 @azure/identity 包创建符合需求的凭据。

options
AppConfigurationClientOptions

AppConfigurationClient 的选项。

方法详细信息

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)

将设置添加到 Azure 应用配置服务中，如果已存在，则失败。

示例用法：

const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });

function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>

参数

configurationSetting

AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>

配置设置。

options
AddConfigurationSettingOptions

请求的可选参数。

返回

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

存档就绪快照

示例用法：

const result = await client.archiveSnapshot({name: "MySnapshot"});

function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

参数

name

string

快照的名称。

options
UpdateSnapshotOptions

请求的可选参数。

返回

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

开始为 Azure 应用配置服务创建快照，如果已存在，则失败。

function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

参数

snapshot
SnapshotInfo
options
CreateSnapshotOptions

返回

Promise<@azure/core-lro.SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

开始为 Azure 应用配置服务创建快照，等待它完成，如果已存在，则失败。

function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>

参数

snapshot
SnapshotInfo
options
CreateSnapshotOptions

返回

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

从 Azure 应用配置服务中删除设置

示例用法：

const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>

参数

id
ConfigurationSettingId

要删除的配置设置的 ID。

options
DeleteConfigurationSettingOptions

请求的可选参数（例如：etag、label）

返回

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

从 Azure 应用配置服务获取设置。

示例代码：

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>

参数

id
ConfigurationSettingId

要获取的配置设置的 ID。

options
GetConfigurationSettingOptions

请求的可选参数。

返回

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

从 Azure 应用配置服务获取快照

示例用法：

const result = await client.getSnapshot("MySnapshot");

function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>

参数

name

string

快照的名称。

options
GetSnapshotOptions

请求的可选参数。

返回

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

列出 Azure 应用配置服务中的设置，可以选择按键名称、标签和接受日期/时间进行筛选。

示例代码：

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });

function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

参数

options
ListConfigurationSettingsOptions

请求的可选参数。

返回

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

列出 Azure 应用配置服务中基于名称的快照设置，可以选择按键名称、标签和接受日期时间进行筛选。

示例代码：

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });

function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

参数

snapshotName

string

options
ListConfigurationSettingsForSnapshotOptions

请求的可选参数。

返回

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

从 Azure 应用配置服务获取标签列表

示例代码：

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });

function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

参数

options
ListLabelsOptions

请求的可选参数。

返回

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

列出一组键的修订，可以选择按键名称、标签和接受日期时间进行筛选。

示例代码：

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });

function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

参数

options
ListRevisionsOptions

请求的可选参数。

返回

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

列出 Azure 应用配置服务中的所有快照

示例用法：

const result = await client.listSnapshots();

function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

参数

options
ListSnapshotsOptions

请求的可选参数。

返回

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

将存档的快照恢复回就绪状态

示例用法：

const result = await client.recoverSnapshot("MySnapshot");

function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

参数

name

string

快照的名称。

options
UpdateSnapshotOptions

请求的可选参数。

返回

Promise<UpdateSnapshotResponse>

setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

在 Azure 应用配置服务中设置密钥的值，允许可选的 etag。

function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>

参数

configurationSetting

SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>

配置值。

options
SetConfigurationSettingOptions

请求的可选参数。

示例代码：

await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });

返回

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

设置或清除密钥的只读状态。

function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>

参数

id
ConfigurationSettingId

要修改的配置设置的 ID。

readOnly

boolean

options
SetReadOnlyOptions

返回

Promise<SetReadOnlyResponse>

updateSyncToken(string)

添加外部同步令牌，以确保服务请求接收 up-to日期值。

function updateSyncToken(syncToken: string)

参数

syncToken

string

同步令牌值。