Docs
Reference

Azure Static Web Apps settings

The backend API of a static site reads these. A write replaces the whole set, so a portal edit made at the same time is lost.

The backend API of a static site reads these. A write replaces the whole set, so a portal edit made at the same time is lost.

The connection

WhatThis provider
VendorMicrosoft Azure
Keyazure-static-web-apps-settings
Availabilityavailable. You can connect it today.
Credential penv holdsazure-service-principal
Values read backyes
Activationimmediate

What it moves

DirectionWhat it does
importReads names and values out of the store into penv.
exportWrites names and values from penv into the store.

When a written value goes live

immediate. The running app sees a new value at once.

What happens to a name that exists

DirectionPolicies you can pick
importskip_existing, new_version, fail
exportcreate_only, overwrite, overwrite_and_prune

How syncs work says what each one does.

How you connect

You paste a credential you already hold. penv seals it and never shows it again.

FieldLabelKindRequiredWhat it is
tenantIdDirectory (tenant) IDsecret, masked here and sealedyes
clientIdApplication (client) IDsecret, masked here and sealedyes
clientSecretClient secretsecret, masked here and sealedyes

What the connection asks for

Fixed when you connect, and shared by every mapping on it.

FieldLabelKindRequiredAdvancedWhat it is
subscriptionIdSubscription IDtextyesnoThe subscription the service principal has a role assignment on.
resourceGroupResource grouptextyesnoThe group the target resource sits in. One connection covers one group.

What a mapping asks for

Answered once per environment you map.

FieldLabelKindRequiredAdvancedWhat it is
siteNameStatic sitetextyesnoThe site whose backend API reads these settings.
environmentNameEnvironmenttextnoyesLeave empty for production. Azure copies these settings to staging too.

Permissions it needs

penv probes for these when it verifies the connection.

PermissionDirectionsBlockingWithout it
Microsoft.Web/staticSites/listAppSettings/actionevery directionyesPreview cannot read the site's settings.
Microsoft.Web/staticSites/config/writeexportyesExport cannot write anything.
Microsoft.Web/staticSites/Readevery directionnoVerify cannot confirm the credential reaches this resource group.