Delen via

De Azure Static Web Apps CLI configureren

  • Artikel

Belangrijk

Om de beveiliging van implementaties van de Static Web Apps CLI te verbeteren, is er een belangrijke wijziging geïntroduceerd waarvoor u moet upgraden naar de nieuwste versie (2.0.2) van de Static Web Apps CLI op 15 januari 2025.

De CLI van Azure Static Web Apps (SWA) haalt op twee manieren configuratiegegevens voor uw statische web-app op:

  • CLI-opties (doorgegeven tijdens runtime)
  • Een CLI-configuratiebestand met de naam swa-cli.config.json

Notitie

Standaard zoekt de SWA CLI naar een configuratiebestand met de naam swa-cli.config.json in de huidige map.

Het configuratiebestand kan meerdere configuraties bevatten, die elk worden geïdentificeerd door een unieke configuratienaam.

  • Als er slechts één configuratie aanwezig is in het swa-cli.config.json-bestand , swa start wordt deze standaard gebruikt.

  • Als opties worden geladen vanuit een configuratiebestand, worden opdrachtregelopties genegeerd.

Voorbeeld van configuratiebestand

Het volgende codefragment toont de shape van het configuratiebestand.

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

Wanneer u slechts één configuratiesectie hebt, zoals in dit voorbeeld wordt weergegeven, gebruikt de swa start opdracht deze waarden automatisch.

Een configuratiebestand initialiseren

U kunt uw configuratiebestand initialiseren met de swa init opdracht. Als u de opdracht uitvoert voor een bestaand project, swa init probeert u de configuratie-instellingen voor u te raden.

Standaard maakt het proces deze instellingen in een swa-cli.config.json in de huidige werkmap van uw project. Deze map is de standaardbestandsnaam en -locatie die wordt gebruikt bij swa het zoeken naar projectconfiguratiewaarden.

swa --config <PATH>

Als het bestand slechts één benoemde configuratie bevat, wordt die configuratie standaard gebruikt. Als er meerdere configuraties zijn gedefinieerd, geeft u de gewenste configuratienaam door als optie.

swa --<CONFIG_NAME>

Wanneer de optie voor het configuratiebestand wordt gebruikt, worden de instellingen opgeslagen in JSON-indeling. Nadat u het bestand hebt gemaakt, kunt u het bestand handmatig bewerken om instellingen bij te werken of swa init om updates te maken.

Configuratie weergeven

De STATIC Webs CLI biedt een --print-config optie, zodat u uw huidige configuratie kunt controleren.

Hier volgt een voorbeeld van hoe deze uitvoer eruitziet wanneer deze wordt uitgevoerd op een nieuw project met standaardinstellingen.

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

De huidige configuratiestandaarden worden uitgevoerd swa --print-config .

Notitie

Als het project nog geen configuratiebestand heeft gedefinieerd, wordt de swa init werkstroom automatisch geactiveerd om er een te maken.

Configuratie valideren

U kunt het swa-cli.config.json bestand valideren op basis van het volgende schema: https://aka.ms/azure/static-web-apps-cli/schema