Compartir vía


Claves y valores

Azure App Configuration almacena los datos de configuración como valores clave. Los valores clave son una representación simple y flexible de la configuración de la aplicación que usan los desarrolladores.

Teclas

Las claves sirven como identificadores para los valores de clave y se usan para almacenar y recuperar los valores correspondientes. Es una práctica habitual la organización de las claves en un espacio de nombres jerárquico mediante un delimitador de caracteres como / o :. Use una convención más adecuada para la aplicación. App Configuration trata las claves en su conjunto. No analiza las claves para averiguar cómo se estructuran sus nombres ni aplica ninguna regla a ellas.

Este es un ejemplo de nombres de claves, que están estructurados en una jerarquía basada en servicios de componentes:

    AppName:Service1:ApiEndpoint
    AppName:Service2:ApiEndpoint

El uso de datos de configuración dentro de los marcos de las aplicaciones puede dictar esquemas de nomenclatura específicos para las claves y los valores. Por ejemplo, el marco de trabajo de Spring Cloud de Java define los recursos Environment que suministran la configuración a una aplicación de Spring. Estos recursos están parametrizados mediante variables entre las que se incluyen el nombre de la aplicación y el perfil. Las claves de los datos de configuración relacionadas con Spring Cloud empiezan normalmente por estos dos elementos, separados por un delimitador.

Las claves almacenadas en App Configuration distinguen entre mayúsculas y minúsculas y son cadenas basadas en Unicode. Las claves app1 y App1 se consideran diferentes en un almacén de App Configuration. Téngalo en cuenta al utilizar las opciones de configuración en una aplicación ya que algunos marcos de trabajo administran las claves de configuración sin hacer distinción entre mayúsculas y minúsculas. No se recomienda el uso de mayúsculas y minúsculas para diferenciar las claves.

Puede usar cualquier carácter unicode en nombres de clave, excepto para %. Un nombre de clave no puede ser . o .. tampoco. Hay un límite de tamaño combinado de 10 KB en un valor de clave. Este límite incluye todos los caracteres de la clave, su valor y todos los atributos opcionales asociados. Dentro de este límite, puede tener muchos niveles jerárquicos para las claves.

Diseño de espacios de nombres de clave

Se usan dos enfoques generales para asignar nombres a las claves para los datos de configuración: planos o jerárquicos. Desde el punto de vista del uso de la aplicación, estos métodos son similares, pero la nomenclatura jerárquica ofrece varias ventajas:

  • Más fácil de leer. Los delimitadores de un nombre de clave jerárquica funcionan como espacios en una oración. También proporcionan saltos naturales entre palabras.
  • Más fácil de administrar. Una jerarquía de nombres de clave representa grupos lógicos de datos de configuración.
  • Más fácil de usar. Es más sencillo escribir una consulta que coincida con las claves de una estructura jerárquica y recupera solo una parte de los datos de configuración. Además, muchos marcos de programación más recientes tienen compatibilidad nativa con datos de configuración jerárquicos, de modo que la aplicación pueda usar conjuntos específicos de configuración.

Puede organizar las claves de App Configuration jerárquicamente de muchas maneras. Piense en claves como URI. Cada clave jerárquica es una ruta de acceso de recurso compuesta por uno o varios componentes unidos por delimitadores. Elija qué carácter usar como delimitador en función de lo que necesite la aplicación, el lenguaje de programación o el marco de trabajo. Use varios delimitadores para distintas claves en App Configuration.

Claves de etiqueta

Los valores de clave de App Configuration pueden tener un atributo de etiqueta. Las etiquetas se utilizan para diferenciar los pares clave-valor con la misma clave. Una clave app1 con las etiquetas A y B forma dos claves independientes en un almacén de App Configuration. De forma predeterminada, una clave y un valor no tienen etiqueta. Para hacer referencia de forma explícita a una clave y un valor sin etiqueta, use \0 (URL codificada como %00).

La etiqueta proporciona una manera cómoda de crear variantes de una clave. Un uso común de etiquetas es especificar varios entornos para la misma clave:

    Key = AppName:DbEndpoint & Label = Test
    Key = AppName:DbEndpoint & Label = Staging
    Key = AppName:DbEndpoint & Label = Production

Versiones de claves y valores

Use etiquetas como una manera de crear varias versiones de un valor de clave. Por ejemplo, puede escribir un número de versión de la aplicación o un identificador de confirmación de Git en etiquetas para identificar los valores de clave asociados a una compilación de software determinada.

Nota:

Si busca versiones modificadas, App Configuration conserva todos los cambios de una clave y un valor que se han producido en el último período de tiempo determinado de manera automática. Para obtener más información, consulte Instantánea de un momento dado.

Consulta de claves y valores

Cada par clave-valor se identifica de forma exclusiva mediante su clave más una etiqueta que puede ser \0. Para consultar claves y valores de un almacén de App Configuration, especifique un patrón. El almacén de App Configuration devuelve todos los pares clave-valor que coinciden con el patrón, incluidos sus valores y atributos correspondientes. Use los siguientes patrones clave en las llamadas api REST a App Configuration:

Clave Descripción
key se omite o key=* Coincide con todas las claves.
key=abc Coincide exactamente con el nombre abc de clave.
key=abc* Coincide con los nombres de clave que empiezan por abc.
key=abc,xyz Coincide con los nombres clave abc o xyz. Limitado a cinco CSV.

También puede incluir los siguientes patrones de etiqueta:

Etiqueta Descripción
label se omite o label=* Coincide con cualquier etiqueta, que incluye \0.
label=%00 Coincide con la etiqueta \0.
label=1.0.0 Coincide exactamente con la etiqueta 1.0.0.
label=1.0.* Coincide con las etiquetas que empiezan por 1.0..
label=%00,1.0.0 Coincide con etiquetas \0 o 1.0.0, limitado a cinco CSV.

Nota:

*, ,y \ son caracteres reservados en las consultas. Si se usa un carácter reservado en los nombres o las etiquetas de las claves, debe aplicarle escape mediante \{Reserved Character} en las consultas.

Valores

Los valores asignados a las claves también son cadenas unicode. Puede usar todos los caracteres unicode para los valores.

Uso de tipo de contenido

Cada clave-valor de App Configuration tiene un atributo de tipo de contenido. Opcionalmente, puede usar este atributo para almacenar información sobre el tipo de valor en un valor clave que ayude a la aplicación a procesarlo correctamente. Puede usar cualquier formato para el tipo de contenido. App Configuration usa tipos de medios (también conocidos como tipos MIME) para tipos de datos integrados, como marcas de características, referencias de Key Vault y valores de clave JSON.

Pasos siguientes