Freigeben über

Konfigurieren der Azure Static Web-Apps CLI

  • Artikel

Die Azure Static Web-Apps (SWA) CLI ruft Konfigurationsinformationen für Ihre statische Web-App auf eine von zwei Arten ab:

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

Hinweis

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

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

  • Wenn nur eine einzelne Konfiguration in der datei swa-cli.config.json vorhanden ist, swa start wird sie standardmäßig verwendet.

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

Beispiel der Konfigurationsdatei

Der folgende Codeausschnitt zeigt das Shape 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 swa start Befehl diese Werte automatisch.

Initialisieren einer Konfigurationsdatei

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

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

swa --config <PATH>

Wenn die Datei nur eine benannte Konfiguration enthält, wird diese Konfiguration standardmäßig 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 oder aktualisierungen zu verwenden swa init .

Anzeigen der Konfiguration

Die Static Webs CLI bietet eine --print-config Option, damit Sie Ihre aktuelle Konfiguration überprüfen können.

Hier ist ein Beispiel dafür, wie diese Ausgabe aussieht, wenn sie auf einem neuen Projekt mit Standardeinstellungen ausgeführt wird.

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

Die Ausführung swa --print-config stellt die aktuellen Konfigurationsstandardwerte bereit.

Hinweis

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

Überprüfen der Konfiguration

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