AppConfigurationClient class

Paquete:

@azure/app-configuration

Cliente del servicio Azure App Configuration.

Constructores

AppConfigurationClient(string, AppConfigurationClientOptions)	Inicializa una nueva instancia de la clase AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Inicializa una nueva instancia de la clase AppConfigurationClient mediante un TokenCredential.

Métodos

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Agregue una configuración al servicio Azure App Configuration, con errores si ya existe. Uso de ejemplo: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Archivar una instantánea lista Uso de ejemplo: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Comienza a crear una instantánea para el servicio Azure App Configuration, se produce un error si ya existe.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Comienza a crear una instantánea para el servicio Azure App Configuration, espera hasta que se realiza, se produce un error si ya existe.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Eliminación de una configuración del servicio Azure App Configuration Uso de ejemplo: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Obtiene una configuración del servicio Azure App Configuration. Código de ejemplo: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Obtención de una instantánea del servicio Azure App Configuration Uso de ejemplo: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Muestra la configuración del servicio Azure App Configuration, filtrado opcionalmente por nombres de clave, etiquetas y acepta datetime. Código de ejemplo: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Muestra la configuración del servicio Azure App Configuration para las instantáneas basadas en el nombre, filtrada opcionalmente por nombres de clave, etiquetas y acepta datetime. Código de ejemplo: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Obtención de una lista de etiquetas del servicio Azure App Configuration Código de ejemplo: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Enumera las revisiones de un conjunto de claves, filtradas opcionalmente por nombres de clave, etiquetas y aceptar datetime. Código de ejemplo: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Enumeración de todas las instantáneas del servicio Azure App Configuration Uso de ejemplo: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Recuperar una instantánea archivada de nuevo al estado listo Uso de ejemplo: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Establece el valor de una clave en el servicio Azure App Configuration, lo que permite una etag opcional.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Establece o borra el estado de solo lectura de una clave.
updateSyncToken(string)	Agrega un token de sincronización externo para asegurarse de que las solicitudes de servicio reciben valores up-to-date.

Detalles del constructor

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicializa una nueva instancia de la clase AppConfigurationClient.

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

Parámetros

connectionString

string

Cadena de conexión necesaria para que un cliente se conecte a Azure.

options

AppConfigurationClientOptions

Opciones de AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Inicializa una nueva instancia de la clase AppConfigurationClient mediante un TokenCredential.

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

Parámetros

endpoint

string

Punto de conexión del servicio App Configuration (por ejemplo, https://sample.azconfig.io).

tokenCredential

TokenCredential

Objeto que implementa la interfaz TokenCredential utilizada para autenticar las solicitudes al servicio. Use el paquete @azure/identity para crear una credencial que se adapte a sus necesidades.

options

AppConfigurationClientOptions

Opciones de AppConfigurationClient.

Detalles del método

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

Agregue una configuración al servicio Azure App Configuration, con errores si ya existe.

Uso de ejemplo:

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

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

Parámetros

configurationSetting

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

Un valor de configuración.

options

AddConfigurationSettingOptions

Parámetros opcionales para la solicitud.

Devoluciones

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Archivar una instantánea lista

Uso de ejemplo:

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

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

Parámetros

name

string

Nombre de la instantánea.

options

UpdateSnapshotOptions

Parámetros opcionales para la solicitud.

Devoluciones

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Comienza a crear una instantánea para el servicio Azure App Configuration, se produce un error si ya existe.

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

Parámetros

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Devoluciones

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Comienza a crear una instantánea para el servicio Azure App Configuration, espera hasta que se realiza, se produce un error si ya existe.

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

Parámetros

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Devoluciones

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Eliminación de una configuración del servicio Azure App Configuration

Uso de ejemplo:

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

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

Parámetros

id

ConfigurationSettingId

Identificador de la configuración que se va a eliminar.

options

DeleteConfigurationSettingOptions

Parámetros opcionales para la solicitud (por ejemplo: etag, label)

Devoluciones

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Obtiene una configuración del servicio Azure App Configuration.

Código de ejemplo:

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

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

Parámetros

id

ConfigurationSettingId

Identificador de la configuración que se va a obtener.

options

GetConfigurationSettingOptions

Parámetros opcionales para la solicitud.

Devoluciones

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Obtención de una instantánea del servicio Azure App Configuration

Uso de ejemplo:

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

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

Parámetros

name

string

Nombre de la instantánea.

options

GetSnapshotOptions

Parámetros opcionales para la solicitud.

Devoluciones

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Muestra la configuración del servicio Azure App Configuration, filtrado opcionalmente por nombres de clave, etiquetas y acepta datetime.

Código de ejemplo:

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

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

Parámetros

options

ListConfigurationSettingsOptions

Parámetros opcionales para la solicitud.

Devoluciones

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Muestra la configuración del servicio Azure App Configuration para las instantáneas basadas en el nombre, filtrada opcionalmente por nombres de clave, etiquetas y acepta datetime.

Código de ejemplo:

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

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

Parámetros

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Parámetros opcionales para la solicitud.

Devoluciones

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Obtención de una lista de etiquetas del servicio Azure App Configuration

Código de ejemplo:

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

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

Parámetros

options

ListLabelsOptions

Parámetros opcionales para la solicitud.

Devoluciones

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Enumera las revisiones de un conjunto de claves, filtradas opcionalmente por nombres de clave, etiquetas y aceptar datetime.

Código de ejemplo:

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

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

Parámetros

options

ListRevisionsOptions

Parámetros opcionales para la solicitud.

Devoluciones

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Enumeración de todas las instantáneas del servicio Azure App Configuration

Uso de ejemplo:

const result = await client.listSnapshots();

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

Parámetros

options

ListSnapshotsOptions

Parámetros opcionales para la solicitud.

Devoluciones

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Recuperar una instantánea archivada de nuevo al estado listo

Uso de ejemplo:

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

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

Parámetros

name

string

Nombre de la instantánea.

options

UpdateSnapshotOptions

Parámetros opcionales para la solicitud.

Devoluciones

Promise<UpdateSnapshotResponse>

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

Establece el valor de una clave en el servicio Azure App Configuration, lo que permite una etag opcional.

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

Parámetros

configurationSetting

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

Valor de configuración.

options

SetConfigurationSettingOptions

Parámetros opcionales para la solicitud.

Código de ejemplo:

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

Devoluciones

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Establece o borra el estado de solo lectura de una clave.

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

Parámetros

id

ConfigurationSettingId

Identificador de la configuración que se va a modificar.

readOnly

boolean

options

SetReadOnlyOptions

Devoluciones

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Agrega un token de sincronización externo para asegurarse de que las solicitudes de servicio reciben valores up-to-date.

function updateSyncToken(syncToken: string)

Parámetros

syncToken

string

Valor del token de sincronización.