AppConfigurationClient class
Klien untuk layanan Azure App Configuration.
Konstruktor
App |
Menginisialisasi instans baru kelas AppConfigurationClient. |
App |
Menginisialisasi instans baru kelas AppConfigurationClient menggunakan TokenCredential. |
Metode
add |
Tambahkan pengaturan ke dalam layanan Azure App Configuration, gagal jika sudah ada. Contoh penggunaan:
|
archive |
Mengarsipkan rekam jepret yang siap Contoh penggunaan:
|
begin |
Mulai membuat rekam jepret untuk layanan Azure App Configuration, gagal jika sudah ada. |
begin |
Mulai membuat rekam jepret untuk layanan Azure App Configuration, menunggu hingga selesai, gagal jika sudah ada. |
delete |
Menghapus pengaturan dari layanan Azure App Configuration Contoh penggunaan:
|
get |
Mendapatkan pengaturan dari layanan Azure App Configuration. Contoh kode:
|
get |
Mendapatkan rekam jepret dari layanan Azure App Configuration Contoh penggunaan:
|
list |
Mencantumkan pengaturan dari layanan Azure App Configuration, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu. Contoh kode:
|
list |
Mencantumkan pengaturan dari layanan Azure App Configuration untuk rekam jepret berdasarkan nama, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu. Contoh kode:
|
list |
Mencantumkan revisi sekumpulan kunci, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu. Contoh kode:
|
list |
Mencantumkan semua rekam jepret dari layanan Azure App Configuration Contoh penggunaan:
|
recover |
Memulihkan rekam jepret yang diarsipkan kembali ke status siap Contoh penggunaan:
|
set |
Mengatur nilai kunci dalam layanan Azure App Configuration, memungkinkan etag opsional. |
set |
Mengatur atau menghapus status baca-saja kunci. |
update |
Menambahkan token sinkronisasi eksternal untuk memastikan permintaan layanan menerima nilai terbaru. |
Detail Konstruktor
AppConfigurationClient(string, AppConfigurationClientOptions)
Menginisialisasi instans baru kelas AppConfigurationClient.
new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)
Parameter
- connectionString
-
string
String koneksi diperlukan klien untuk menyambungkan ke Azure.
- options
- AppConfigurationClientOptions
Opsi untuk AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)
Menginisialisasi instans baru kelas AppConfigurationClient menggunakan TokenCredential.
new AppConfigurationClient(endpoint: string, tokenCredential: TokenCredential, options?: AppConfigurationClientOptions)
Parameter
- endpoint
-
string
Titik akhir layanan App Configuration (misalnya: https://sample.azconfig.io).
- tokenCredential
- TokenCredential
Objek yang mengimplementasikan antarmuka yang TokenCredential
digunakan untuk mengautentikasi permintaan ke layanan.
@azure/identity Gunakan paket untuk membuat kredensial yang sesuai dengan kebutuhan Anda.
- options
- AppConfigurationClientOptions
Opsi untuk AppConfigurationClient.
Detail Metode
addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)
Tambahkan pengaturan ke dalam layanan Azure App Configuration, gagal jika sudah ada.
Contoh penggunaan:
const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>
Parameter
- configurationSetting
-
AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>
Pengaturan konfigurasi.
- options
- AddConfigurationSettingOptions
Parameter opsional untuk permintaan.
Mengembalikan
Promise<AddConfigurationSettingResponse>
archiveSnapshot(string, UpdateSnapshotOptions)
Mengarsipkan rekam jepret yang siap
Contoh penggunaan:
const result = await client.archiveSnapshot({name: "MySnapshot"});
function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>
Parameter
- name
-
string
Nama rekam jepret.
- options
- UpdateSnapshotOptions
Parameter opsional untuk permintaan.
Mengembalikan
Promise<UpdateSnapshotResponse>
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)
Mulai membuat rekam jepret untuk layanan Azure App Configuration, gagal jika sudah ada.
function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>
Parameter
- snapshot
- SnapshotInfo
- options
- CreateSnapshotOptions
Mengembalikan
Promise<@azure/core-lro.SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)
Mulai membuat rekam jepret untuk layanan Azure App Configuration, menunggu hingga selesai, gagal jika sudah ada.
function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>
Parameter
- snapshot
- SnapshotInfo
- options
- CreateSnapshotOptions
Mengembalikan
Promise<CreateSnapshotResponse>
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)
Menghapus pengaturan dari layanan Azure App Configuration
Contoh penggunaan:
const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>
Parameter
Id pengaturan konfigurasi yang akan dihapus.
Parameter opsional untuk permintaan (misalnya: etag, label)
Mengembalikan
Promise<DeleteConfigurationSettingResponse>
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)
Mendapatkan pengaturan dari layanan Azure App Configuration.
Contoh kode:
const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>
Parameter
Id pengaturan konfigurasi yang akan didapatkan.
- options
- GetConfigurationSettingOptions
Parameter opsional untuk permintaan.
Mengembalikan
Promise<GetConfigurationSettingResponse>
getSnapshot(string, GetSnapshotOptions)
Mendapatkan rekam jepret dari layanan Azure App Configuration
Contoh penggunaan:
const result = await client.getSnapshot("MySnapshot");
function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>
Parameter
- name
-
string
Nama rekam jepret.
- options
- GetSnapshotOptions
Parameter opsional untuk permintaan.
Mengembalikan
Promise<GetSnapshotResponse>
listConfigurationSettings(ListConfigurationSettingsOptions)
Mencantumkan pengaturan dari layanan Azure App Configuration, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu.
Contoh kode:
const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Parameter
- options
- ListConfigurationSettingsOptions
Parameter opsional untuk permintaan.
Mengembalikan
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)
Mencantumkan pengaturan dari layanan Azure App Configuration untuk rekam jepret berdasarkan nama, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu.
Contoh kode:
const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Parameter
- snapshotName
-
string
Parameter opsional untuk permintaan.
Mengembalikan
listRevisions(ListRevisionsOptions)
Mencantumkan revisi sekumpulan kunci, secara opsional difilter menurut nama kunci, label, dan terima tanggalwaktu.
Contoh kode:
const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>
Parameter
- options
- ListRevisionsOptions
Parameter opsional untuk permintaan.
Mengembalikan
listSnapshots(ListSnapshotsOptions)
Mencantumkan semua rekam jepret dari layanan Azure App Configuration
Contoh penggunaan:
const result = await client.listSnapshots();
function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>
Parameter
- options
- ListSnapshotsOptions
Parameter opsional untuk permintaan.
Mengembalikan
recoverSnapshot(string, UpdateSnapshotOptions)
Memulihkan rekam jepret yang diarsipkan kembali ke status siap
Contoh penggunaan:
const result = await client.recoverSnapshot("MySnapshot");
function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>
Parameter
- name
-
string
Nama rekam jepret.
- options
- UpdateSnapshotOptions
Parameter opsional untuk permintaan.
Mengembalikan
Promise<UpdateSnapshotResponse>
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)
Mengatur nilai kunci dalam layanan Azure App Configuration, memungkinkan etag opsional.
function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>
Parameter
- configurationSetting
-
SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>
Nilai konfigurasi.
- options
- SetConfigurationSettingOptions
Parameter opsional untuk permintaan.
Contoh kode:
await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });
Mengembalikan
Promise<SetConfigurationSettingResponse>
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)
Mengatur atau menghapus status baca-saja kunci.
function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>
Parameter
Id pengaturan konfigurasi yang akan diubah.
- readOnly
-
boolean
- options
- SetReadOnlyOptions
Mengembalikan
Promise<SetReadOnlyResponse>
updateSyncToken(string)
Menambahkan token sinkronisasi eksternal untuk memastikan permintaan layanan menerima nilai terbaru.
function updateSyncToken(syncToken: string)
Parameter
- syncToken
-
string
Nilai token sinkronisasi.