Bewerken

Toepassingsinstellingen configureren voor Azure Static Web Apps

  • Uitleg

Toepassingsinstellingen bevatten configuratiewaarden die kunnen worden gewijzigd, zoals database-verbindingsreeks s. Door toepassingsinstellingen toe te voegen, kunt u de configuratie-invoer in uw app wijzigen zonder dat u de toepassingscode hoeft te wijzigen.

Toepassingsinstellingen:

  • Zijn beschikbaar als omgevingsvariabelen voor de back-end-API van een statische web-app
  • Kan worden gebruikt voor het opslaan van geheimen die worden gebruikt in de verificatieconfiguratie
  • Zijn versleuteld at rest
  • Worden gekopieerd naar faserings - en productieomgevingen
  • Mag alleen alfanumerieke tekens zijn, .en _

Belangrijk

De toepassingsinstellingen die in dit artikel worden beschreven, zijn alleen van toepassing op de back-end-API van een Statische Azure-web-app.

Zie Build-configuratie voor het configureren van omgevingsvariabelen die vereist zijn voor het bouwen van uw front-endwebtoepassing.

Vereisten

  • Een Azure Static Web Apps-toepassing
  • Azure CLI vereist als u de opdrachtregel gebruikt

API-toepassingsinstellingen configureren voor lokale ontwikkeling

API's in Azure Static Web Apps worden mogelijk gemaakt door Azure Functions, waarmee u toepassingsinstellingen in het local.settings.json-bestand kunt definiëren wanneer u de toepassing lokaal uitvoert. Dit bestand definieert toepassingsinstellingen in de Values eigenschap van de configuratie.

Notitie

Het bestand local.settings.json wordt alleen gebruikt voor lokale ontwikkeling. Gebruik Azure Portal om toepassingsinstellingen voor productie te configureren.

In het volgende voorbeeld local.settings.json ziet u hoe u een waarde toevoegt voor de 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.

Toepassingsinstellingen configureren

U kunt toepassingsinstellingen configureren via Azure Portal of met de Azure CLI.

De Azure-portal gebruiken

Azure Portal biedt een interface voor het maken, bijwerken en verwijderen van toepassingsinstellingen.

  1. Ga naar de Azure Portal.

  2. Open uw statische web-app.

  3. Selecteer Configuratie in de zijbalk.

  4. Selecteer de omgeving waarop u de toepassingsinstellingen wilt toepassen. U kunt toepassingsinstellingen per omgeving configureren. Wanneer u een pull-aanvraag maakt, worden faseringsomgevingen automatisch gemaakt en vervolgens gepromoveerd naar productie wanneer u de pull-aanvraag samenvoegt.

  5. Selecteer + Toevoegen om een nieuwe app-instelling toe te voegen. Schermopname van de configuratieweergave van Azure Static Web Apps

  6. Voer een naam en waarde in.

  7. Selecteer OK.

  8. Selecteer Opslaan.

De Azure CLI gebruiken

Gebruik de az staticwebapp appsettings opdracht om uw instellingen in Azure bij te werken.

Voer in een terminal of opdrachtregel de volgende opdracht uit om een instelling met de naam message toe te voegen of bij te werken met een waarde van Hello world. Zorg ervoor dat u de tijdelijke aanduiding <YOUR_APP_ID> vervangt door uw waarde.

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.

Gerelateerde inhoud