AppConfigurationClient class
Клиент службы конфигурации приложений Azure.
Конструкторы
| App |
Инициализирует новый экземпляр класса AppConfigurationClient. |
| App |
Инициализирует новый экземпляр класса AppConfigurationClient с помощью TokenCredential. |
Методы
| add |
Добавьте параметр в службу конфигурации приложений Azure, если она уже существует. Пример использования:
|
| archive |
Архивация готового моментального снимка Пример использования:
|
| begin |
Начинает создание моментального снимка для службы конфигурации приложений Azure, завершается ошибкой, если она уже существует. |
| begin |
Начинает создание моментального снимка для службы конфигурации приложений Azure, ожидает завершения, завершается ошибкой, если она уже существует. |
| check |
Проверяет настройки через сервис настройки приложений Azure с помощью HEAD-запроса, возвращая только заголовки без тела ответа. Это полезно для эффективной проверки, изменились ли настройки, сравнивая ETags. Пример кода:
|
| delete |
Удаление параметра из службы конфигурации приложений Azure Пример использования:
|
| get |
Возвращает параметр из службы конфигурации приложений Azure. Пример кода:
|
| get |
Получение моментального снимка из службы конфигурации приложений Azure Пример использования:
|
| list |
Выводит список параметров из службы конфигурации приложений Azure, при необходимости отфильтрованный по именам ключей, меткам и приему даты и времени. Пример кода:
|
| list |
Выводит список параметров из службы конфигурации приложений Azure для моментальных снимков на основе имени, необязательно отфильтрованного по именам ключей, меткам и приему даты и времени. Пример кода:
|
| list |
Получение списка меток из службы конфигурации приложений Azure Пример кода:
|
| list |
Выводит список редакций набора ключей, при необходимости отфильтрованных по именам ключей, меткам и приему даты и времени. Пример кода:
|
| list |
Вывод списка всех моментальных снимков из службы конфигурации приложений Azure Пример использования:
|
| recover |
Восстановление архивного моментального снимка обратно в состояние готовности Пример использования:
|
| set |
Задает значение ключа в службе конфигурации приложений Azure, что позволяет использовать необязательный etag. |
| set |
Задает или очищает состояние ключа только для чтения. |
| update |
Добавляет внешний маркер синхронизации, чтобы убедиться, что запросы службы получают up-to-date значения. |
Сведения о конструкторе
AppConfigurationClient(string, AppConfigurationClientOptions)
Инициализирует новый экземпляр класса AppConfigurationClient.
new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)
Параметры
- connectionString
-
string
- 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> | AddConfigurationSettingParam<SnapshotReferenceValue>, AddConfigurationSettingOptions)
Добавьте параметр в службу конфигурации приложений Azure, если она уже существует.
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const result = await client.addConfigurationSetting({
key: "MyKey",
label: "MyLabel",
value: "MyValue",
});
function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>
Параметры
- configurationSetting
-
AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>
Параметр конфигурации.
- options
- AddConfigurationSettingOptions
Необязательные параметры для запроса.
Возвращаемое значение
Promise<AddConfigurationSettingResponse>
archiveSnapshot(string, UpdateSnapshotOptions)
Архивация готового моментального снимка
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
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>
checkConfigurationSettings(CheckConfigurationSettingsOptions)
Проверяет настройки через сервис настройки приложений Azure с помощью HEAD-запроса, возвращая только заголовки без тела ответа. Это полезно для эффективной проверки, изменились ли настройки, сравнивая ETags.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const pageIterator = client.checkConfigurationSettings({ keyFilter: "MyKey" }).byPage();
function checkConfigurationSettings(options?: CheckConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Параметры
Необязательные параметры для запроса.
Возвращаемое значение
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)
Удаление параметра из службы конфигурации приложений Azure
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const deletedSetting = await client.deleteConfigurationSetting({
key: "MyKey",
label: "MyLabel",
});
function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>
Параметры
Идентификатор параметра конфигурации для удаления.
Необязательные параметры для запроса (например, etag, label)
Возвращаемое значение
Promise<DeleteConfigurationSettingResponse>
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)
Возвращает параметр из службы конфигурации приложений Azure.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>
Параметры
Идентификатор параметра конфигурации, который требуется получить.
- options
- GetConfigurationSettingOptions
Необязательные параметры для запроса.
Возвращаемое значение
Promise<GetConfigurationSettingResponse>
getSnapshot(string, GetSnapshotOptions)
Получение моментального снимка из службы конфигурации приложений Azure
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const retrievedSnapshot = await client.getSnapshot("testsnapshot");
console.log("Retrieved snapshot:", retrievedSnapshot);
function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>
Параметры
- name
-
string
Имя моментального снимка.
- options
- GetSnapshotOptions
Необязательные параметры для запроса.
Возвращаемое значение
Promise<GetSnapshotResponse>
listConfigurationSettings(ListConfigurationSettingsOptions)
Выводит список параметров из службы конфигурации приложений Azure, при необходимости отфильтрованный по именам ключей, меткам и приему даты и времени.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Параметры
- options
- ListConfigurationSettingsOptions
Необязательные параметры для запроса.
Возвращаемое значение
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)
Выводит список параметров из службы конфигурации приложений Azure для моментальных снимков на основе имени, необязательно отфильтрованного по именам ключей, меткам и приему даты и времени.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({
snapshotName: "MySnapshot",
});
function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Параметры
- snapshotName
-
string
Необязательные параметры для запроса.
Возвращаемое значение
listLabels(ListLabelsOptions)
Получение списка меток из службы конфигурации приложений Azure
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>
Параметры
- options
- ListLabelsOptions
Необязательные параметры для запроса.
Возвращаемое значение
listRevisions(ListRevisionsOptions)
Выводит список редакций набора ключей, при необходимости отфильтрованных по именам ключей, меткам и приему даты и времени.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>
Параметры
- options
- ListRevisionsOptions
Необязательные параметры для запроса.
Возвращаемое значение
listSnapshots(ListSnapshotsOptions)
Вывод списка всех моментальных снимков из службы конфигурации приложений Azure
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
const snapshots = await client.listSnapshots();
for await (const snapshot of snapshots) {
console.log(`Found snapshot: ${snapshot.name}`);
}
function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>
Параметры
- options
- ListSnapshotsOptions
Необязательные параметры для запроса.
Возвращаемое значение
recoverSnapshot(string, UpdateSnapshotOptions)
Восстановление архивного моментального снимка обратно в состояние готовности
Пример использования:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
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> | SetConfigurationSettingParam<SnapshotReferenceValue>, SetConfigurationSettingOptions)
Задает значение ключа в службе конфигурации приложений Azure, что позволяет использовать необязательный etag.
function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue> | SetConfigurationSettingParam<SnapshotReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>
Параметры
- configurationSetting
-
SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue> | SetConfigurationSettingParam<SnapshotReferenceValue>
Значение конфигурации.
- options
- SetConfigurationSettingOptions
Необязательные параметры для запроса.
Пример кода:
import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";
// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);
await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });
Возвращаемое значение
Promise<SetConfigurationSettingResponse>
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)
Задает или очищает состояние ключа только для чтения.
function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>
Параметры
Идентификатор параметра конфигурации для изменения.
- readOnly
-
boolean
- options
- SetReadOnlyOptions
Возвращаемое значение
Promise<SetReadOnlyResponse>
updateSyncToken(string)
Добавляет внешний маркер синхронизации, чтобы убедиться, что запросы службы получают up-to-date значения.
function updateSyncToken(syncToken: string)
Параметры
- syncToken
-
string
Значение маркера синхронизации.