@azure/app-configuration package
類別
| AppConfigurationClient |
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-match 的選項 |
| HttpOnlyIfUnchangedField |
用來為 HTTP 要求提供 if-match 的選項 |
| HttpResponseField |
HTTP 回應相關信息 - 標頭和原始本文。 |
| HttpResponseFields |
在個別 HTTP 回應欄位對於使用者而言，在處理 HTTP 狀態代碼 204 或 304 等常見使用案例中，用戶對於使用個別 HTTP 回應字段而言很重要時，會從 物件的 _response 字段上啟動的欄位。 |
| ListConfigurationSettingPage |
組態設定的頁面和對應的 HTTP 回應 |
| ListConfigurationSettingsForSnapshotOptions |
AppConfig 中用來指定通配符以及接受日期時間標頭之 'list' 樣式 API 的常見選項。 |
| ListConfigurationSettingsOptions |
listConfigurationSettings 的選項，允許根據索引鍵、標籤和其他字段進行篩選。
也提供 |
| ListLabelsOptions |
listLabels 的選項 |
| ListLabelsPage |
組態設定的頁面和對應的 HTTP 回應 |
| ListRevisionsOptions |
listRevisions 的選項，允許根據索引鍵、標籤和其他字段進行篩選。
也提供 |
| ListRevisionsPage |
組態設定的頁面和對應的 HTTP 回應 |
| ListSettingsOptions |
AppConfig 中用來指定通配符以及接受日期時間標頭之 'list' 樣式 API 的常見選項。 |
| ListSnapshots |
AppConfig 中用來指定通配符以及接受日期時間標頭之 'list' 樣式 API 的常見選項。 |
| ListSnapshotsOptions |
listConfigurationSettings 的選項，允許根據索引鍵、標籤和其他字段進行篩選。
也提供 |
| ListSnapshotsPage |
組態設定的頁面和對應的 HTTP 回應 |
| OptionalFields |
當 API 支援選擇性地傳回欄位時使用。 |
| OptionalLabelsFields |
當 API 支援選擇性地傳回標籤標欄位時使用。 |
| OptionalSnapshotFields |
當 API 支援選擇性地傳回欄位時使用。 |
| PageSettings |
追蹤分頁反覆運算設定的介面 |
| RetryOptions |
控制如何重試失敗要求的選項。 |
| SecretReferenceValue |
更新或建立新秘密參考的必要欄位。 |
| SetConfigurationSettingOptions |
儲存 ConfigurationSetting 時所使用的選項。 |
| SetConfigurationSettingResponse |
設定 ConfigurationSetting 的回應。 |
| SetReadOnlyOptions |
setReadOnly 的選項 |
| SetReadOnlyResponse |
將值設定為唯讀時的回應。 |
| SettingLabel |
標籤詳細數據，其名稱屬性只能由伺服器填入 |
| SnapshotInfo |
可唯一識別快照集的欄位 |
| SnapshotReferenceValue |
更新或建立新快照參考的必要欄位。 |
| SnapshotResponse |
新增快照集的回應。 |
| SyncTokenHeaderField |
同步令牌標頭欄位 |
| UpdateSnapshotOptions |
更新快照集時所使用的選項。 |
| UpdateSnapshotResponse |
更新快照集的回應。 |
類型別名
| AddConfigurationSettingParam |
新增組態設定的參數 |
| ConfigurationSetting |
具有伺服器額外元數據的組態設定，指出其 etag、它目前是否為 readOnly，以及上次修改時間。 |
| ConfigurationSettingParam |
更新或建立新組態設定的必要欄位 |
| ConfigurationSettingResponse |
取得、刪除或更新組態設定的標準基底回應 |
| ConfigurationSnapshotStatus |
定義 ConfigurationSnapshotStatus 的值。 服務支援的已知值
布建 |
| SetConfigurationSettingParam |
用於建立或更新新組態設定的參數 |
| SnapshotComposition |
定義 SnapshotComposition 的值。 服務支援的已知值
鍵 |
列舉
| KnownAppConfigAudience |
Azure 應用程式設定物件已知值 |
| KnownConfigurationSnapshotStatus |
ConfigurationSnapshotStatus 服務的已知值。 |
| KnownSnapshotComposition |
SnapshotComposition 服務的已知值。 |
函式
| is |
讓您知道 ConfigurationSetting 是否為功能旗標。 [檢查內容類型是否為 featureFlagContentType |
| is |
讓您知道 ConfigurationSetting 是否為秘密參考。 [檢查內容類型是否為 secretReferenceContentType |
| is |
讓您知道 ConfigurationSetting 是否是快照集參考。 [檢查內容類型是否為 snapshotReferenceContentType |
| parse |
將 ConfigurationSetting 作為輸入，並通過分析值字串返回 ConfigurationSetting<FeatureFlagValue> 。 |
| parse |
將 ConfigurationSetting 作為輸入，並通過分析值字串返回 ConfigurationSetting<SecretReferenceValue> 。 |
| parse |
將 ConfigurationSetting 作為輸入，並剖析值字串來傳回 ConfigurationSetting<SnapshotReferenceValue> 。 |
函式詳細資料
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
isSnapshotReference(ConfigurationSetting<string>)
讓您知道 ConfigurationSetting 是否是快照集參考。
[檢查內容類型是否為 snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]
function isSnapshotReference(setting: ConfigurationSetting<string>): setting參數
- setting
-
ConfigurationSetting<string>
傳回
setting
parseFeatureFlag(ConfigurationSetting<string>)
將 ConfigurationSetting 作為輸入，並通過分析值字串返回 ConfigurationSetting<FeatureFlagValue> 。
function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>參數
- setting
-
ConfigurationSetting<string>
傳回
parseSecretReference(ConfigurationSetting<string>)
將 ConfigurationSetting 作為輸入，並通過分析值字串返回 ConfigurationSetting<SecretReferenceValue> 。
function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>參數
- setting
-
ConfigurationSetting<string>
傳回
parseSnapshotReference(ConfigurationSetting<string>)
將 ConfigurationSetting 作為輸入，並剖析值字串來傳回 ConfigurationSetting<SnapshotReferenceValue> 。
function parseSnapshotReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SnapshotReferenceValue>參數
- setting
-
ConfigurationSetting<string>