Bagikan melalui

@azure/app-configuration package

  • Referensi

Kelas

AppConfigurationClient

Klien untuk layanan Azure App Configuration.

Antarmuka

AddConfigurationSettingOptions

Opsi yang digunakan saat menambahkan ConfigurationSetting.
AddConfigurationSettingResponse

Respons dari menambahkan ConfigurationSetting.
AppConfigurationClientOptions

Menyediakan opsi konfigurasi untuk AppConfigurationClient.
ConfigurationSettingId

Bidang yang secara unik mengidentifikasi pengaturan konfigurasi
ConfigurationSettingsFilter

Mengaktifkan pemfilteran nilai kunci. Referensi sintaks: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot

Detail rekam jepret mencakup nama, filter, expiresOn, sizeInBytes, status, itemCount, dan lainnya
CreateSnapshotOptions

Opsi yang digunakan saat membuat Rekam Jepret.
CreateSnapshotResponse

Respons dari memperbarui Rekam Jepret.
DeleteConfigurationSettingOptions

Opsi untuk menghapus ConfigurationSetting.
DeleteConfigurationSettingResponse

Respons dari menghapus ConfigurationSetting.
EtagEntity

Entitas dengan etag.
FeatureFlagValue

Nilai bendera fitur
GetConfigurationHeaders

Header dari mendapatkan ConfigurationSetting.
GetConfigurationSettingOptions

Opsi untuk mendapatkan ConfigurationSetting.
GetConfigurationSettingResponse

Respons dari mengambil ConfigurationSetting.
GetSnapshotOptions

Opsi yang digunakan saat mendapatkan Rekam Jepret.
GetSnapshotResponse

Respons dari mendapatkan Rekam Jepret.
HttpOnlyIfChangedField

Opsi yang digunakan untuk menyediakan if-none-match untuk permintaan HTTP
HttpOnlyIfUnchangedField

Opsi yang digunakan untuk menyediakan if-match untuk permintaan HTTP
HttpResponseField

Informasi terkait respons HTTP - header dan tubuh mentah.
HttpResponseFields

Bidang yang dikaitkan dari bidang _response objek yang Digunakan dalam kasus di mana bidang respons HTTP individual penting bagi pengguna untuk digunakan dalam kasus penggunaan umum seperti menangani kode status http 204 atau 304.
ListConfigurationSettingPage

Halaman pengaturan konfigurasi dan respons HTTP yang sesuai
ListConfigurationSettingsForSnapshotOptions

Opsi umum untuk API gaya 'daftar' di AppConfig digunakan untuk menentukan wildcard serta header waktu tanggal terima.
ListConfigurationSettingsOptions

Opsi untuk listConfigurationSettings yang memungkinkan pemfilteran berdasarkan kunci, label, dan bidang lainnya. Juga menyediakan fields yang memungkinkan Anda memilih bidang mana yang diisi secara selektif dalam hasilnya.
ListLabelsOptions

Opsi untuk listLabels
ListLabelsPage

Halaman pengaturan konfigurasi dan respons HTTP yang sesuai
ListRevisionsOptions

Opsi untuk listRevisions yang memungkinkan pemfilteran berdasarkan kunci, label, dan bidang lainnya. Juga menyediakan fields yang memungkinkan Anda memilih bidang mana yang diisi secara selektif dalam hasilnya.
ListRevisionsPage

Halaman pengaturan konfigurasi dan respons HTTP yang sesuai
ListSettingsOptions

Opsi umum untuk API gaya 'daftar' di AppConfig digunakan untuk menentukan wildcard serta header waktu tanggal terima.
ListSnapshots

Opsi umum untuk API gaya 'daftar' di AppConfig digunakan untuk menentukan wildcard serta header waktu tanggal terima.
ListSnapshotsOptions

Opsi untuk listConfigurationSettings yang memungkinkan pemfilteran berdasarkan kunci, label, dan bidang lainnya. Juga menyediakan fields yang memungkinkan Anda memilih bidang mana yang diisi secara selektif dalam hasilnya.
ListSnapshotsPage

Halaman pengaturan konfigurasi dan respons HTTP yang sesuai
OptionalFields

Digunakan saat API mendukung bidang yang dikembalikan secara selektif.
OptionalLabelsFields

Digunakan saat API mendukung bidang label yang dikembalikan secara selektif.
OptionalSnapshotFields

Digunakan saat API mendukung bidang yang dikembalikan secara selektif.
PageSettings

Antarmuka yang melacak pengaturan untuk iterasi halaman
RetryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
SecretReferenceValue

Bidang yang diperlukan untuk memperbarui atau membuat referensi rahasia baru.
SetConfigurationSettingOptions

Opsi yang digunakan saat menyimpan ConfigurationSetting.
SetConfigurationSettingResponse

Respons dari pengaturan ConfigurationSetting.
SetReadOnlyOptions

Opsi untuk setReadOnly
SetReadOnlyResponse

Respons saat mengatur nilai menjadi baca-saja.
SettingLabel

Detail label, dengan properti nama yang hanya dapat diisi oleh server
SnapshotInfo

Bidang yang secara unik mengidentifikasi rekam jepret
SnapshotResponse

Respons dari menambahkan Rekam Jepret.
SyncTokenHeaderField

Sinkronkan bidang header token
UpdateSnapshotOptions

Opsi yang digunakan saat memperbarui Rekam Jepret.
UpdateSnapshotResponse

Respons dari memperbarui Rekam Jepret.

Alias Jenis

AddConfigurationSettingParam

Parameter untuk menambahkan pengaturan konfigurasi baru
ConfigurationSetting

Pengaturan konfigurasi dengan metadata tambahan dari server, menunjukkan etag-nya, apakah saat ini readOnly dan kapan terakhir diubah.
ConfigurationSettingParam

Bidang yang diperlukan untuk memperbarui atau membuat pengaturan konfigurasi baru
ConfigurationSettingResponse

Respons dasar standar untuk mendapatkan, menghapus, atau memperbarui pengaturan konfigurasi
ConfigurationSnapshotStatus

Menentukan nilai untuk ConfigurationSnapshotStatus.
KnownConfigurationSnapshotStatus dapat digunakan secara bergantian dengan ConfigurationSnapshotStatus, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

provisi
siap
yang diarsipkan
gagal
SetConfigurationSettingParam

Parameter untuk membuat atau memperbarui pengaturan konfigurasi baru
SnapshotComposition

Menentukan nilai untuk SnapshotComposition.
KnownSnapshotComposition dapat digunakan secara bergantian dengan SnapshotComposition, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

kunci
key_label

Enum

KnownConfigurationSnapshotStatus

Nilai yang diketahui dari ConfigurationSnapshotStatus yang diterima layanan.
KnownSnapshotComposition

Nilai SnapshotComposition yang diketahui yang diterima layanan.

Fungsi

isFeatureFlag(ConfigurationSetting<string>)

Memberi tahu Anda apakah ConfigurationSetting adalah bendera fitur.

[Memeriksa apakah tipe isinya adalah featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)

Memberi tahu Anda apakah ConfigurationSetting adalah referensi rahasia.

[Memeriksa apakah tipe isinya adalah secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)

Mengambil ConfigurationSetting sebagai input dan mengembalikan ConfigurationSetting dengan mengurai string nilai.
parseSecretReference(ConfigurationSetting<string>)

Mengambil ConfigurationSetting sebagai input dan mengembalikan ConfigurationSetting dengan mengurai string nilai.

Detail Fungsi

isFeatureFlag(ConfigurationSetting<string>)

Memberi tahu Anda apakah ConfigurationSetting adalah bendera fitur.

[Memeriksa apakah tipe isinya adalah featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

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

Parameter

setting

ConfigurationSetting<string>

Mengembalikan

setting

isSecretReference(ConfigurationSetting<string>)

Memberi tahu Anda apakah ConfigurationSetting adalah referensi rahasia.

[Memeriksa apakah tipe isinya adalah secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

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

Parameter

setting

ConfigurationSetting<string>

Mengembalikan

setting

parseFeatureFlag(ConfigurationSetting<string>)

Mengambil ConfigurationSetting sebagai input dan mengembalikan ConfigurationSetting dengan mengurai string nilai.

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

Parameter

setting

ConfigurationSetting<string>

Mengembalikan

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Mengambil ConfigurationSetting sebagai input dan mengembalikan ConfigurationSetting dengan mengurai string nilai.

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

Parameter

setting

ConfigurationSetting<string>

Mengembalikan

ConfigurationSetting<SecretReferenceValue>