Azure Static Web Apps CLI-referencia

Az Azure Static Web Apps CLI-parancsainak referenciája.

Commands

Command	Description	Típus	Status
swa login	Bejelentkezik az Azure-ba.	SWA Core	GA
swa init	Új Azure Static Web Apps-projektet konfigurál.	SWA Core	GA
swa build	Létrehozza az alkalmazást. Ha Node.js alkalmazással rendelkezik, először a függőségeket telepíti.	SWA Core	GA
swa start	Indítsa el az Azure Static Web Apps emulátort egy címtárból, vagy kössön egy futó fejlesztői kiszolgálóhoz.	SWA Core	GA
swa deploy	Az aktuális projekt üzembe helyezése az Azure Static Web Appsben.	SWA Core	GA
swa db	Statikus Web Apps-adatbáziskapcsolatok konfigurációjának létrehozása és szerkesztése.	SWA Core	GA

Global Parameters

Parameter	Summary
--version, -v	A verziószám megjelenítése.
--részletes, --V [szint]	Részletes kimenet engedélyezése. A szintértékek a következők: `silly`, `infolog` (alapértelmezett) és `silent`.
--config, -c [elérési út]	A swa-cli.config.json fájl elérési útja.
--config-name, -cn	A parancssori felület által használt konfiguráció.
--print-config, -g	Az összes feloldott beállítás nyomtatása. Az alapértelmezett érték `false`.
--help, -h	Környezetfüggő súgó megjelenítése.

Bejelentkezik az Azure-ba.

Hitelesítés az Azure-ral az Azure Static Web Apps üzembehelyezési jogkivonatának lekéréséhez a swa deploy parancs használatával.

Syntax

swa login
          [--subscription-id]
          [--resource-group]
          [--tenant-id]
          [--client-id]
          [--client-secret]
          [--app-name]
          [--clear-credentials]
          [--use-keychain]
          [--no-use-keychain]

Examples

1. példa: Interaktív bejelentkezés az Azure-ba

swa login

Parameters

--subscription-id, -S

A projekt által használt Azure-előfizetés-azonosító. Az alapértelmezett érték a process.env.AZURE_SUBSCRIPTION_ID.

--resource-group, -R

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--tenant-id, -T

Azure-bérlőazonosító. Az alapértelmezett érték a process.env.AZURE_TENANT_ID.

--client-id, -C

Azure-ügyfélazonosító.

--client-secret, -CS

Azure-ügyfél titkos kódja.

--app-name, -n

Az Azure Static Web Apps-alkalmazás neve.

--clear-credentials -cc

A bejelentkezés előtt törölje a megőrzött hitelesítő adatokat. Az alapértelmezett érték a false.

--use-keychain, -u

Az állandó hitelesítő adatokhoz használja az operációs rendszer natív kulcskarikát. Az alapértelmezett érték a true.

--no-use-keychain, -nu

Tiltsa le az operációs rendszer natív kulcskarika használatát.

Global Parameters

swa init

Új Azure Static Web Apps-projektet konfigurál.

Konfigurál egy új Azure Static Web Apps-projektet a Static Web Apps parancssori felületével. Az interaktív mód kéri a konfiguráció nevét, észleli a projekt beállításait és a használt keretrendszereket. Ha elkészült, létrejön egy új statikus webalkalmazás, és egy swa-cli.config.json fájl jön létre az aktuális könyvtárban.

Több alkalommal is futtathat swa init különböző konfigurációkat a projekthez. Ezt akkor érdemes megtennie, ha monorepón dolgozik, és különböző projekteket szeretne konfigurálni.

A létrehozott konfigurációs fájl minden, a Static Web Apps parancssori felületével futtatott parancsban használatos. Ha több elnevezett konfigurációval rendelkezik, a pozíció argumentum --config-name vagy beállítás használatával megadhatja, hogy melyik konfigurációt szeretné használni.

Az alábbi példakonfigurációt a init parancs hozza létre:

{
  "$schema": "https://aka.ms/azure/static-web-apps-cli/schema",
  "configurations": {
    "myApp": {
      "appLocation": ".",
      "apiLocation": "api",
      "outputLocation": "dist",
      "appBuildCommand": "npm run build",
      "apiBuildCommand": "npm run build --if-present",
      "run": "npm run dev",
      "appDevserverUrl": "http://localhost:8080"
    }
  }
}

Syntax

swa init
          [--yes]

Examples

1. példa: Új konfiguráció interaktív létrehozása.

swa init

2. példa: Hozzon létre egy új konfigurációt az összes beállítás alapértelmezett értékeivel.

swa init --yes

3. példa: Inicializálja a projektet a swa-cli.config.json fájl "myApp" nevű konfigurációjának használatával.

swa init --config-name myApp

Parameters

--yes, -y

Minden kérdésre igen választ ad, amely letiltja az interaktív módot. Az alapértelmezett érték false.

Global Parameters

swa build

Létrehozza az alkalmazást. Ha Node.js alkalmazással rendelkezik, először a függőségeket telepíti.

Gyakori használati esetek: Az előtér-alkalmazás és az API függőségeinek telepítése és a buildparancsok futtatása mindkettőhöz, csak az előtér- vagy API-projekt létrehozása, ha a másik nem rendelkezik buildelési lépéssel.

Syntax

swa build
          [--app-location]
          [--api-location]
          [--output-location]
          [--app-build-command]
          [--api-build-command]
          [--auto]

Examples

1. példa: Az alkalmazás létrehozása és igény szerint függőségek telepítése.

swa build

2. példa: Az alkalmazás létrehozásának és buildparancsok futtatásának észlelése a függőségek telepítése után.

swa build --auto

3. példa: Az előtérbeli alkalmazás függőségeinek telepítése.

swa build --app-location ./client

4. példa: Használja a swa-cli.config.json nevű `myApp` konfigurációt az előtérbeli alkalmazás létrehozásához.

swa build myApp

Parameters

--app-location, -a

Az előtérbeli alkalmazás forráskódját tartalmazó mappa. Az alapértelmezett érték ..

--api-location, -i

Az API-alkalmazás forráskódját tartalmazó mappa.

--output-location, -O

Az előtérbeli alkalmazás beépített forrását tartalmazó mappa. Ez az elérési út a következőhöz viszonyítva --app-locationvan: . Az alapértelmezett érték ..

--app-build-command, -A

Létrehozza az előtérbeli alkalmazást.

--api-build-command, -I

Létrehozza az API-alkalmazást.

--auto

Automatikusan észleli, hogyan hozhatja létre az előtérbeli és API-alkalmazásokat. Az alapértelmezett érték false.

Global Parameters

swa start

Indítsa el az Azure Static Web Apps emulátort egy címtárból, vagy kössön egy futó fejlesztői kiszolgálóhoz.

Kiszolgálás mappából

Alapértelmezés szerint a parancssori felület elindítja és kiszolgálja az aktuális munkakönyvtár ./bármely statikus tartalmát:

swa start

Ha a statikus alkalmazás összetevőmappája egy másik mappában van (például), futtassa a parancssori felületet, ./my-distés adja meg a mappát:

swa start ./my-dist

Kiszolgálás fejlesztői kiszolgálóról

Az előtérbeli alkalmazás helyi fejlesztésekor gyakran hasznos az előtérbeli keretrendszer parancssori felületéhez kapcsolódó fejlesztői kiszolgáló használata. A keretrendszer parancssori felületének használatával olyan beépített funkciókat használhat, mint a "livereload" és a HMR (gyakori modul cseréje).

Ha az SWA CLI-t a helyi fejlesztői kiszolgálóval szeretné használni, kövesse az alábbi két lépést:

Indítsa el a helyi fejlesztői kiszolgálót a szokásos módon. Ha például az Angulart használja: ng serve (vagy npm start).
Egy külön terminálban futtassa swa start a fejlesztői kiszolgáló által biztosított URI-t a következő formátumban:

swa start http://<APP_DEV_SERVER_HOST>:<APP_DEV_SERVER_PORT>

Íme a népszerű fejlesztői kiszolgálók által használt alapértelmezett portok és parancsok listája:

Tool	Port	Command
Angular	`4200`	`swa start http://localhost:4200`
Blazor WebAssembly	`5000`	`swa start http://localhost:5000`
Gatsby	`8000`	`swa start http://localhost:8000`
Hugo	`1313`	`swa start http://localhost:1313`
Next.js	`3000`	`swa start http://localhost:3000`
React (React-alkalmazás létrehozása)	`3000`	`swa start http://localhost:3000`
Svelte (sirv-cli)	`5000`	`swa start http://localhost:5000`
Vue	`3000`	`swa start http://localhost:3000`

Ahelyett, hogy külön indítanák el a fejlesztői kiszolgálót, megadhatja az indítási parancsot a parancssori felületnek.

# npm start script (React)
swa start http://localhost:3000 --run "npm start"

# dotnet watch (Blazor)
swa start http://localhost:5000 --run "dotnet watch run"

# Jekyll
swa start http://localhost:4000 --run "jekyll serve"

# custom script
swa start http://localhost:4200 --run "./startup.sh"

Ezután nyissa meg az alkalmazást az emulált szolgáltatásokkal a következő forrásból: http://localhost:4280

Az előtérbeli alkalmazás és az API kiszolgálása

Ha a projekt API-függvényeket tartalmaz, a parancssori felület ellenőrzi, hogy az Azure Functions Core Tools telepítve van-e és elérhető-e. Ha nem, a parancssori felület letölti és telepíti az Azure Functions Core Tools megfelelő verzióját.

Az API-kiszolgáló automatikus indítása

Futtassa a parancssori felületet, és adja meg az API-háttérrendszert tartalmazó mappát (egy érvényes Azure Functions-alkalmazásprojektet):

# static content plus an API
swa start ./my-dist --api-location ./api

# front-end dev server plus an API
swa start http://localhost:3000 --api-location ./api

API-kiszolgáló manuális indítása

A háttérrendszer helyi fejlesztésekor néha hasznos az Azure Functions Core Tools külön futtatása az API kiszolgálásához. Ez lehetővé teszi olyan beépített funkciók használatát, mint a hibakeresés és a részletes szerkesztői támogatás.

Ha a cli-t a helyi API háttérrendszer fejlesztői kiszolgálójával szeretné használni, kövesse az alábbi két lépést:

Indítsa el az API-t az Azure Functions Core Tools használatával: func host start vagy kezdje el a hibakeresést a VS Code-ban.
Egy külön terminálon futtassa az SWA CLI-t a --api-location helyi API-kiszolgáló jelölőjével és URI-jával a következő formátumban:

swa start ./my-dist --api-location http://localhost:7071

Database connections

Ha adatbázis-kapcsolattal szeretné elindítani az alkalmazást, használja a --data-api-location paramétert, és mutasson a staticwebapp.database.config.json fájlt tartalmazó mappára.

swa start ./src --data-api-location swa-db-connections

Syntax

swa start

Examples

1. példa: Az alkalmazás indítása alapértelmezett beállításokkal.

swa start

2. példa: Indítsa el az alkalmazást egy előtérbeli fejlesztői kiszolgálóval.

swa start http://<APP_DEV_SERVER_HOST>:<APP_DEV_SERVER_PORT>

3. példa: Indítsa el az alkalmazást egy előtér- és háttérrendszerbeli fejlesztői kiszolgálóval.

swa start http://<APP_DEV_SERVER_HOST>:<APP_DEV_SERVER_PORT> --api-location http://localhost:7071

Parameters

--app-location, -a <PATH>

Az előtéralkalmazás forráskódját tartalmazó mappa. Az alapértelmezett érték ..

--api-location, -i <PATH>

Az API-alkalmazás forráskódját tartalmazó mappa.

--output-location, -O <PATH>

Az előtéralkalmazás beépített forrását tartalmazó mappa. Az elérési út relatív --app-location. Az alapértelmezett érték ..

--data-api-location

A staticwebapp.database.config.json fájlt tartalmazó mappa.

--app-devserver-url, -D <URL>

Csatlakozzon az alkalmazás fejlesztői kiszolgálóhoz ezen az URL-címen a kimeneti hely használata helyett.

--api-devserver-url, -is <URL>

Csatlakozzon az API-kiszolgálóhoz ezen az URL-címen a kimeneti hely használata helyett.

--api-port, -j <API_PORT>

Az API-kiszolgáló portja, amely a következőnek lett átadva func start: . Az alapértelmezett érték 7071.

--host, -q <HOST>

A CLI fejlesztői kiszolgálóhoz használt gazdagépcím. Az alapértelmezett érték localhost.

--port, -p <PORT>

A CLI fejlesztői kiszolgálóhoz használandó portérték. Alapértelmezett 4280.

--ssl, -s

Az előtérbeli alkalmazás és az API kiszolgálása HTTPS-en keresztül. Az alapértelmezett érték false.

--ssl-cert, -e <SSL_CERT_LOCATION>

A HTTPS engedélyezésekor használt SSL-tanúsítvány (.crt).

--ssl-key, -k <SSL_KEY_LOCATION>

A HTTPS engedélyezésekor használt SSL-kulcs (.key).

--run, -r <STARTUP_SCRIPT>

Az indításkor futtatandó egyéni rendszerhéj-parancs vagy szkriptfájl helye.

--devserver-timeout, -t <TIME>

A várakozási idő (másodpercben), amikor egy előtér-alkalmazás fejlesztői kiszolgálójára vagy EGY API-kiszolgálóra csatlakozik. Az alapértelmezett érték 60.

--swa-config-location, -w <SWA_CONFIG_FILE_LOCATION>

A fájl könyvtárának staticwebapp.config.json helye.

--open, -o

Nyissa meg a böngészőt a fejlesztői kiszolgálón. Az alapértelmezett érték false.

--func-args, -f <FUNCTION_ARGUMENTS>

Adjon át további argumentumokat a func start parancsnak.

Global Parameters

swa deploy

Az aktuális projekt üzembe helyezése az Azure Static Web Appsben.

Gyakori használati esetek a következők:

Előtérbeli alkalmazás üzembe helyezése API nélkül
Előtérbeli alkalmazás üzembe helyezése API-val
Blazor-alkalmazás üzembe helyezése

Deployment token

Az SWA CLI támogatja az üzembe helyezést egy üzembehelyezési jogkivonat használatával. Ez gyakran hasznos CI/CD-környezetből történő üzembe helyezéskor. Az üzembehelyezési jogkivonatot a következő forrásból szerezheti be:

Az Azure Portal: Kezdőlap → Statikus webalkalmazás → A példány → az üzembehelyezési jogkivonat kezelése → áttekintése
Ha az Azure CLI-t használja, a projekt üzembehelyezési jogkivonatát az alábbi paranccsal szerezheti be:

az staticwebapp secrets list --name <APPLICATION_NAME> --query "properties.apiKey"

Ha az Azure Static Web Apps parancssori felületét használja, a következő parancsot használhatja:

swa deploy --print-token

Ezután használhatja ezt az értéket a --deployment-token <TOKEN> használatával, vagy létrehozhat egy környezeti változót, amelyet meghívhat SWA_CLI_DEPLOYMENT_TOKEN , és beállíthatja az üzembehelyezési jogkivonatra.

Important

Ne tárolja az üzembehelyezési jogkivonatot nyilvános adattárban. Ennek az értéknek titkosnak kell maradnia.

Előtérbeli alkalmazás üzembe helyezése API nélkül

Az előtéralkalmazásokat API nélkül is üzembe helyezheti az Azure Static Web Appsben az alábbi lépések végrehajtásával:

Ha az előtérbeli alkalmazás buildelési lépésre van szüksége, futtassa swa build vagy tekintse meg az alkalmazás buildelési utasításait.

1. lehetőség: Az üzembe helyezni kívánt buildmappából futtassa az üzembe helyezési parancsot:

cd build/
swa deploy

Note

A build mappának tartalmaznia kell az üzembe helyezni kívánt alkalmazás statikus tartalmát.

2. lehetőség: Egy adott mappát is üzembe helyezhet:

Ha az előtérbeli alkalmazás buildelési lépésre van szüksége, futtassa swa build vagy tekintse meg az alkalmazás buildelési utasításait.
Az alkalmazás üzembe helyezése:

swa deploy ./my-dist

Előtérbeli alkalmazás üzembe helyezése API-val

Az előtéralkalmazás és az API Azure Static Web Appsben való üzembe helyezéséhez kövesse az alábbi lépéseket:

Ha az előtérbeli alkalmazás buildelési lépésre van szüksége, futtassa swa build vagy tekintse meg az alkalmazás buildelési utasításait.
Győződjön meg arról, hogy a fájl API staticwebapp.config.json nyelvi futtatókörnyezetének verziója helyesen van beállítva, például:

{
  "platform": {
    "apiRuntime": "node:16"
  }
}

Note

Ha a projekt nem rendelkezik fájllal staticwebapp.config.json , vegyen fel egyet a outputLocation mappájába.

Az alkalmazás üzembe helyezése:

swa deploy ./my-dist --api-location ./api

Blazor-alkalmazás üzembe helyezése

Ha blazor-alkalmazást szeretne üzembe helyezni egy opcionális API-val az Azure Static Web Appsben, kövesse az alábbi lépéseket:

Hozza létre a Blazor-alkalmazást kiadási módban:

dotnet publish -c Release -o bin/publish

Futtassa a következő parancsot a deploy projekt gyökeréből:

swa deploy ./bin/publish/wwwroot --api-location ./Api

Üzembe helyezés a következő használatával: `swa-cli.config.json`

Note

A elérési útnak outputLocation a appLocation.

Ha egy swa-cli.config.json konfigurációs fájlt használ a projektben, és egyetlen konfigurációs bejegyzéssel rendelkezik, használja az alábbihoz hasonló konfigurációt:

{
  "configurations": {
    "my-app": {
      "appLocation": "./",
      "apiLocation": "api",
      "outputLocation": "frontend",
      "start": {
        "outputLocation": "frontend"
      },
      "deploy": {
        "outputLocation": "frontend"
      }
    }
  }
}

Ezután az alábbi lépések végrehajtásával telepítheti az alkalmazást:

Ha az előtérbeli alkalmazás buildelési lépésre van szüksége, futtassa swa build vagy tekintse meg az alkalmazás buildelési utasításait.
Az alkalmazás üzembe helyezése:

swa deploy

Ha több konfigurációs bejegyzéssel rendelkezik, megadhatja a bejegyzés azonosítóját, és megadhatja, hogy melyiket használja:

swa deploy my-otherapp

Syntax

swa deploy
           [--yes]

Examples

1. példa: Üzembe helyezés üzembe helyezési jogkivonat használatával.

swa deploy ./dist/ --api-location ./api/ --deployment-token <TOKEN>

2. példa: Üzembe helyezés üzembe helyezési jogkivonat használatával a környezeti változókból

SWA_CLI_DEPLOYMENT_TOKEN=123 swa deploy ./dist/ --api-location ./api/

3. példa: Üzembe helyezés fájl használatával `swa-cli.config.json`

swa deploy
swa deploy myconfig

4. példa: Az üzembehelyezési jogkivonat nyomtatása

swa deploy --print-token

5. példa: Üzembe helyezés egy adott környezetben

swa deploy --env production

Global Parameters

swa db

Statikus Web Apps-adatbáziskapcsolatok konfigurációjának létrehozása és szerkesztése.

Swa-db-connections-mintamappa és konfigurációsstaticwebapp.database.config.json fájl létrehozásához használhatóswa db init. Ha Cosmos DB for NoSQL-adatbázist használ, az is létrehoz egy mintasémafájlt staticwebapp.database.schema.gql .

Syntax

swa db init --database-type <DATABASE_TYPE>

Examples

1. példa: Hozzon létre egy mintaadatbázis-kapcsolatkonfigurációs mappát egy Azure SQL-adatbázishoz.

swa db init --database-type mssql

Parameters

--database-type, -t <DATABASE_TYPE>

(Kötelező) A csatlakoztatni kívánt adatbázis típusa (mssql, postgresql, cosmosdb_nosql, mysql).

--folder-name, -f <FOLDER_NAME>

A konvenciós adatbázis kapcsolatkonfigurációs mappa nevének felülbírálásához szükséges mappanév (győződjön meg arról, hogy ennek megfelelően frissíti a CI-/CD-munkafolyamat fájljait). Az alapértelmezett érték a swa-db-connections.

---connection-string, -cs <CONNECTION_STRING>

A csatlakoztatni kívánt adatbázis kapcsolati sztring.

--cosmosdb_nosql-database, -nd <COSMOSDB_NOSQL_DATABASE>

A csatlakoztatni kívánt Cosmos DB-fiók adatbázisa (csak adatbázistípus használata esetén cosmosdb_nosql szükséges).

--cosmosdb_nosql-container, -nc <COSMOSDB_NOSQL_CONTAINER>

A csatlakoztatni kívánt Cosmos DB-fiók tárolója.

--help, -h

A parancs súgójának megjelenítése.

Global Parameters

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2025-07-29

Megosztás a következőn keresztül:

Azure Static Web Apps CLI-referencia

Commands

Global Parameters

swa login

Syntax

Examples

1. példa: Interaktív bejelentkezés az Azure-ba

Parameters

swa init

Syntax

Examples

1. példa: Új konfiguráció interaktív létrehozása.

2. példa: Hozzon létre egy új konfigurációt az összes beállítás alapértelmezett értékeivel.

3. példa: Inicializálja a projektet a swa-cli.config.json fájl "myApp" nevű konfigurációjának használatával.

Parameters

swa build

Syntax

Examples

1. példa: Az alkalmazás létrehozása és igény szerint függőségek telepítése.

2. példa: Az alkalmazás létrehozásának és buildparancsok futtatásának észlelése a függőségek telepítése után.

3. példa: Az előtérbeli alkalmazás függőségeinek telepítése.

4. példa: Használja a swa-cli.config.json nevű myApp konfigurációt az előtérbeli alkalmazás létrehozásához.

Parameters

swa start

Kiszolgálás mappából

Kiszolgálás fejlesztői kiszolgálóról

Az előtérbeli alkalmazás és az API kiszolgálása

Az API-kiszolgáló automatikus indítása

API-kiszolgáló manuális indítása

Database connections

Syntax

Examples

1. példa: Az alkalmazás indítása alapértelmezett beállításokkal.

2. példa: Indítsa el az alkalmazást egy előtérbeli fejlesztői kiszolgálóval.

3. példa: Indítsa el az alkalmazást egy előtér- és háttérrendszerbeli fejlesztői kiszolgálóval.

Parameters

swa deploy

Deployment token

Előtérbeli alkalmazás üzembe helyezése API nélkül

Előtérbeli alkalmazás üzembe helyezése API-val

Blazor-alkalmazás üzembe helyezése

Üzembe helyezés a következő használatával: swa-cli.config.json

Syntax

Examples

1. példa: Üzembe helyezés üzembe helyezési jogkivonat használatával.

2. példa: Üzembe helyezés üzembe helyezési jogkivonat használatával a környezeti változókból

3. példa: Üzembe helyezés fájl használatával swa-cli.config.json

4. példa: Az üzembehelyezési jogkivonat nyomtatása

5. példa: Üzembe helyezés egy adott környezetben

swa db

Syntax

Examples

1. példa: Hozzon létre egy mintaadatbázis-kapcsolatkonfigurációs mappát egy Azure SQL-adatbázishoz.

Parameters

Visszajelzés

További források

4. példa: Használja a swa-cli.config.json nevű `myApp` konfigurációt az előtérbeli alkalmazás létrehozásához.

Üzembe helyezés a következő használatával: `swa-cli.config.json`

3. példa: Üzembe helyezés fájl használatával `swa-cli.config.json`