Поделиться через

Настройка интерфейса командной строки Статические веб-приложения Azure

  • Статья

Внимание

Чтобы повысить безопасность развертываний из интерфейса командной строки Статические веб-приложения, было введено критическое изменение, требующее обновления до последней версии (2.0.2) Статические веб-приложения CLI к январю 15 января 2025 года.

Интерфейс командной строки Статические веб-приложения Azure (SWA) получает сведения о конфигурации для статического веб-приложения одним из двух способов:

  • Параметры ИНТЕРФЕЙСА командной строки (переданы во время выполнения)
  • Файл конфигурации CLI с именем swa-cli.config.json

Примечание.

По умолчанию интерфейс командной строки SWA ищет файл конфигурации с именем swa-cli.config.json в текущем каталоге.

Файл конфигурации может содержать несколько конфигураций, каждый из которых определяется уникальным именем конфигурации.

  • Если в файле swa-cli.config.json присутствует только одна конфигурация, swa start используется по умолчанию.

  • Если параметры загружаются из файла конфигурации, параметры командной строки игнорируются.

Пример файла конфигурации

В следующем фрагменте кода показана форма файла конфигурации.

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

Если у вас есть только один раздел конфигурации, как показано в этом примере, swa start команда автоматически использует эти значения.

Инициализация файла конфигурации

Файл конфигурации можно инициализировать с помощью swa init команды. При выполнении команды в существующем проекте swa init попытается угадать параметры конфигурации.

По умолчанию процесс создает эти параметры в swa-cli.config.json в текущем рабочем каталоге проекта. Этот каталог — это имя файла по умолчанию и расположение, используемое swa при поиске значений конфигурации проекта.

swa --config <PATH>

Если файл содержит только одну именованную конфигурацию, то эта конфигурация используется по умолчанию. Если определены несколько конфигураций, в качестве параметра передайте требуемое имя конфигурации.

swa --<CONFIG_NAME>

При использовании параметра файла конфигурации параметры хранятся в формате JSON. После создания вы можете вручную изменить файл, чтобы обновить параметры или использовать swa init для внесения обновлений.

Просмотр конфигурации

Интерфейс командной --print-config строки статических веб-сайтов предоставляет возможность просмотра текущей конфигурации.

Ниже приведен пример того, что выходные данные выглядят при запуске в новом проекте с параметрами по умолчанию.

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

При выполнении swa --print-config указана текущая конфигурация по умолчанию.

Примечание.

Если проект еще не определен файл конфигурации, это автоматически активирует swa init рабочий процесс, который поможет вам создать файл конфигурации.

Проверка конфигурации

Вы можете проверить файл swa-cli.config.json на основе следующей схемы:https://aka.ms/azure/static-web-apps-cli/schema