Bearbeiten

Freigeben über

Konfigurieren von Anwendungseinstellungen für Azure Static Web Apps

  • Vorgehensweise

Anwendungseinstellungen enthalten Konfigurationswerte, die sich ggf. ändern können, z. B. Datenbank-Verbindungszeichenfolgen. Indem Sie Anwendungseinstellungen hinzufügen, können Sie die Konfigurationseingabe für Ihre App ändern, ohne dass Sie dafür den Anwendungscode ändern müssen.

Anwendungseinstellungen:

  • Sind als Umgebungsvariablen für die Back-End-API einer statischen Web-App verfügbar.
  • Können zum Speichern von Geheimnissen verwendet werden, die in der Authentifizierungskonfiguration verwendet werden.
  • Sind im Ruhezustand verschlüsselt.
  • Werden in Staging- und Produktionsumgebungen kopiert.
  • Dürfen nur alphanumerische Zeichen, . und _ enthalten.

Wichtig

Die in diesem Artikel beschriebenen Anwendungseinstellungen gelten nur für die Back-End-API einer statischen Azure-Web-App.

Informationen zum Konfigurieren von Umgebungsvariablen, die zum Erstellen Ihrer Front-End-Webanwendung erforderlich sind, finden Sie unter Buildkonfiguration.

Voraussetzungen

  • Eine Azure Static Web Apps-Anwendung
  • Azure CLI: Erforderlich, wenn Sie die Befehlszeile verwenden.

Konfigurieren von API-Anwendungseinstellungen für die lokale Entwicklung

APIs in Azure Static Web Apps basieren auf Azure Functions. Dies ermöglicht es Ihnen, Anwendungseinstellungen in der Datei local.settings.json zu definieren, wenn Sie die Anwendung lokal ausführen. In dieser Datei sind die Anwendungseinstellungen in der Eigenschaft Values der Konfiguration definiert.

Hinweis

Die Datei local.settings.json wird nur für die lokale Entwicklung verwendet. Verwenden Sie das Azure-Portal, um Anwendungseinstellungen für die Produktionsumgebung zu konfigurieren.

Mit der unten angegebenen Beispieldatei local.settings.json wird veranschaulicht, wie Sie einen Wert für DATABASE_CONNECTION_STRING hinzufügen.

{
  "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.

Konfigurieren von Anwendungseinstellungen

Sie können Anwendungseinstellungen über das Azure-Portal oder mit der Azure CLI konfigurieren.

Verwenden des Azure-Portals

Das Azure-Portal verfügt über eine Oberfläche zum Erstellen, Aktualisieren und Löschen von Anwendungseinstellungen.

  1. Öffnen Sie das Azure-Portal.

  2. Öffnen Sie Ihre statische Web-App.

  3. Wählen Sie Umgebungsvariablen in der Randleiste aus.

  4. Wählen Sie die Umgebung aus, für die Sie Umgebungsvariablen erstellen möchten. Sie können Variablen pro Umgebung erstellen. Wenn Sie einen Pull Request erstellen, werden Stagingumgebungen automatisch erzeugt und dann in die Produktion hochgestuft, wenn Sie den Pull Request zusammenführen.

  5. Wählen Sie + Hinzufügen aus, um eine neue Umgebungsvariable hinzuzufügen. Screenshot der Azure Static Web Apps-Umgebungsvariablenansicht

  6. Geben Sie einen Namen und Wert ein.

  7. Wählen Sie OK aus.

  8. Wählen Sie Speichern.

Verwenden der Azure-Befehlszeilenschnittstelle

Mit dem Befehl az staticwebapp appsettings können Sie Ihre Einstellungen in Azure aktualisieren.

Führen Sie in einem Terminal oder einer Befehlszeile den folgenden Befehl aus, um eine Einstellung namens message mit dem Wert Hello world hinzuzufügen oder zu aktualisieren. Stellen Sie sicher, dass Sie den Platzhalter <YOUR_APP_ID> durch Ihren Wert ersetzen.

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.

Zugehöriger Inhalt