AppConfigurationClient class

Initialise une nouvelle instance de la classe AppConfigurationClient.

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

Paramètres

Initialise une nouvelle instance de la classe AppConfigurationClient à l’aide d’un TokenCredential.

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

Paramètres

Ajoutez un paramètre au service Azure App Configuration, en cas d’échec s’il existe déjà.

Exemple d’utilisation :

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

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

Paramètres

Retours

Archiver un instantané prêt

Exemple d’utilisation :

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

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

Paramètres

Retours

Commence à créer un instantané pour Le service Azure App Configuration, échoue s’il existe déjà.

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

Paramètres

Retours

Commence à créer un instantané pour le service Azure App Configuration, attend qu’il soit terminé, échoue s’il existe déjà.

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

Paramètres

Retours

Supprimer un paramètre du service Azure App Configuration

Exemple d’utilisation :

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

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

Paramètres

Retours

Obtient un paramètre à partir du service Azure App Configuration.

Exemple de code :

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

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

Paramètres

Retours

Obtenir un instantané à partir d’Azure App Configuration Service

Exemple d’utilisation :

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

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

Paramètres

Retours

Répertorie les paramètres du service Azure App Configuration, éventuellement filtrés par noms de clés, étiquettes et acceptation de datetime.

Exemple de code :

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

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

Paramètres

Retours

Répertorie les paramètres du service Azure App Configuration pour les instantanés en fonction du nom, éventuellement filtrés par noms de clés, étiquettes et acceptation de datetime.

Exemple de code :

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

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

Paramètres

Retours

Obtenir la liste des étiquettes à partir du service Azure App Configuration

Exemple de code :

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

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

Paramètres

Retours

Répertorie les révisions d’un ensemble de clés, éventuellement filtrées par noms de clés, étiquettes et acceptation de datetime.

Exemple de code :

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

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

Paramètres

Retours

Répertorier tous les instantanés à partir du service Azure App Configuration

Exemple d’utilisation :

const result = await client.listSnapshots();

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

Paramètres

Retours

Récupérer un instantané archivé à l’état prêt

Exemple d’utilisation :

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

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

Paramètres

Retours

Définit la valeur d’une clé dans le service Azure App Configuration, ce qui permet un etag facultatif.

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

Paramètres

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

Retours

Définit ou efface l’état en lecture seule d’une clé.

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

Paramètres

Retours

Ajoute un jeton de synchronisation externe pour garantir que les demandes de service reçoivent des valeurs up-to-date.

function updateSyncToken(syncToken: string)

Paramètres