AppConfigurationClient class

Pakket:

@azure/app-configuration

Client voor de Azure App Configuration-service.

Constructors

AppConfigurationClient(string, AppConfigurationClientOptions)	Initialiseert een nieuw exemplaar van de klasse AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Initialiseert een nieuw exemplaar van de klasse AppConfigurationClient met behulp van een TokenCredential.

Methoden

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Voeg een instelling toe aan de Azure App Configuration-service en mislukt als deze al bestaat. Voorbeeldgebruik: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Een momentopname archiveren Voorbeeldgebruik: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Begint met het maken van een momentopname voor de Azure App Configuration-service, mislukt als deze al bestaat.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Begint met het maken van een momentopname voor de Azure App Configuration-service, wacht totdat deze is voltooid, mislukt als deze al bestaat.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Een instelling verwijderen uit de Azure App Configuration-service Voorbeeldgebruik: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Hiermee haalt u een instelling op uit de Azure App Configuration-service. Voorbeeldcode: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Een momentopname ophalen uit de Azure App Configuration-service Voorbeeldgebruik: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Hiermee worden instellingen van de Azure App Configuration-service weergegeven, optioneel gefilterd op sleutelnamen, labels en datum/tijd. Voorbeeldcode: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Hier vindt u instellingen van de Azure App Configuration-service voor momentopnamen op basis van naam, optioneel gefilterd op sleutelnamen, labels en datum/tijd. Voorbeeldcode: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Een lijst met labels ophalen uit de Azure App Configuration-service Voorbeeldcode: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Bevat revisies van een set sleutels, optioneel gefilterd op sleutelnamen, labels en datum/tijd. Voorbeeldcode: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Alle momentopnamen van de Azure App Configuration-service weergeven Voorbeeldgebruik: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Een gearchiveerde momentopname terugzetten naar de status Gereed Voorbeeldgebruik: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Hiermee stelt u de waarde van een sleutel in de Azure App Configuration-service in, waardoor een optionele etag mogelijk is.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Hiermee wordt de status Alleen-lezen van een sleutel ingesteld of gewist.
updateSyncToken(string)	Hiermee voegt u een extern synchronisatietoken toe om ervoor te zorgen dat serviceaanvragen up-to-datumwaarden ontvangen.

Constructordetails

AppConfigurationClient(string, AppConfigurationClientOptions)

Initialiseert een nieuw exemplaar van de klasse AppConfigurationClient.

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

Parameters

connectionString

string

Verbindingsreeks die nodig is voor een client om verbinding te maken met Azure.

options

AppConfigurationClientOptions

Opties voor de AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Initialiseert een nieuw exemplaar van de klasse AppConfigurationClient met behulp van een TokenCredential.

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

Parameters

endpoint

string

Het eindpunt van de App Configuration-service (bijvoorbeeld: https://sample.azconfig.io).

tokenCredential

TokenCredential

Een object dat de TokenCredential-interface implementeert die wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik het @azure/identity-pakket om een referentie te maken die aan uw behoeften voldoet.

options

AppConfigurationClientOptions

Opties voor de AppConfigurationClient.

Methodedetails

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

Voeg een instelling toe aan de Azure App Configuration-service en mislukt als deze al bestaat.

Voorbeeldgebruik:

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

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

Parameters

configurationSetting

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

Een configuratie-instelling.

options

AddConfigurationSettingOptions

Optionele parameters voor de aanvraag.

Retouren

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Een momentopname archiveren

Voorbeeldgebruik:

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

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

Parameters

name

string

De naam van de momentopname.

options

UpdateSnapshotOptions

Optionele parameters voor de aanvraag.

Retouren

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Begint met het maken van een momentopname voor de Azure App Configuration-service, mislukt als deze al bestaat.

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

Parameters

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Retouren

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Begint met het maken van een momentopname voor de Azure App Configuration-service, wacht totdat deze is voltooid, mislukt als deze al bestaat.

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

Parameters

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Retouren

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Een instelling verwijderen uit de Azure App Configuration-service

Voorbeeldgebruik:

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

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

Parameters

id

ConfigurationSettingId

De id van de configuratie-instelling die moet worden verwijderd.

options

DeleteConfigurationSettingOptions

Optionele parameters voor de aanvraag (bijvoorbeeld: etag, label)

Retouren

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Hiermee haalt u een instelling op uit de Azure App Configuration-service.

Voorbeeldcode:

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

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

Parameters

id

ConfigurationSettingId

De id van de configuratie-instelling die moet worden get.

options

GetConfigurationSettingOptions

Optionele parameters voor de aanvraag.

Retouren

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Een momentopname ophalen uit de Azure App Configuration-service

Voorbeeldgebruik:

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

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

Parameters

name

string

De naam van de momentopname.

options

GetSnapshotOptions

Optionele parameters voor de aanvraag.

Retouren

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Hiermee worden instellingen van de Azure App Configuration-service weergegeven, optioneel gefilterd op sleutelnamen, labels en datum/tijd.

Voorbeeldcode:

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

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

Parameters

options

ListConfigurationSettingsOptions

Optionele parameters voor de aanvraag.

Retouren

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Hier vindt u instellingen van de Azure App Configuration-service voor momentopnamen op basis van naam, optioneel gefilterd op sleutelnamen, labels en datum/tijd.

Voorbeeldcode:

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

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

Parameters

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Optionele parameters voor de aanvraag.

Retouren

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Een lijst met labels ophalen uit de Azure App Configuration-service

Voorbeeldcode:

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

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

Parameters

options

ListLabelsOptions

Optionele parameters voor de aanvraag.

Retouren

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Bevat revisies van een set sleutels, optioneel gefilterd op sleutelnamen, labels en datum/tijd.

Voorbeeldcode:

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

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

Parameters

options

ListRevisionsOptions

Optionele parameters voor de aanvraag.

Retouren

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Alle momentopnamen van de Azure App Configuration-service weergeven

Voorbeeldgebruik:

const result = await client.listSnapshots();

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

Parameters

options

ListSnapshotsOptions

Optionele parameters voor de aanvraag.

Retouren

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Een gearchiveerde momentopname terugzetten naar de status Gereed

Voorbeeldgebruik:

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

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

Parameters

name

string

De naam van de momentopname.

options

UpdateSnapshotOptions

Optionele parameters voor de aanvraag.

Retouren

Promise<UpdateSnapshotResponse>

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

Hiermee stelt u de waarde van een sleutel in de Azure App Configuration-service in, waardoor een optionele etag mogelijk is.

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

Parameters

configurationSetting

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

Een configuratiewaarde.

options

SetConfigurationSettingOptions

Optionele parameters voor de aanvraag.

Voorbeeldcode:

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

Retouren

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Hiermee wordt de status Alleen-lezen van een sleutel ingesteld of gewist.

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

Parameters

id

ConfigurationSettingId

De id van de configuratie-instelling die moet worden gewijzigd.

readOnly

boolean

options

SetReadOnlyOptions

Retouren

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Hiermee voegt u een extern synchronisatietoken toe om ervoor te zorgen dat serviceaanvragen up-to-datumwaarden ontvangen.

function updateSyncToken(syncToken: string)

Parameters

syncToken

string

De waarde van het synchronisatietoken.