Editatu

Partekatu honen bidez:

Configuración de las opciones de la aplicación para Azure Static Web Apps

  • Nola egin hauek

La configuración de la aplicación almacena las opciones de configuración que pueden cambiar, como las cadenas de conexión de base de datos. Al agregar la configuración de la aplicación, puede modificar las entradas de la configuración en la aplicación sin necesidad de cambiar el código de la aplicación.

Las opciones de la aplicación:

  • Están disponibles como variables de entorno para la API de back-end de una aplicación web estática
  • Se pueden utilizar para almacenar secretos usados en la configuración de autenticación
  • se cifran en reposo;
  • se copian en los entornos de ensayo y producción;
  • solo pueden usar caracteres alfanuméricos, . y _.

Importante

La configuración de la aplicación descrita en este artículo solo se aplica a la API de back-end de una aplicación de Azure Static Web App.

Para configurar las variables de entorno necesarias para compilar la aplicación web de front-end, vea Configuración de compilación.

Requisitos previos

  • Una aplicación de Azure Static Web Apps
  • CLI de Azure: necesaria si usa la línea de comandos

Configuración de la aplicación de API para el desarrollo local

Las API de Azure Static Web Apps están basadas en Azure Functions, lo que permite definir la configuración de la aplicación en el archivo local.settings.json cuando la aplicación se ejecuta de forma local. Este archivo define la configuración de la aplicación en la propiedad Values de la configuración.

Nota:

El archivo local.settings.json solo se usa para el desarrollo local. Use Azure Portal para configurar las opciones de la aplicación para producción.

En el ejemplo siguiente, local.settings.json muestra cómo agregar un valor para DATABASE_CONNECTION_STRING.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "DATABASE_CONNECTION_STRING": "<YOUR_DATABASE_CONNECTION_STRING>"
  }
}

Settings defined in the Values property can be referenced from code as environment variables. In Node.js functions, for example, they're available in the process.env object.

const connectionString = process.env.DATABASE_CONNECTION_STRING;

The local.settings.json file isn't tracked by the GitHub repository because sensitive information, like database connection strings, are often included in the file. Since the local settings remain on your machine, you need to manually configure your settings in Azure.

Generally, configuring your settings is done infrequently, and isn't required with every build.

Configuración de la aplicación

Puede configurar las opciones de la aplicación mediante Azure Portal o con la CLI de Azure.

Uso de Azure Portal

Azure Portal proporciona una interfaz para crear, actualizar y eliminar la configuración de la aplicación.

  1. Vaya a Azure Portal.

  2. Abra la aplicación web estática.

  3. Seleccione Variables de entorno en la barra lateral.

  4. Seleccione el entorno para el que quiere crear variables de entorno. Puede crear variables por entorno. Al crear una solicitud de incorporación de cambios, los entornos de ensayo se crean automáticamente y, a continuación, se promueven a producción al combinar la solicitud de incorporación de cambios.

  5. Seleccione + Agregar para agregar una nueva variable de entorno. Captura de pantalla de la vista de variables de entorno de Azure Static Web Apps

  6. Proporcione un nombre y un valor.

  7. Seleccione Aceptar.

  8. Seleccione Guardar.

Uso de la CLI de Azure

Use el comando az staticwebapp appsettings para actualizar la configuración en Azure.

En un terminal o línea de comandos, ejecute el siguiente comando para agregar o actualizar una configuración denominada message con un valor de Hello world. Asegúrese de reemplazar el marcador de posición <YOUR_APP_ID> por su valor.

az staticwebapp appsettings set --name <YOUR_APP_ID> --setting-names "message=Hello world"

Tip

You can add or update multiple settings by passing multiple name-value pairs to --setting-names.

View application settings with the Azure CLI

In a terminal or command line, execute the following command. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings list --name <YOUR_APP_ID>

Delete application settings with the Azure CLI

In a terminal or command line, execute the following command to delete a setting named message. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings delete --name <YOUR_APP_ID> --setting-names "message"

Tip

Delete multiple settings by passing multiple setting names to --setting-names.

Contenido relacionado