Compartilhar via

Configure a CLI dos Aplicativos Web Estáticos do Azure

  • Artigo

Importante

Para melhorar a segurança das implantações da CLI de Aplicativos Web Estáticos, foi introduzida uma alteração interruptiva que exige que você atualize para a versão mais recente (2.0.2) da CLI de Aplicativos Web Estáticos até 15 de janeiro de 2025.

A CLI dos Aplicativos Web Estáticos do Azure (SWA) obtém informações de configuração para seu aplicativo Web estático de duas maneiras:

  • Opções da CLI (passadas em runtime)
  • Um arquivo de configuração da CLI chamado swa-cli.config.json

Observação

Por padrão, a CLI da SWA procura um arquivo de configuração chamado swa-cli.config.json no diretório atual.

O arquivo de configuração pode conter várias configurações, cada uma identificada por um nome de configuração exclusivo.

  • Se apenas uma única configuração estiver presente no arquivo swa-cli.config.json, o swa start a usará por padrão.

  • Se as opções forem carregadas de um arquivo de configuração, as opções de linha de comando serão ignoradas.

Exemplo de arquivo de configuração

O snippet de código a seguir mostra a forma do arquivo de configuração.

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

Quando você tiver apenas uma seção de configuração, conforme mostrado por este exemplo, o comando swa start usará esses valores automaticamente.

Inicializar um arquivo de configuração

Você pode inicializar o arquivo de configuração com o comando swa init. Se você executar o comando em um projeto existente, o swa init tentará adivinhar as configurações para você.

Por padrão, o processo cria essas configurações em um swa-cli.config.json no diretório de trabalho atual do seu projeto. Esse diretório é o nome de arquivo padrão e o local usado pelo swa ao pesquisar os valores de configuração do projeto.

swa --config <PATH>

Se o arquivo contiver apenas uma configuração nomeada, essa configuração será usada por padrão. Se várias configurações forem definidas, você passará o nome de configuração desejado como uma opção.

swa --<CONFIG_NAME>

Quando a opção do arquivo de configuração for usada, as configurações serão armazenadas no formato JSON. Depois de criado, você poderá editar manualmente o arquivo para atualizar as configurações ou usar swa init para fazer atualizações.

Exibir configuração

A CLI de Webs Estáticos fornece uma opção --print-config para que você possa examinar sua configuração atual.

Aqui está um exemplo da aparência dessa saída quando executada em um novo projeto com as configurações padrão.

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

Executar swa --print-config fornecerá o padrão de configuração atual.

Observação

Se o projeto ainda não tiver definido um arquivo de configuração, isso disparará automaticamente o fluxo de trabalho swa init para ajudar você a criar um.

Validar a configuração

Você pode validar o arquivo swa-cli.config.json no seguinte esquema: https://aka.ms/azure/static-web-apps-cli/schema