AppConfigurationClient class

Pacchetto:

@azure/app-configuration

Client per il servizio Configurazione app di Azure.

Costruttori

AppConfigurationClient(string, AppConfigurationClientOptions)	Inizializza una nuova istanza della classe AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Inizializza una nuova istanza della classe AppConfigurationClient usando tokenCredential.

Metodi

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Aggiungere un'impostazione nel servizio Configurazione app di Azure, con esito negativo se esiste già. Esempio di utilizzo: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Archiviare uno snapshot pronto Esempio di utilizzo: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Inizia a creare uno snapshot per il servizio Configurazione app di Azure, se esiste già.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Inizia a creare uno snapshot per il servizio Configurazione app di Azure, attende fino a quando non viene completato, ha esito negativo se esiste già.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Eliminare un'impostazione dal servizio Configurazione app di Azure Esempio di utilizzo: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Ottiene un'impostazione dal servizio Configurazione app di Azure. Codice di esempio: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Ottenere uno snapshot dal servizio Configurazione app di Azure Esempio di utilizzo: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Elenca le impostazioni del servizio Configurazione app di Azure, filtrate facoltativamente in base ai nomi delle chiavi, alle etichette e accettare datetime. Codice di esempio: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Elenca le impostazioni del servizio Configurazione app di Azure per gli snapshot in base al nome, facoltativamente filtrate in base ai nomi delle chiavi, alle etichette e accettare datetime. Codice di esempio: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Ottenere un elenco di etichette dal servizio Configurazione app di Azure Codice di esempio: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Elenca le revisioni di un set di chiavi, filtrate facoltativamente in base ai nomi delle chiavi, alle etichette e accettare datetime. Codice di esempio: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Elencare tutti gli snapshot dal servizio Configurazione app di Azure Esempio di utilizzo: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Ripristinare lo stato pronto di uno snapshot archiviato Esempio di utilizzo: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Imposta il valore di una chiave nel servizio Configurazione app di Azure, consentendo un etag facoltativo.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Imposta o cancella lo stato di sola lettura di una chiave.
updateSyncToken(string)	Aggiunge un token di sincronizzazione esterno per garantire che le richieste di servizio ricevano valori up-to-date.

Dettagli costruttore

AppConfigurationClient(string, AppConfigurationClientOptions)

Inizializza una nuova istanza della classe AppConfigurationClient.

new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)

Parametri

connectionString

string

Stringa di connessione necessaria per la connessione di un client ad Azure.

options

AppConfigurationClientOptions

Opzioni per AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Inizializza una nuova istanza della classe AppConfigurationClient usando tokenCredential.

new AppConfigurationClient(endpoint: string, tokenCredential: TokenCredential, options?: AppConfigurationClientOptions)

Parametri

endpoint

string

Endpoint del servizio Configurazione app (ad esempio, https://sample.azconfig.io).

tokenCredential

TokenCredential

Oggetto che implementa l'interfaccia TokenCredential utilizzata per autenticare le richieste al servizio. Usare il pacchetto @azure/identity per creare credenziali adatte alle proprie esigenze.

options

AppConfigurationClientOptions

Opzioni per AppConfigurationClient.

Dettagli metodo

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)

Aggiungere un'impostazione nel servizio Configurazione app di Azure, con esito negativo se esiste già.

Esempio di utilizzo:

const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });

function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>

Parametri

configurationSetting

AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>

Impostazione di configurazione.

options

AddConfigurationSettingOptions

Parametri facoltativi per la richiesta.

Restituisce

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Archiviare uno snapshot pronto

Esempio di utilizzo:

const result = await client.archiveSnapshot({name: "MySnapshot"});

function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parametri

name

string

Nome dello snapshot.

options

UpdateSnapshotOptions

Parametri facoltativi per la richiesta.

Restituisce

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Inizia a creare uno snapshot per il servizio Configurazione app di Azure, se esiste già.

function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

Parametri

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Restituisce

Promise<@azure/core-lro.SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Inizia a creare uno snapshot per il servizio Configurazione app di Azure, attende fino a quando non viene completato, ha esito negativo se esiste già.

function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>

Parametri

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Restituisce

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Eliminare un'impostazione dal servizio Configurazione app di Azure

Esempio di utilizzo:

const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>

Parametri

id

ConfigurationSettingId

ID dell'impostazione di configurazione da eliminare.

options

DeleteConfigurationSettingOptions

Parametri facoltativi per la richiesta (ad esempio: etag, etichetta)

Restituisce

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Ottiene un'impostazione dal servizio Configurazione app di Azure.

Codice di esempio:

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>

Parametri

id

ConfigurationSettingId

ID dell'impostazione di configurazione da ottenere.

options

GetConfigurationSettingOptions

Parametri facoltativi per la richiesta.

Restituisce

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Ottenere uno snapshot dal servizio Configurazione app di Azure

Esempio di utilizzo:

const result = await client.getSnapshot("MySnapshot");

function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>

Parametri

name

string

Nome dello snapshot.

options

GetSnapshotOptions

Parametri facoltativi per la richiesta.

Restituisce

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Elenca le impostazioni del servizio Configurazione app di Azure, filtrate facoltativamente in base ai nomi delle chiavi, alle etichette e accettare datetime.

Codice di esempio:

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });

function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parametri

options

ListConfigurationSettingsOptions

Parametri facoltativi per la richiesta.

Restituisce

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Elenca le impostazioni del servizio Configurazione app di Azure per gli snapshot in base al nome, facoltativamente filtrate in base ai nomi delle chiavi, alle etichette e accettare datetime.

Codice di esempio:

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });

function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parametri

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Parametri facoltativi per la richiesta.

Restituisce

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Ottenere un elenco di etichette dal servizio Configurazione app di Azure

Codice di esempio:

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });

function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

Parametri

options

ListLabelsOptions

Parametri facoltativi per la richiesta.

Restituisce

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Elenca le revisioni di un set di chiavi, filtrate facoltativamente in base ai nomi delle chiavi, alle etichette e accettare datetime.

Codice di esempio:

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });

function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

Parametri

options

ListRevisionsOptions

Parametri facoltativi per la richiesta.

Restituisce

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Elencare tutti gli snapshot dal servizio Configurazione app di Azure

Esempio di utilizzo:

const result = await client.listSnapshots();

function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

Parametri

options

ListSnapshotsOptions

Parametri facoltativi per la richiesta.

Restituisce

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Ripristinare lo stato pronto di uno snapshot archiviato

Esempio di utilizzo:

const result = await client.recoverSnapshot("MySnapshot");

function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parametri

name

string

Nome dello snapshot.

options

UpdateSnapshotOptions

Parametri facoltativi per la richiesta.

Restituisce

Promise<UpdateSnapshotResponse>

setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

Imposta il valore di una chiave nel servizio Configurazione app di Azure, consentendo un etag facoltativo.

function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>

Parametri

configurationSetting

SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>

Valore di configurazione.

options

SetConfigurationSettingOptions

Parametri facoltativi per la richiesta.

Codice di esempio:

await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });

Restituisce

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Imposta o cancella lo stato di sola lettura di una chiave.

function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>

Parametri

id

ConfigurationSettingId

ID dell'impostazione di configurazione da modificare.

readOnly

boolean

options

SetReadOnlyOptions

Restituisce

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Aggiunge un token di sincronizzazione esterno per garantire che le richieste di servizio ricevano valori up-to-date.

function updateSyncToken(syncToken: string)

Parametri

syncToken

string

Valore del token di sincronizzazione.