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

@azure/app-configuration package

  • Ссылка

Классы

AppConfigurationClient

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

Интерфейсы

AddConfigurationSettingOptions

Параметры, используемые при добавлении ConfigurationSetting.
AddConfigurationSettingResponse

Ответ от добавления ConfigurationSetting.
AppConfigurationClientOptions

Предоставляет параметры конфигурации для AppConfigurationClient.
ConfigurationSettingId

Поля, однозначно определяющие параметр конфигурации
ConfigurationSettingsFilter

Включает фильтрацию значений ключей. Справочник по синтаксису: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot

Сведения о моментальном снимке включают имя, фильтры, истекает срок действия, размерInBytes, состояние, itemCount и многое другое
CreateSnapshotOptions

Параметры, используемые при создании моментального снимка.
CreateSnapshotResponse

Ответ от обновления моментального снимка.
DeleteConfigurationSettingOptions

Параметры удаления ConfigurationSetting.
DeleteConfigurationSettingResponse

Ответ от удаления ConfigurationSetting.
EtagEntity

Сущность с etag.
FeatureFlagValue

Значение флага компонента
GetConfigurationHeaders

Заголовки из получения ConfigurationSetting.
GetConfigurationSettingOptions

Параметры получения ConfigurationSetting.
GetConfigurationSettingResponse

Ответ от получения ConfigurationSetting.
GetSnapshotOptions

Параметры, используемые при получении моментального снимка.
GetSnapshotResponse

Ответ от получения моментального снимка.
HttpOnlyIfChangedField

Параметры, используемые для предоставления совпадений if-none для HTTP-запроса
HttpOnlyIfUnchangedField

Параметры, используемые для предоставления соответствия для HTTP-запроса
HttpResponseField

Связанные с http-ответом сведения — заголовки и необработанный текст.
HttpResponseFields

Поля, которые подняты из поля _response объекта, используемого в случаях, когда отдельные поля ответа HTTP важны для пользователя, чтобы использовать в распространенных случаях, таких как обработка кодов состояния HTTP 204 или 304.
ListConfigurationSettingPage

Страница параметров конфигурации и соответствующий HTTP-ответ
ListConfigurationSettingsForSnapshotOptions

Распространенные параметры API стилей list в AppConfig, используемые для указания подстановочных знаков, а также заголовка даты принятия.
ListConfigurationSettingsOptions

Параметры listConfigurationSettings, которые позволяют фильтровать на основе ключей, меток и других полей. Кроме того, предоставляет fields, что позволяет выборочно выбрать поля, заполненные в результате.
ListLabelsOptions

Параметры listLabels
ListLabelsPage

Страница параметров конфигурации и соответствующий HTTP-ответ
ListRevisionsOptions

Параметры listRevisions, которые позволяют фильтровать по ключам, меткам и другим полям. Кроме того, предоставляет fields, что позволяет выборочно выбрать поля, заполненные в результате.
ListRevisionsPage

Страница параметров конфигурации и соответствующий HTTP-ответ
ListSettingsOptions

Распространенные параметры API стилей list в AppConfig, используемые для указания подстановочных знаков, а также заголовка даты принятия.
ListSnapshots

Распространенные параметры API стилей list в AppConfig, используемые для указания подстановочных знаков, а также заголовка даты принятия.
ListSnapshotsOptions

Параметры listConfigurationSettings, которые позволяют фильтровать на основе ключей, меток и других полей. Кроме того, предоставляет fields, что позволяет выборочно выбрать поля, заполненные в результате.
ListSnapshotsPage

Страница параметров конфигурации и соответствующий HTTP-ответ
OptionalFields

Используется при выборочном возврате полей API.
OptionalLabelsFields

Используется, когда API поддерживает выборочно возвращаемые поля меток.
OptionalSnapshotFields

Используется при выборочном возврате полей API.
PageSettings

Интерфейс, отслеживающий параметры для итерации страниц
RetryOptions

Параметры, управляющие повторными неудачными запросами.
SecretReferenceValue

Необходимые поля для обновления или создания новой ссылки на секрет.
SetConfigurationSettingOptions

Параметры, используемые при сохранении ConfigurationSetting.
SetConfigurationSettingResponse

Ответ от параметра ConfigurationSetting.
SetReadOnlyOptions

Параметры setReadOnly
SetReadOnlyResponse

Ответ при задании значения только для чтения.
SettingLabel

Сведения о метки с свойством имени, которое может быть заполнено только сервером
SnapshotInfo

Поля, однозначно определяющие моментальный снимок
SnapshotResponse

Ответ от добавления моментального снимка.
SyncTokenHeaderField

Поле заголовка маркера синхронизации
UpdateSnapshotOptions

Параметры, используемые при обновлении моментального снимка.
UpdateSnapshotResponse

Ответ от обновления моментального снимка.

Псевдонимы типа

AddConfigurationSettingParam

Параметры для добавления нового параметра конфигурации
ConfigurationSetting

Параметр конфигурации с дополнительными метаданными с сервера, указывающий его etag, является ли он в данный момент чтениемOnly и когда он был последним изменением.
ConfigurationSettingParam

Необходимые поля для обновления или создания нового параметра конфигурации
ConfigurationSettingResponse

Стандартный базовый ответ для получения, удаления или обновления параметра конфигурации
ConfigurationSnapshotStatus

Определяет значения для ConfigurationSnapshotStatus.
KnownConfigurationSnapshotStatus можно использовать взаимозаменяемо с ConfigurationSnapshotStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

подготовки
готовности
архивированные
не удалось
SetConfigurationSettingParam

Параметры для создания или обновления нового параметра конфигурации
SnapshotComposition

Определяет значения для SnapshotComposition.
KnownSnapshotComposition можно использовать взаимозаменяемо с SnapshotComposition, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ключ
key_label

Перечисления

KnownConfigurationSnapshotStatus

Известные значения ConfigurationSnapshotStatus, которые служба принимает.
KnownSnapshotComposition

Известные значения SnapshotComposition, которые принимает служба.

Функции

isFeatureFlag(ConfigurationSetting<string>)

Позволяет узнать, является ли ConfigurationSetting флагом компонента.

[Проверяет, является ли тип контента компонентомFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)

Позволяет узнать, является ли ConfigurationSetting ссылкой на секрет.

[Проверяет, является ли тип контента secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)

Принимает ConfigurationSetting в качестве входных данных и возвращает ConfigurationSetting, анализируя строку значения.
parseSecretReference(ConfigurationSetting<string>)

Принимает ConfigurationSetting в качестве входных данных и возвращает ConfigurationSetting, анализируя строку значения.

Сведения о функции

isFeatureFlag(ConfigurationSetting<string>)

Позволяет узнать, является ли ConfigurationSetting флагом компонента.

[Проверяет, является ли тип контента компонентомFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

function isFeatureFlag(setting: ConfigurationSetting<string>): setting

Параметры

setting

ConfigurationSetting<string>

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

setting

isSecretReference(ConfigurationSetting<string>)

Позволяет узнать, является ли ConfigurationSetting ссылкой на секрет.

[Проверяет, является ли тип контента secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

function isSecretReference(setting: ConfigurationSetting<string>): setting

Параметры

setting

ConfigurationSetting<string>

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

setting

parseFeatureFlag(ConfigurationSetting<string>)

Принимает ConfigurationSetting в качестве входных данных и возвращает ConfigurationSetting, анализируя строку значения.

function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>

Параметры

setting

ConfigurationSetting<string>

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

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Принимает ConfigurationSetting в качестве входных данных и возвращает ConfigurationSetting, анализируя строку значения.

function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>

Параметры

setting

ConfigurationSetting<string>

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

ConfigurationSetting<SecretReferenceValue>