@azure/app-configuration package
Clases
AppConfigurationClient |
Cliente para el servicio Azure App Configuration. |
Interfaces
AddConfigurationSettingOptions |
Opciones usadas al agregar configurationSetting. |
AddConfigurationSettingResponse |
Respuesta de la adición de un objeto ConfigurationSetting. |
AppConfigurationClientOptions |
Proporciona opciones de configuración para AppConfigurationClient. |
ConfigurationSettingId |
Campos que identifican de forma única una configuración |
ConfigurationSettingsFilter |
Habilita el filtrado de pares clave-valor. |
ConfigurationSnapshot |
Los detalles de la instantánea incluyen el nombre, los filtros, expiresOn, sizeInBytes, status, itemCount, etc. |
CreateSnapshotOptions |
Opciones usadas al crear una instantánea. |
CreateSnapshotResponse |
Respuesta de la actualización de una instantánea. |
DeleteConfigurationSettingOptions |
Opciones para eliminar un objeto ConfigurationSetting. |
DeleteConfigurationSettingResponse |
Respuesta de la eliminación de un objeto ConfigurationSetting. |
EtagEntity |
Entidad con etag. |
FeatureFlagValue |
Valor de una marca de característica |
GetConfigurationHeaders |
Encabezados de obtención de configurationSetting. |
GetConfigurationSettingOptions |
Opciones para obtener configurationSetting. |
GetConfigurationSettingResponse |
Respuesta de la recuperación de configurationSetting. |
GetSnapshotOptions |
Opciones usadas al obtener una instantánea. |
GetSnapshotResponse |
Respuesta de la obtención de una instantánea. |
HttpOnlyIfChangedField |
Opciones usadas para proporcionar una coincidencia if-none para una solicitud HTTP |
HttpOnlyIfUnchangedField |
Opciones usadas para proporcionar una coincidencia if-match para una solicitud HTTP |
HttpResponseField |
Información relacionada con la respuesta HTTP: encabezados y cuerpo sin procesar. |
HttpResponseFields |
Campos que se levantan desde el campo _response del objeto Se usa en casos en los que los campos de respuesta HTTP individuales son importantes para que el usuario los use en casos de uso común, como el control de códigos de estado HTTP 204 o 304. |
ListConfigurationSettingPage |
Página de opciones de configuración y la respuesta HTTP correspondiente |
ListConfigurationSettingsForSnapshotOptions |
Opciones comunes para las API de estilo "list" en AppConfig usadas para especificar caracteres comodín, así como el encabezado de fecha y hora de aceptación. |
ListConfigurationSettingsOptions |
Opciones de listConfigurationSettings que permiten filtrar en función de claves, etiquetas y otros campos.
También proporciona |
ListRevisionsOptions |
Opciones de listRevisions que permiten filtrar en función de claves, etiquetas y otros campos.
También proporciona |
ListRevisionsPage |
Página de opciones de configuración y la respuesta HTTP correspondiente |
ListSettingsOptions |
Opciones comunes para las API de estilo "list" en AppConfig usadas para especificar caracteres comodín, así como el encabezado de fecha y hora de aceptación. |
ListSnapshots |
Opciones comunes para las API de estilo "list" en AppConfig usadas para especificar caracteres comodín, así como el encabezado de fecha y hora de aceptación. |
ListSnapshotsOptions |
Opciones de listConfigurationSettings que permiten filtrar en función de claves, etiquetas y otros campos.
También proporciona |
ListSnapshotsPage |
Página de opciones de configuración y la respuesta HTTP correspondiente |
OptionalFields |
Se usa cuando la API admite la devolución selectiva de campos. |
OptionalSnapshotFields |
Se usa cuando la API admite la devolución selectiva de campos. |
PageSettings |
Interfaz que realiza un seguimiento de la configuración de la iteración paginada |
RetryOptions |
Opciones que controlan cómo reintentar solicitudes con error. |
SecretReferenceValue |
Campos necesarios para actualizar o crear una nueva referencia de secreto. |
SetConfigurationSettingOptions |
Opciones usadas al guardar configurationSetting. |
SetConfigurationSettingResponse |
Respuesta de la configuración de configurationSetting. |
SetReadOnlyOptions |
Opciones para setReadOnly |
SetReadOnlyResponse |
Respuesta al establecer un valor en de solo lectura. |
SnapshotInfo |
Campos que identifican de forma única una instantánea |
SnapshotResponse |
Respuesta de la adición de una instantánea. |
SyncTokenHeaderField |
Campo de encabezado de token de sincronización |
UpdateSnapshotOptions |
Opciones usadas al actualizar una instantánea. |
UpdateSnapshotResponse |
Respuesta de la actualización de una instantánea. |
Alias de tipos
AddConfigurationSettingParam |
Parámetros para agregar una nueva configuración |
ConfigurationSetting |
Valor de configuración con metadatos adicionales del servidor, que indica su etag, si actualmente es readOnly y cuándo se modificó por última vez. |
ConfigurationSettingParam |
Campos necesarios para actualizar o crear una nueva configuración |
ConfigurationSettingResponse |
Respuesta base estándar para obtener, eliminar o actualizar una configuración |
ConfigurationSnapshotStatus |
Define valores para ConfigurationSnapshotStatus. Valores conocidos admitidos por el servicioProvisioning |
SetConfigurationSettingParam |
Parámetros para crear o actualizar una nueva configuración |
SnapshotComposition |
Define valores para SnapshotComposition. Valores conocidos admitidos por el serviciokey |
Enumeraciones
KnownConfigurationSnapshotStatus |
Valores conocidos de ConfigurationSnapshotStatus que acepta el servicio. |
KnownSnapshotComposition |
Valores conocidos de SnapshotComposition que acepta el servicio. |
Funciones
is |
Le permite saber si ConfigurationSetting es una marca de característica. [Comprueba si el tipo de contenido es featureFlagContentType |
is |
Le permite saber si ConfigurationSetting es una referencia secreta. [Comprueba si el tipo de contenido es secretReferenceContentType |
parse |
Toma ConfigurationSetting como entrada y devuelve ConfigurationSetting mediante el análisis de la cadena de valor. |
parse |
Toma ConfigurationSetting como entrada y devuelve ConfigurationSetting mediante el análisis de la cadena de valor. |
Detalles de la función
isFeatureFlag(ConfigurationSetting<string>)
Le permite saber si ConfigurationSetting es una marca de característica.
[Comprueba si el tipo de contenido es featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"
]
function isFeatureFlag(setting: ConfigurationSetting<string>): setting
Parámetros
- setting
-
ConfigurationSetting<string>
Devoluciones
setting
isSecretReference(ConfigurationSetting<string>)
Le permite saber si ConfigurationSetting es una referencia secreta.
[Comprueba si el tipo de contenido es secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"
]
function isSecretReference(setting: ConfigurationSetting<string>): setting
Parámetros
- setting
-
ConfigurationSetting<string>
Devoluciones
setting
parseFeatureFlag(ConfigurationSetting<string>)
Toma ConfigurationSetting como entrada y devuelve ConfigurationSetting mediante el análisis de la cadena de valor.
function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>
Parámetros
- setting
-
ConfigurationSetting<string>
Devoluciones
parseSecretReference(ConfigurationSetting<string>)
Toma ConfigurationSetting como entrada y devuelve ConfigurationSetting mediante el análisis de la cadena de valor.
function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>
Parámetros
- setting
-
ConfigurationSetting<string>