Edytuj

Udostępnij za pośrednictwem

Konfigurowanie ustawień aplikacji dla usługi Azure Static Web Apps

  • Porady

Ustawienia aplikacji przechowują wartości konfiguracji, które mogą ulec zmianie, takie jak parametry połączenia bazy danych. Dodawanie ustawień aplikacji umożliwia modyfikowanie danych wejściowych konfiguracji w aplikacji bez konieczności zmieniania kodu aplikacji.

Ustawienia aplikacji:

  • Są dostępne jako zmienne środowiskowe dla interfejsu API zaplecza statycznej aplikacji internetowej
  • Może służyć do przechowywania wpisów tajnych używanych w konfiguracji uwierzytelniania
  • Są szyfrowane w spoczynku
  • Są kopiowane do środowisk przejściowych i produkcyjnych
  • Może zawierać tylko znaki alfanumeryczne, .i _

Ustawienia aplikacji opisane w tym artykule dotyczą tylko interfejsu API zaplecza statycznej aplikacji internetowej platformy Azure.

Aby skonfigurować zmienne środowiskowe wymagane do utworzenia aplikacji internetowej frontonu, zobacz Konfiguracja kompilacji.

Wymagania wstępne

Konfigurowanie ustawień aplikacji interfejsu API na potrzeby programowania lokalnego

Interfejsy API w usłudze Azure Static Web Apps są obsługiwane przez usługę Azure Functions, co umożliwia definiowanie ustawień aplikacji w pliku local.settings.json podczas lokalnego uruchamiania aplikacji. Ten plik definiuje ustawienia aplikacji we Values właściwości konfiguracji.

Uwaga

Plik local.settings.json jest używany tylko do programowania lokalnego. Użyj witryny Azure Portal , aby skonfigurować ustawienia aplikacji dla środowiska produkcyjnego.

W poniższym przykładzie local.settings.json pokazano , jak dodać wartość elementu 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.

Konfigurowanie ustawień aplikacji

Ustawienia aplikacji można skonfigurować za pośrednictwem witryny Azure Portal lub interfejsu wiersza polecenia platformy Azure.

Ważne

Ustawienia aplikacji opisane w tym artykule dotyczą tylko interfejsu API zaplecza statycznej aplikacji internetowej platformy Azure.

Aby skonfigurować zmienne środowiskowe wymagane do utworzenia aplikacji internetowej frontonu, zobacz Konfiguracja kompilacji.

Korzystanie z witryny Azure Portal

Witryna Azure Portal udostępnia interfejs do tworzenia, aktualizowania i usuwania ustawień aplikacji.

  1. Przejdź do portalu Azure Portal.

  2. Otwórz statyczną aplikację internetową.

  3. W sekcji Ustawienia wybierz pozycję Zmienne środowiskowe.

  4. Wybierz środowisko, do którego chcesz utworzyć zmienne środowiskowe. Zmienne można tworzyć dla każdego środowiska. Podczas tworzenia żądania ściągnięcia środowiska przejściowe są tworzone automatycznie, a następnie awansowane do środowiska produkcyjnego podczas scalania żądania ściągnięcia.

  5. Wybierz pozycję + Dodaj , aby dodać nową zmienną środowiskową.

  6. Wprowadź wartości w polach Nazwa i Wartość .

  7. Wybierz Zastosuj.

  8. Wybierz ponownie pozycję Zastosuj , aby zapisać zmiany.

Korzystanie z interfejsu wiersza polecenia platformy Azure

az staticwebapp appsettings Użyj polecenia , aby zaktualizować ustawienia na platformie Azure.

W terminalu lub wierszu polecenia wykonaj następujące polecenie, aby dodać lub zaktualizować ustawienie o nazwie przy message użyciu wartości Hello world. Pamiętaj, aby zastąpić symbol zastępczy <YOUR_APP_ID> wartością.

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.

Powiązana zawartość