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

  • Como fazer

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

Configurações de 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 criptografados em repouso
  • São copiados para ambientes de preparo e de produção
  • Poderá conter apenas caracteres alfanuméricos, ., e _

Importante

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

Para configurar variáveis de ambiente necessárias para criar seu aplicativo Web de front–end, confira Configuração de build.

Pré-requisitos

  • Um aplicativo dos Aplicativos Web Estáticos do Azure
  • CLI do Azure – necessário 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 proporcionadas pelo Azure Functions, o que permite que você defina as configurações do aplicativo no arquivo local.settings.json quando você está executando o aplicativo localmente. Esse arquivo define as configurações do aplicativo na propriedade Values da configuração.

Observação

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

O exemplo a seguir local.settings.json mostra como adicionar um valor para 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 as configurações do aplicativo

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

Use o Portal do Azure

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

  1. Acesse o portal do Azure.

  2. Abra seu aplicativo Web estático.

  3. Selecione Variáveis ​​de ambiente na barra lateral.

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

  5. Selecione + Adicionar para adicionar uma nova variável de ambiente. Captura de tela da exibição de variáveis ​​de ambiente dos Aplicativos Web Estáticos do Azure

  6. Insira um Nome e um Valor.

  7. Selecione OK.

  8. Selecione Salvar.

Use a CLI do Azure

É possível usar o comando az staticwebapp appsettings para atualizar suas configurações no Azure.

Em um terminal ou linha de comando, execute o comando a seguir para adicionar ou atualizar uma configuração chamada 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.

Conteúdo relacionado