Поделиться через

AppConfigurationClient class

  • Ссылка
Пакет:
@azure/app-configuration

Клиент службы конфигурации приложений Azure.

Конструкторы

AppConfigurationClient(string, AppConfigurationClientOptions)

Инициализирует новый экземпляр класса AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Инициализирует новый экземпляр класса AppConfigurationClient с помощью TokenCredential.

Методы

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

Добавьте параметр в службу конфигурации приложений Azure, если она уже существует.

Пример использования:

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

Архивация готового моментального снимка

Пример использования:

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

Начинает создание моментального снимка для службы конфигурации приложений Azure, завершается ошибкой, если она уже существует.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Начинает создание моментального снимка для службы конфигурации приложений Azure, ожидает завершения, завершается ошибкой, если она уже существует.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Удаление параметра из службы конфигурации приложений Azure

Пример использования:

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

Возвращает параметр из службы конфигурации приложений Azure.

Пример кода:

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

Получение моментального снимка из службы конфигурации приложений Azure

Пример использования:

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

Выводит список параметров из службы конфигурации приложений Azure, при необходимости отфильтрованный по именам ключей, меткам и приему даты и времени.

Пример кода:

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Выводит список параметров из службы конфигурации приложений Azure для моментальных снимков на основе имени, необязательно отфильтрованного по именам ключей, меткам и приему даты и времени.

Пример кода:

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

Получение списка меток из службы конфигурации приложений Azure

Пример кода:

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

Выводит список редакций набора ключей, при необходимости отфильтрованных по именам ключей, меткам и приему даты и времени.

Пример кода:

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

Вывод списка всех моментальных снимков из службы конфигурации приложений Azure

Пример использования:

const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)

Восстановление архивного моментального снимка обратно в состояние готовности

Пример использования:

const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

Задает значение ключа в службе конфигурации приложений Azure, что позволяет использовать необязательный etag.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Задает или очищает состояние ключа только для чтения.
updateSyncToken(string)

Добавляет внешний маркер синхронизации, чтобы убедиться, что запросы службы получают up-to-date значения.

Сведения о конструкторе

AppConfigurationClient(string, AppConfigurationClientOptions)

Инициализирует новый экземпляр класса AppConfigurationClient.

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

Параметры

connectionString

string

Строка подключения, необходимая для подключения клиента к Azure.

options
AppConfigurationClientOptions

Параметры для AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Инициализирует новый экземпляр класса AppConfigurationClient с помощью TokenCredential.

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

Параметры

endpoint

string

Конечная точка службы конфигурации приложений (например, https://sample.azconfig.io).

tokenCredential
TokenCredential

Объект, реализующий интерфейс TokenCredential, используемый для проверки подлинности запросов к службе. Используйте пакет @azure/identity для создания учетных данных, которые соответствуют вашим потребностям.

options
AppConfigurationClientOptions

Параметры для AppConfigurationClient.

Сведения о методе

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

Добавьте параметр в службу конфигурации приложений Azure, если она уже существует.

Пример использования:

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

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

Параметры

configurationSetting

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

Параметр конфигурации.

options
AddConfigurationSettingOptions

Необязательные параметры для запроса.

Возвращаемое значение

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Архивация готового моментального снимка

Пример использования:

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

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

Параметры

name

string

Имя моментального снимка.

options
UpdateSnapshotOptions

Необязательные параметры для запроса.

Возвращаемое значение

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Начинает создание моментального снимка для службы конфигурации приложений Azure, завершается ошибкой, если она уже существует.

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

Параметры

snapshot
SnapshotInfo
options
CreateSnapshotOptions

Возвращаемое значение

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Начинает создание моментального снимка для службы конфигурации приложений Azure, ожидает завершения, завершается ошибкой, если она уже существует.

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

Параметры

snapshot
SnapshotInfo
options
CreateSnapshotOptions

Возвращаемое значение

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Удаление параметра из службы конфигурации приложений Azure

Пример использования:

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

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

Параметры

id
ConfigurationSettingId

Идентификатор параметра конфигурации для удаления.

options
DeleteConfigurationSettingOptions

Необязательные параметры для запроса (например, etag, label)

Возвращаемое значение

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Возвращает параметр из службы конфигурации приложений Azure.

Пример кода:

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

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

Параметры

id
ConfigurationSettingId

Идентификатор параметра конфигурации, который требуется получить.

options
GetConfigurationSettingOptions

Необязательные параметры для запроса.

Возвращаемое значение

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Получение моментального снимка из службы конфигурации приложений Azure

Пример использования:

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

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

Параметры

name

string

Имя моментального снимка.

options
GetSnapshotOptions

Необязательные параметры для запроса.

Возвращаемое значение

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Выводит список параметров из службы конфигурации приложений Azure, при необходимости отфильтрованный по именам ключей, меткам и приему даты и времени.

Пример кода:

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

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

Параметры

options
ListConfigurationSettingsOptions

Необязательные параметры для запроса.

Возвращаемое значение

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Выводит список параметров из службы конфигурации приложений Azure для моментальных снимков на основе имени, необязательно отфильтрованного по именам ключей, меткам и приему даты и времени.

Пример кода:

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

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

Параметры

snapshotName

string

options
ListConfigurationSettingsForSnapshotOptions

Необязательные параметры для запроса.

Возвращаемое значение

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Получение списка меток из службы конфигурации приложений Azure

Пример кода:

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

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

Параметры

options
ListLabelsOptions

Необязательные параметры для запроса.

Возвращаемое значение

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Выводит список редакций набора ключей, при необходимости отфильтрованных по именам ключей, меткам и приему даты и времени.

Пример кода:

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

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

Параметры

options
ListRevisionsOptions

Необязательные параметры для запроса.

Возвращаемое значение

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Вывод списка всех моментальных снимков из службы конфигурации приложений Azure

Пример использования:

const result = await client.listSnapshots();

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

Параметры

options
ListSnapshotsOptions

Необязательные параметры для запроса.

Возвращаемое значение

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Восстановление архивного моментального снимка обратно в состояние готовности

Пример использования:

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

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

Параметры

name

string

Имя моментального снимка.

options
UpdateSnapshotOptions

Необязательные параметры для запроса.

Возвращаемое значение

Promise<UpdateSnapshotResponse>

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

Задает значение ключа в службе конфигурации приложений Azure, что позволяет использовать необязательный etag.

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

Параметры

configurationSetting

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

Значение конфигурации.

options
SetConfigurationSettingOptions

Необязательные параметры для запроса.

Пример кода:

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

Возвращаемое значение

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Задает или очищает состояние ключа только для чтения.

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

Параметры

id
ConfigurationSettingId

Идентификатор параметра конфигурации для изменения.

readOnly

boolean

options
SetReadOnlyOptions

Возвращаемое значение

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Добавляет внешний маркер синхронизации, чтобы убедиться, что запросы службы получают up-to-date значения.

function updateSyncToken(syncToken: string)

Параметры

syncToken

string

Значение маркера синхронизации.