Configurer les paramètres d’application pour Azure Static Web Apps

2023-10-26

Les paramètres d’application contiennent les valeurs de configuration susceptibles de changer, comme les chaînes de connexion de base de données. L’ajout de paramètres d’application vous permet de modifier l’entrée de configuration de votre application, sans avoir à modifier le code de l’application.

Paramètres de l’application :

Sont disponibles en tant que variables d’environnement pour l’API back-end d’une application web statique
Peuvent être utilisés pour stocker les secrets utilisés dans la configuration de l’authentification
Sont chiffrés au repos
Sont copiés dans les environnements intermédiaire et de production
Ne peut contenir que des caractères alphanumériques, . et _

Les paramètres d’application décrits dans cet article s’appliquent uniquement à l’API back-end d’une application Azure Static Web Apps.

Pour configurer les variables d’environnement nécessaires à la génération de votre application web front-end, consultez Configuration de build.

Prérequis

Une application Azure Static Web Apps
Azure CLI : obligatoire si vous utilisez la ligne de commande

Configurer des paramètres d’application d’API pour le développement local

Les API dans Azure Static Web Apps sont fournies par Azure Functions, ce qui vous permet de définir des paramètres d’application dans le fichier local.settings.json lorsque vous exécutez l’application localement. Ce fichier définit les paramètres d’application dans la propriété Values de la configuration.

Remarque

Le fichier local.settings.json est utilisé uniquement pour le développement local. Utilisez le portail Azure pour configurer des paramètres d’application pour la production.

L’exemple suivant local.settings.json montre comment ajouter une valeur pour 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.

Configurer les paramètres de l’application

Vous pouvez configurer les paramètres d’application via le Portail Azure ou avec Azure CLI.

Important

Les paramètres d’application décrits dans cet article s’appliquent uniquement à l’API back-end d’une application Azure Static Web Apps.

Pour configurer les variables d’environnement nécessaires à la génération de votre application web front-end, consultez Configuration de build.

Utilisation du portail Azure

Le portail Azure fournit une interface pour la création, la mise à jour et la suppression des paramètres d’application.

Accédez au portail Azure.
Ouvrez votre application web statique.
Sous la section Paramètres, sélectionnez Variables d’environnement.
Sélectionnez l'environnement pour lequel vous souhaitez créer des variables d'environnement. Vous pouvez créer des variables par environnement. Lorsque vous créez une demande de tirage, les environnements intermédiaires sont automatiquement créés, puis promus en production lorsque vous fusionnez la demande de tirage.
Sélectionnez + Ajouter pour ajouter une nouvelle variable d’environnement.
Entrez vos valeurs dans les zones Nom et Valeur.
Sélectionnez Appliquer.
Sélectionnez une nouvelle fois Appliquer pour enregistrer vos changements.

Utilisation de l’interface de ligne de commande Microsoft Azure

Utilisez la commande az staticwebapp appsettings pour mettre à jour vos paramètres dans Azure.

Dans un terminal ou une ligne de commande, exécutez la commande suivante pour ajouter ou mettre à jour un paramètre nommé message avec la valeur Hello world. Veillez à remplacer l’espace réservé <YOUR_APP_ID> par votre valeur.

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.

Partager via