@azure/app-configuration package

クラス

AppConfigurationClient

Azure App Configuration サービスのクライアント。

インターフェイス

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	オブジェクトの_response フィールドから取得されるフィールド。HTTP 状態コード 204 または 304 の処理など、ユーザーが一般的なユース ケースで個々の HTTP 応答フィールドを使用することが重要な場合に使用されます。
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>)

入力として ConfigurationSetting を受け取り、値の文字列を解析して ConfigurationSetting を返します。

function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>

パラメーター

setting

ConfigurationSetting<string>

戻り値

ConfigurationSetting<SecretReferenceValue>