swa

Reference

Příkazy

Name	Description	Typ	Stav
swa login	Přihlášení k Azure	SWA Core	GA
swa build	Sestaví aplikaci. Pokud máte Node.js aplikaci, nejprve nainstaluje závislosti.	SWA Core	GA
swa start	Spusťte emulátor Azure Static Web Apps z adresáře nebo vytvořte vazbu na spuštěný vývojový server.	SWA Core	GA
swa deploy	Nasaďte aktuální projekt do Azure Static Web Apps.	SWA Core	GA
swa db	Vygenerujte a upravte konfiguraci připojení databáze Static Web Apps.	SWA Core	GA

Přihlášení k Azure

Pomocí příkazu se ověřte pomocí Azure a swa deploy získejte token nasazení pro Azure Static Web Apps.

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

Interaktivní přihlášení k Azure

swa login

--subscription-id, -S

ID předplatného Azure používané tímto projektem Výchozí hodnota je process.env.AZURE_SUBSCRIPTION_ID.

--resource-group, -R

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--tenant-id, -T

ID tenanta Azure. Výchozí hodnota je process.env.AZURE_TENANT_ID.

--client-id, -C

ID klienta Azure.

--client-secret, -CS

Tajný klíč klienta Azure.

--app-name, -n

Název aplikace Azure Static Web Apps

--clear-credentials -cc

Před přihlášením vymažte trvalé přihlašovací údaje. Výchozí hodnota je false.

--use-keychain, -u

Pro trvalé přihlašovací údaje použijte nativní klíčence operačního systému. Výchozí hodnota je true.

--no-use-keychain, -nu

Zakažte použití nativní klíčenky operačního systému.

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

swa init

Nakonfiguruje nový projekt Azure Static Web Apps.

Nakonfiguruje nový projekt Azure Static Web Apps pomocí rozhraní příkazového řádku Static Web Apps. Interaktivní režim vás vyzve k zadání názvu konfigurace, zjistí nastavení projektu a použité architektury. Po dokončení se vytvoří nová statická webová aplikace a v aktuálním adresáři se vygeneruje soubor swa-cli.config.json. Můžete spustit swa init vícekrát, abyste pro svůj projekt vytvořili různé konfigurace. Můžete to udělat, pokud pracujete na monorepo a chcete nakonfigurovat různé projekty. Vygenerovaný konfigurační soubor se používá v každém příkazu, který spustíte pomocí rozhraní příkazového řádku Static Web Apps. Pokud máte více pojmenovaných konfigurací, můžete pomocí pozičního argumentu nebo --config-name možnosti určit, kterou konfiguraci chcete použít. Následuje příklad konfigurace vygenerované příkazem init :

  "$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"
    }
  }
} ```

swa init
          [--yes]

Příklady

Interaktivní vytvoření nové konfigurace

swa init

Vytvořte novou konfiguraci s použitím výchozích hodnot pro všechny možnosti.

swa init --yes

Inicializace projektu pomocí konfigurace s názvem "myApp" ze souboru swa-cli.config.json.

swa init --config-name myApp

Volitelné parametry

--yes, -y

Odpoví "ano" na všechny výzvy, které zakáže interaktivní režim. Výchozí hodnota je false.

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

swa start

Spusťte emulátor Azure Static Web Apps z adresáře nebo vytvořte vazbu na spuštěný vývojový server.

Obsluha ze složky

Ve výchozím nastavení se rozhraní příkazového řádku spustí a obsluhuje veškerý statický obsah z aktuálního pracovního adresáře ./:

swa start

Pokud je složka artefaktů vaší statické aplikace pod jinou složkou (například ./my-dist), spusťte rozhraní příkazového řádku a zadejte tuto složku:

swa start ./my-dist

Obsluha z vývojového serveru

Při místním vývoji front-endové aplikace je často užitečné používat vývojový server, který je součástí rozhraní příkazového řádku vaší front-endové architektury. Použití rozhraní příkazového řádku umožňuje používat integrované funkce, jako je "livereload" a HMR (výměna horkého modulu). Pokud chcete používat rozhraní příkazového řádku SWA s místním vývojovým serverem, postupujte takto:

Spusťte místní vývojový server obvyklým způsobem. Pokud například používáte Angular: ng serve (nebo npm start).
V samostatném terminálu spusťte swa start identifikátor URI poskytovaný vývojovým serverem v následujícím formátu:

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

Tady je seznam výchozích portů a příkazů používaných některými oblíbenými vývojovými servery:

Nástroj	Port	Příkaz
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 (vytvoření aplikace React)	`3000`	`swa start http://localhost:3000`
Svelte (sirv-cli)	`5000`	`swa start http://localhost:5000`
Vue	`3000`	`swa start http://localhost:3000`

Místo samostatného spuštění vývojového serveru můžete příkazovému řádku poskytnout spouštěcí příkaz.

# 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"

Pak k aplikaci přistupovat pomocí emulovaných služeb z http://localhost:4280

Obsluha front-endové aplikace i rozhraní API

Pokud váš projekt obsahuje funkce rozhraní API, rozhraní příkazového řádku zkontroluje, jestli jsou nainstalované a dostupné nástroje Azure Functions Core Tools. Pokud ne, rozhraní příkazového řádku stáhne a nainstaluje správnou verzi nástrojů Azure Functions Core Tools.

Automatické spuštění serveru rozhraní API

Spusťte rozhraní příkazového řádku a zadejte složku, která obsahuje back-end rozhraní API (platný projekt aplikace Azure Functions):

# 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

Ruční spuštění serveru rozhraní API

Při místním vývoji back-endu je někdy užitečné spouštět nástroje Azure Functions Core Tools samostatně pro obsluhu rozhraní API. Díky tomu můžete používat integrované funkce, jako je ladění a bohatá podpora editoru. Pokud chcete rozhraní příkazového řádku použít s místním back-endovým vývojovým serverem rozhraní API, postupujte takto:

Spusťte rozhraní API pomocí nástrojů Azure Functions Core Tools: func host start nebo spusťte ladění ve VS Code.
V samostatném terminálu spusťte rozhraní příkazového řádku SWA s příznakem --api-location a identifikátorem URI místního serveru API v následujícím formátu:

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

Připojení k databázi

Pokud chcete spustit aplikaci pomocí připojení k databázi, použijte --data-api-location parametr a přejděte do složky obsahující soubor staticwebapp.database.config.json .

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

Příklady

Spusťte aplikaci s výchozími nastaveními.

swa start

Spusťte aplikaci s front-endovým vývojovým serverem.

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

Spusťte aplikaci front-endovým a back-endovým vývojovým serverem.

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

Volitelné parametry

--app-location, -a <PATH>

Složka obsahující zdrojový kód front-endové aplikace. Výchozí hodnota je ..

--api-location, -i <PATH>

Složka obsahující zdrojový kód aplikace API.

--output-location, -O <PATH>

Složka obsahující sestavený zdroj front-endové aplikace. Cesta je relativní k --app-location. Výchozí hodnota je ..

--data-api-location

Složka obsahující soubor staticwebapp.database.config.json .

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

Místo použití výstupního umístění se připojte k vývojovému serveru aplikace na této adrese URL.

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

Místo použití výstupního umístění se připojte k serveru rozhraní API na této adrese URL.

--api-port, -j <API_PORT>

Port serveru rozhraní API předaný do func start. Výchozí hodnota je 7071.

--host, -q <HOST>

Adresa hostitele používaná pro vývojový server rozhraní příkazového řádku. Výchozí hodnota je localhost.

--port, -p <PORT>

Hodnota portu, která se má použít pro vývojový server rozhraní příkazového řádku. Výchozí hodnota 4280.

--ssl, -s

Obsluha front-endové aplikace a rozhraní API přes HTTPS. Výchozí hodnota je false.

--ssl-cert, -e <SSL_CERT_LOCATION>

Certifikát SSL (.crt) používaný při povolování PROTOKOLU HTTPS.

--ssl-key, -k <SSL_KEY_LOCATION>

Klíč SSL (.key) použitý při povolování PROTOKOLU HTTPS.

--run, -r <STARTUP_SCRIPT>

Umístění vlastního příkazu prostředí nebo souboru skriptu, který se má spustit při spuštění

--devserver-timeout, -t <TIME>

Doba čekání (v sekundách) při připojování k vývojovému serveru front-endové aplikace nebo serveru rozhraní API. Výchozí hodnota je 60.

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

Umístění staticwebapp.config.json adresáře souboru.

--open, -o

Otevřete prohlížeč na vývojový server. Výchozí hodnota je False.

--func-args, -f <FUNCTION_ARGUMENTS>

Předejte do příkazu další argumenty func start .

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

swa build

Sestaví aplikaci. Pokud máte Node.js aplikaci, nejprve nainstaluje závislosti.

Mezi běžné případy použití patří: instalace závislostí pro front-endovou aplikaci a rozhraní API a spuštění příkazů sestavení pro obojí, pouze sestavení front-endu nebo projektu rozhraní API, pokud druhý krok sestavení neobsahuje.

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

Příklady

Sestavte aplikaci a volitelně nainstalujte závislosti.

swa build

Zjistěte, jak sestavit aplikaci a spouštět příkazy sestavení po instalaci závislostí.

swa build --auto

Nainstalujte závislosti pro front-endovou aplikaci.

swa build --app-location ./client

Pomocí konfigurace myApp v *swa-cli.config.json* sestavte front-endovou aplikaci.

swa build myApp

Volitelné parametry

--app-location, -a

Složka obsahující zdrojový kód front-endové aplikace. Výchozí hodnota je ..

--api-location, -i

Složka obsahující zdrojový kód aplikace API.

--output-location, -O

Složka obsahující sestavený zdroj front-endové aplikace. Tato cesta je relativní k --app-location. Výchozí hodnota je ..

--app-build-command, -A

Vytvoří front-endovou aplikaci.

--api-build-command, -I

Sestaví aplikaci API.

--auto

Automaticky zjistí, jak se vytvářejí front-endové aplikace a aplikace rozhraní API. Výchozí hodnota je false.

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

swa deploy

Nasaďte aktuální projekt do Azure Static Web Apps.

Mezi běžné případy použití patří:

Nasazení front-endové aplikace bez rozhraní API
Nasazení front-endové aplikace pomocí rozhraní API
Nasazení aplikace Blazor

Token nasazení

Rozhraní příkazového řádku SWA podporuje nasazení pomocí tokenu nasazení. To je často užitečné při nasazování z prostředí CI/CD. Token nasazení můžete získat z těchto:

Azure Portal: Domovská stránka → Static Web App → přehled vaší instance → přehledu → Správa tokenu nasazení
Pokud používáte Azure CLI, můžete získat token nasazení projektu pomocí následujícího příkazu:
```
az staticwebapp secrets list --name <APPLICATION_NAME> --query "properties.apiKey"
```
Pokud používáte Rozhraní příkazového řádku Azure Static Web Apps, můžete použít následující příkaz:
```
swa deploy --print-token
```
Tuto hodnotu pak můžete použít s --deployment-token <TOKEN> proměnnou prostředí nebo můžete vytvořit volanou SWA_CLI_DEPLOYMENT_TOKEN proměnnou prostředí a nastavit ji na token nasazení.

Důležité: Neukládejte token nasazení do veřejného úložiště. Tato hodnota musí zůstat tajným kódem.

Nasazení front-endové aplikace bez rozhraní API

Front-endovou aplikaci bez rozhraní API můžete nasadit do Azure Static Web Apps spuštěním následujících kroků:

Pokud front-endová aplikace vyžaduje krok sestavení, spusťte swa build nebo postupujte podle pokynů k sestavení aplikace.

Možnost 1: Ze složky sestavení, kterou chcete nasadit, spusťte příkaz deploy:

cd build/
swa deploy

Poznámka: Složka build musí obsahovat statický obsah aplikace, kterou chcete nasadit. Možnost 2: Můžete také nasadit konkrétní složku:

Pokud vaše front-endová aplikace vyžaduje krok sestavení, spusťte swa build nebo postupujte podle pokynů k sestavení aplikace.
Nasazení aplikace:

swa deploy ./my-dist

Nasazení front-endové aplikace pomocí rozhraní API

Pokud chcete nasadit front-endovou aplikaci i rozhraní API do Azure Static Web Apps, postupujte takto:

Pokud vaše front-endová aplikace vyžaduje krok sestavení, spusťte swa build nebo postupujte podle pokynů k sestavení aplikace.
Ujistěte se, že je v staticwebapp.config.json souboru správně nastavená verze modulu runtime jazyka API, například:

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

Poznámka: Pokud projekt nemá žádný staticwebapp.config.json soubor, přidejte ho do složky outputLocation .

Nasazení aplikace:

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

Nasazení aplikace Blazor

Pokud chcete nasadit aplikaci Blazor s volitelným rozhraním API do Azure Static Web Apps, postupujte následovně:

Sestavení aplikace Blazor v režimu vydání :

dotnet publish -c Release -o bin/publish

V kořenovém adresáři projektu spusťte deploy příkaz:

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

Nasazení pomocí `swa-cli.config.json`

Poznámka: Cesta musí outputLocation být relativní vzhledem k appLocation. Pokud v projektu používáte swa-cli.config.json konfigurační soubor a máte jednu položku konfigurace, použijte tuto konfiguraci:

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

Potom můžete aplikaci nasadit spuštěním následujících kroků:

Pokud front-endová aplikace vyžaduje krok sestavení, spusťte swa build nebo postupujte podle pokynů k sestavení aplikace.
Nasazení aplikace:

swa deploy

Pokud máte více položek konfigurace, můžete zadat ID položky, které chcete použít:

swa deploy my-otherapp

swa deploy
          [--yes]

Příklady

Nasazení pomocí tokenu nasazení

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

Nasazení pomocí tokenu nasazení z proměnných prostředí

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

Nasazení pomocí souboru swa-cli.config.json

swa deploy swa deploy myconfig

Tisk tokenu nasazení

swa deploy --print-token

Nasazení do konkrétního prostředí

swa deploy --env production

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

swa db

Vygenerujte a upravte konfiguraci připojení databáze Static Web Apps.

Slouží swa db init k vygenerování ukázkové složky swa-db-connections spolu s konfiguračním souborem staticwebapp.database.config.json . Pokud používáte databázi Cosmos DB for NoSQL, vygeneruje se tím také ukázkový soubor schématu staticwebapp.database.schema.gql .

swa db init --database-type <DATABASE_TYPE>

Příklady

Vygenerujte ukázkovou složku konfigurace připojení k databázi Azure SQL.

swa db init --database-type mssql

Volitelné parametry

--database-type, -t <DATABASE_TYPE>

(Povinné) Typ databáze, kterou chcete připojit (mssql, postgresql, cosmosdb_nosql, mysql).

--folder-name, -f <FOLDER_NAME>

Název složky pro přepsání názvu konfigurační složky připojení k konvenci databáze (ujistěte se, že odpovídajícím způsobem aktualizujete soubory pracovních postupů CI/CD). Výchozí hodnota je swa-db-connections.

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

Připojovací řetězec databáze, kterou chcete připojit.

--cosmosdb_nosql-database, -nd <COSMOSDB_NOSQL_DATABASE>

Databáze účtu služby Cosmos DB, který chcete připojit (vyžaduje se pouze v případě, že používáte typ databáze cosmosdb_nosql).

--cosmosdb_nosql-container, -nc <COSMOSDB_NOSQL_CONTAINER>

Kontejner účtu cosmosdb, který chcete připojit.

--help, -h

Zobrazit nápovědu k příkazu

Globální parametry

--version, -v

Zobrazí číslo verze.

--verbose, --V [level]

Povolte podrobný výstup. Mezi hodnoty úrovně patří silly, , info( log výchozí) a silent.

--config, -c [path]

Cesta k souboru swa-cli.config.json

--config-name, -cn

Konfigurace používaná rozhraním příkazového řádku

--print-config, -g

Vytiskněte všechny vyřešené možnosti. Výchozí hodnota je false.

--help, -h

Zobrazit nápovědu citlivou na kontext

Sdílet prostřednictvím

swa

Příkazy

swa init

Příklady

Volitelné parametry

swa start

Obsluha ze složky

Obsluha z vývojového serveru

Obsluha front-endové aplikace i rozhraní API

Automatické spuštění serveru rozhraní API

Ruční spuštění serveru rozhraní API

Připojení k databázi

Příklady

Volitelné parametry

swa build

Příklady

Volitelné parametry

swa deploy

Token nasazení

Nasazení front-endové aplikace bez rozhraní API

Nasazení front-endové aplikace pomocí rozhraní API

Nasazení aplikace Blazor

Nasazení pomocí `swa-cli.config.json`

Příklady

swa db

Příklady

Volitelné parametry

Váš názor

Další materiály

Sdílet prostřednictvím

swa

Příkazy

swa login

Příklady

Volitelné parametry

swa init

Příklady

Volitelné parametry

swa start

Obsluha ze složky

Obsluha z vývojového serveru

Obsluha front-endové aplikace i rozhraní API

Automatické spuštění serveru rozhraní API

Ruční spuštění serveru rozhraní API

Připojení k databázi

Příklady

Volitelné parametry

swa build

Příklady

Volitelné parametry

swa deploy

Token nasazení

Nasazení front-endové aplikace bez rozhraní API

Nasazení front-endové aplikace pomocí rozhraní API

Nasazení aplikace Blazor

Nasazení pomocí swa-cli.config.json

Příklady

swa db

Příklady

Volitelné parametry

Váš názor

Další materiály

Nasazení pomocí `swa-cli.config.json`