Editar

Partilhar via


Definir configurações de aplicativo para Aplicativos Web Estáticos do Azure

As definições do aplicativo mantêm valores de configuração que podem ser alterados, como cadeias de conexão de banco de dados. Adicionar configurações de aplicativo permite que você modifique a entrada de configuração para seu aplicativo, sem ter que alterar o código do aplicativo.

Configurações do aplicativo:

  • Estão disponíveis como variáveis de ambiente para a API de back-end de um aplicativo Web estático
  • Pode ser usado para armazenar segredos usados na configuração de autenticação
  • São encriptados em repouso
  • São copiados para ambientes de preparação e produção
  • Podem ser apenas caracteres alfanuméricos, .e _

As configurações de aplicativo descritas neste artigo só se aplicam à API de back-end de um Aplicativo Web Estático do Azure.

Para configurar as variáveis de ambiente necessárias para criar seu aplicativo Web frontend, consulte Configuração de compilação.

Pré-requisitos

  • Um aplicativo de Aplicativos Web Estáticos do Azure
  • CLI do Azure necessária se você estiver usando a linha de comando

Definir configurações de aplicativo de API para desenvolvimento local

As APIs nos Aplicativos Web Estáticos do Azure são alimentadas pelo Azure Functions, que permite definir as configurações do aplicativo no arquivo local.settings.json quando você executa o aplicativo localmente. Este arquivo define as configurações do Values aplicativo na propriedade da configuração.

Nota

O arquivo local.settings.json é usado apenas para o desenvolvimento local. Use o portal do Azure para definir as configurações do aplicativo para produção.

A local.settings.json de exemplo a seguir mostra como adicionar um valor para o DATABASE_CONNECTION_STRING.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "DATABASE_CONNECTION_STRING": "<YOUR_DATABASE_CONNECTION_STRING>"
  }
}

Settings defined in the Values property can be referenced from code as environment variables. In Node.js functions, for example, they're available in the process.env object.

const connectionString = process.env.DATABASE_CONNECTION_STRING;

The local.settings.json file isn't tracked by the GitHub repository because sensitive information, like database connection strings, are often included in the file. Since the local settings remain on your machine, you need to manually configure your settings in Azure.

Generally, configuring your settings is done infrequently, and isn't required with every build.

Definir configurações do aplicativo

Você pode definir as configurações do aplicativo por meio do portal do Azure ou com a CLI do Azure.

Importante

As configurações de aplicativo descritas neste artigo só se aplicam à API de back-end de um Aplicativo Web Estático do Azure.

Para configurar as variáveis de ambiente necessárias para criar seu aplicativo Web frontend, consulte Configuração de compilação.

Utilizar o portal do Azure

O portal do Azure fornece uma interface para criar, atualizar e excluir configurações do aplicativo.

  1. Aceda ao portal do Azure.

  2. Abra seu aplicativo Web estático.

  3. Na seção Configurações, selecione Variáveis de ambiente.

  4. Selecione o ambiente para o qual você deseja criar variáveis de ambiente. Você pode criar variáveis por ambiente. Quando você cria uma solicitação pull, os ambientes de preparo são criados automaticamente e, em seguida, promovidos para produção quando você mescla a solicitação pull.

  5. Selecione + Adicionar para adicionar uma nova variável de ambiente.

  6. Insira seus valores nas caixas Nome e Valor.

  7. Selecione Aplicar.

  8. Selecione Aplicar novamente para salvar as alterações.

Utilizar a CLI do Azure

Use o az staticwebapp appsettings comando para atualizar suas configurações no Azure.

Em um terminal ou linha de comando, execute o seguinte comando para adicionar ou atualizar uma configuração nomeada message com um valor de Hello world. Certifique-se de substituir o espaço reservado <YOUR_APP_ID> pelo seu valor.

az staticwebapp appsettings set --name <YOUR_APP_ID> --setting-names "message=Hello world"

Tip

You can add or update multiple settings by passing multiple name-value pairs to --setting-names.

View application settings with the Azure CLI

In a terminal or command line, execute the following command. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings list --name <YOUR_APP_ID>

Delete application settings with the Azure CLI

In a terminal or command line, execute the following command to delete a setting named message. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings delete --name <YOUR_APP_ID> --setting-names "message"

Tip

Delete multiple settings by passing multiple setting names to --setting-names.