Konfigurace nastavení aplikace pro Azure Static Web Apps

Nastavení aplikace uchovává konfigurační hodnoty, které se můžou změnit, například databázové připojovací řetězec. Přidání nastavení aplikace umožňuje upravit vstup konfigurace do aplikace, aniž byste museli měnit kód aplikace.

Nastavení aplikace:

  • Jsou dostupné jako proměnné prostředí pro back-endové rozhraní API statické webové aplikace.
  • Dá se použít k ukládání tajných kódů používaných v konfiguraci ověřování.
  • Jsou neaktivní neaktivní zašifrované.
  • Kopírují se do přípravných a produkčních prostředí.
  • Mohou být pouze alfanumerické znaky, .a _

Důležité

Nastavení aplikace popsané v tomto článku platí jenom pro back-endové rozhraní API statické webové aplikace Azure.

Informace o konfiguraci proměnných prostředí, které jsou potřeba k sestavení front-endové webové aplikace, najdete v tématu Konfigurace sestavení.

Požadavky

Konfigurace nastavení aplikace ROZHRANÍ API pro místní vývoj

Rozhraní API ve službě Azure Static Web Apps využívají službu Azure Functions, která umožňuje definovat nastavení aplikace v souboru local.settings.json při místním spuštění aplikace. Tento soubor definuje nastavení aplikace ve Values vlastnosti konfigurace.

Poznámka:

Soubor local.settings.json se používá pouze pro místní vývoj. Pomocí webu Azure Portal můžete nakonfigurovat nastavení aplikace pro produkční prostředí.

Následující ukázka local.settings.json ukazuje, jak přidat hodnotu pro 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.

Konfigurace nastavení aplikace

Nastavení aplikace můžete nakonfigurovat prostřednictvím webu Azure Portal nebo pomocí Azure CLI.

Použití portálu Azure Portal

Azure Portal poskytuje rozhraní pro vytváření, aktualizaci a odstraňování nastavení aplikace.

  1. Přejděte na Azure Portal.

  2. Otevřete statickou webovou aplikaci.

  3. Na bočním panelu vyberte Možnost Konfigurace .

  4. Vyberte prostředí, u kterého chcete použít nastavení aplikace. Nastavení aplikace můžete nakonfigurovat pro každé prostředí. Když vytvoříte žádost o přijetí změn, pracovní prostředí se automaticky vytvoří a při sloučení žádosti o přijetí změn se povýšit do produkčního prostředí.

  5. Vyberte + Přidat a přidejte nové nastavení aplikace. Snímek obrazovky se zobrazením konfigurace Azure Static Web Apps

  6. Zadejte název a hodnotu.

  7. Vyberte OK.

  8. Zvolte Uložit.

Použití Azure CLI

az staticwebapp appsettings Pomocí příkazu aktualizujte nastavení v Azure.

V terminálu nebo příkazovém řádku spusťte následující příkaz, kterým přidáte nebo aktualizujete nastavení pojmenované message hodnotou Hello world. Nezapomeňte zástupný symbol <YOUR_APP_ID> nahradit hodnotou.

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.