Konfigurera programinställningar för Azure Static Web Apps

  • Så här gör du

Programinställningar innehåller konfigurationsvärden som kan ändras, till exempel databas niska veze. Genom att lägga till programinställningar kan du ändra konfigurationsindata till din app, utan att behöva ändra programkoden.

Programinställningar:

  • Är tillgängliga som miljövariabler för serverdels-API:et för en statisk webbapp
  • Kan användas för att lagra hemligheter som används i autentiseringskonfigurationen
  • Krypteras i vila
  • Kopieras till mellanlagrings - och produktionsmiljöer
  • Får endast vara alfanumeriska tecken, ., och _

Viktigt!

De programinställningar som beskrivs i den här artikeln gäller endast för serverdels-API:et för en Azure Static Web App.

Information om hur du konfigurerar miljövariabler som krävs för att skapa ditt klientdelswebbprogram finns i Skapa konfiguration.

Förutsättningar

  • Ett Azure Static Web Apps-program
  • Azure CLI krävs om du använder kommandoraden

Konfigurera API-programinställningar för lokal utveckling

API:er i Azure Static Web Apps drivs av Azure Functions, vilket gör att du kan definiera programinställningar i local.settings.json-filen när du kör programmet lokalt. Den här filen definierar programinställningar i Values egenskapen för konfigurationen.

Kommentar

Filen local.settings.json används endast för lokal utveckling. Använd Azure-portalen för att konfigurera programinställningar för produktion.

Följande exempel local.settings.json visar hur du lägger till ett värde för 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.

Konfigurera programinställningar

Du kan konfigurera programinställningar via Azure-portalen eller med Azure CLI.

Använda Azure Portal

Azure-portalen innehåller ett gränssnitt för att skapa, uppdatera och ta bort programinställningar.

  1. Gå till Azure-portalen.

  2. Öppna din statiska webbapp.

  3. Välj Miljövariabler i sidopanelen.

  4. Välj den miljö som du vill skapa miljövariabler till. Du kan skapa variabler per miljö. När du skapar en pull-begäran skapas mellanlagringsmiljöer automatiskt och befordras sedan till produktion när du sammanfogar pull-begäran.

  5. Välj + Lägg till för att lägga till en ny miljövariabel. Skärmbild av miljövariabler för Azure Static Web Apps

  6. Ange ett namn och värde.

  7. Välj OK.

  8. Välj Spara.

Använda Azure CLI

az staticwebapp appsettings Använd kommandot för att uppdatera inställningarna i Azure.

I en terminal eller kommandorad kör du följande kommando för att lägga till eller uppdatera en inställning med namnet message med värdet Hello world. Ersätt platshållaren <YOUR_APP_ID> med ditt värde.

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.

Relaterat innehåll