Freigeben über

Konfigurieren der Azure Static Web Apps CLI

  • Artikel

Wichtig

Um die Sicherheit von Bereitstellungen aus der Static Web Apps CLI zu verbessern, wurde ein Breaking Change eingeführt, der es erforderlich macht, bis zum 15. Januar 2025 ein Upgrade auf die neueste Version (2.0.2) der Static Web Apps CLI durchzuführen.

Die Azure Static Web Apps CLI (SWA CLI) ruft Konfigurationsinformationen zu Ihrer statischen Web-App auf eine von zwei Arten ab:

  • CLI-Optionen (zur Laufzeit übergeben)
  • Eine CLI-Konfigurationsdatei namens swa-cli.config.json

Hinweis

Standardmäßig sucht die SWA CLI im aktuellen Verzeichnis nach einer Konfigurationsdatei namens swa-cli.config.json.

Die Konfigurationsdatei kann mehrere Konfigurationen enthalten, die jeweils durch einen eindeutigen Konfigurationsnamen identifiziert werden.

  • Wenn in der Datei swa-cli.config.json nur eine Konfiguration enthalten ist, wird sie standardmäßig von swa start verwendet.

  • Wenn Optionen aus einer Konfigurationsdatei geladen werden, werden Befehlszeilenoptionen ignoriert.

Beispiel der Konfigurationsdatei

Der folgende Codeschnipsel zeigt das Format der Konfigurationsdatei.

{
  "configurations": {
    "app": {
      "appDevserverUrl": "http://localhost:3000",
      "apiLocation": "api",
      "run": "npm run start",
      "swaConfigLocation": "./my-app-source"
    }
  }
}

Wenn Sie nur über einen Konfigurationsabschnitt verfügen (wie in diesem Beispiel gezeigt), verwendet der Befehl swa start automatisch diese Werte.

Initialisieren einer Konfigurationsdatei

Sie können Ihre Konfigurationsdatei mit dem Befehl swa init initialisieren. Wenn Sie den Befehl für ein vorhandenes Projekt ausführen, versucht swa init, die Konfigurationseinstellungen für Sie zu erraten.

Standardmäßig erstellt der Prozess diese Einstellungen in einer Datei swa-cli.config.json im aktuellen Arbeitsverzeichnis Ihres Projekts. Dieses Verzeichnis ist der Standarddateiname und -speicherort, den swa bei der Suche nach Projektkonfigurationswerten verwendet.

swa --config <PATH>

Wenn die Datei nur eine benannte Konfiguration enthält, wird standardmäßig diese Konfiguration verwendet. Wenn mehrere Konfigurationen definiert sind, übergeben Sie den gewünschten Konfigurationsnamen als Option.

swa --<CONFIG_NAME>

Wenn die Konfigurationsdateioption verwendet wird, werden die Einstellungen im JSON-Format gespeichert. Nach der Erstellung können Sie die Datei manuell bearbeiten, um Einstellungen zu aktualisieren. Sie können für Ihre Änderungen auch swa init verwenden.

Anzeigen der Konfiguration

Die Static Web Apps CLI bietet eine Option --print-config, mit der Sie Ihre aktuelle Konfiguration überprüfen können.

Das folgende Beispiel zeigt diese Ausgabe, wenn die Ausführung in einem neuen Projekt mit Standardeinstellungen erfolgt.

swa --print-config

Options:
 - port: 4280
 - host: localhost
 - apiPort: 7071
 - appLocation: .
 - apiLocation: <undefined>
 - outputLocation: .
 - swaConfigLocation: <undefined>
 - ssl: false
 - sslCert: <undefined>
 - sslKey: <undefined>
 - appBuildCommand: <undefined>
 - apiBuildCommand: <undefined>
 - run: <undefined>
 - verbose: log
 - serverTimeout: 60
 - open: false
 - githubActionWorkflowLocation: <undefined>
 - env: preview
 - appName: <undefined>
 - dryRun: false
 - subscriptionId: <undefined>
 - resourceGroupName: <undefined>
 - tenantId: <undefined>
 - clientId: <undefined>
 - clientSecret: <undefined>
 - useKeychain: true
 - clearCredentials: false
 - config: swa-cli.config.json
 - printConfig: true

Bei der Ausführung von swa --print-config werden die aktuellen Konfigurationsstandardwerte bereitgestellt.

Hinweis

Wenn für das Projekt noch keine Konfigurationsdatei definiert wurde, löst dies automatisch den swa init-Workflow aus, damit Sie eine Datei erstellen können.

Überprüfen der Konfiguration

Sie können die Datei swa-cli.config.json anhand des folgenden Schemas überprüfen: https://aka.ms/azure/static-web-apps-cli/schema