共用方式為

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-date 值。

建構函式詳細資料

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

要刪除之組態設定的標識碼。

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

要取得之組態設定的標識碼。

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

要修改之組態設定的標識碼。

readOnly

boolean

options
SetReadOnlyOptions

傳回

Promise<SetReadOnlyResponse>

updateSyncToken(string)

新增外部同步處理令牌，以確保服務要求接收 up-to-date 值。

function updateSyncToken(syncToken: string)

參數

syncToken

string

同步處理令牌值。