Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. StaticWebApp

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.appservice.StaticWebApp

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an App Service Static Web App.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleStaticWebApp = new azure.appservice.StaticWebApp("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_static_web_app = azure.appservice.StaticWebApp("example",
    name="example",
    resource_group_name=example.name,
    location=example.location)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewStaticWebApp(ctx, "example", &appservice.StaticWebAppArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleStaticWebApp = new Azure.AppService.StaticWebApp("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appservice.StaticWebApp;
import com.pulumi.azure.appservice.StaticWebAppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleStaticWebApp = new StaticWebApp("exampleStaticWebApp", StaticWebAppArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleStaticWebApp:
    type: azure:appservice:StaticWebApp
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
Copy

Create StaticWebApp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StaticWebApp(name: string, args: StaticWebAppArgs, opts?: CustomResourceOptions);
@overload
def StaticWebApp(resource_name: str,
                 args: StaticWebAppArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def StaticWebApp(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 resource_group_name: Optional[str] = None,
                 preview_environments_enabled: Optional[bool] = None,
                 repository_branch: Optional[str] = None,
                 identity: Optional[StaticWebAppIdentityArgs] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 app_settings: Optional[Mapping[str, str]] = None,
                 public_network_access_enabled: Optional[bool] = None,
                 configuration_file_changes_enabled: Optional[bool] = None,
                 repository_token: Optional[str] = None,
                 repository_url: Optional[str] = None,
                 basic_auth: Optional[StaticWebAppBasicAuthArgs] = None,
                 sku_size: Optional[str] = None,
                 sku_tier: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
func NewStaticWebApp(ctx *Context, name string, args StaticWebAppArgs, opts ...ResourceOption) (*StaticWebApp, error)
public StaticWebApp(string name, StaticWebAppArgs args, CustomResourceOptions? opts = null)
public StaticWebApp(String name, StaticWebAppArgs args)
public StaticWebApp(String name, StaticWebAppArgs args, CustomResourceOptions options)

type: azure:appservice:StaticWebApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StaticWebAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StaticWebAppArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StaticWebAppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StaticWebAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StaticWebAppArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var staticWebAppResource = new Azure.AppService.StaticWebApp("staticWebAppResource", new()
{
    ResourceGroupName = "string",
    PreviewEnvironmentsEnabled = false,
    RepositoryBranch = "string",
    Identity = new Azure.AppService.Inputs.StaticWebAppIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    AppSettings = 
    {
        { "string", "string" },
    },
    PublicNetworkAccessEnabled = false,
    ConfigurationFileChangesEnabled = false,
    RepositoryToken = "string",
    RepositoryUrl = "string",
    BasicAuth = new Azure.AppService.Inputs.StaticWebAppBasicAuthArgs
    {
        Environments = "string",
        Password = "string",
    },
    SkuSize = "string",
    SkuTier = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := appservice.NewStaticWebApp(ctx, "staticWebAppResource", &appservice.StaticWebAppArgs{
	ResourceGroupName:          pulumi.String("string"),
	PreviewEnvironmentsEnabled: pulumi.Bool(false),
	RepositoryBranch:           pulumi.String("string"),
	Identity: &appservice.StaticWebAppIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	AppSettings: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PublicNetworkAccessEnabled:      pulumi.Bool(false),
	ConfigurationFileChangesEnabled: pulumi.Bool(false),
	RepositoryToken:                 pulumi.String("string"),
	RepositoryUrl:                   pulumi.String("string"),
	BasicAuth: &appservice.StaticWebAppBasicAuthArgs{
		Environments: pulumi.String("string"),
		Password:     pulumi.String("string"),
	},
	SkuSize: pulumi.String("string"),
	SkuTier: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var staticWebAppResource = new StaticWebApp("staticWebAppResource", StaticWebAppArgs.builder()
    .resourceGroupName("string")
    .previewEnvironmentsEnabled(false)
    .repositoryBranch("string")
    .identity(StaticWebAppIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .appSettings(Map.of("string", "string"))
    .publicNetworkAccessEnabled(false)
    .configurationFileChangesEnabled(false)
    .repositoryToken("string")
    .repositoryUrl("string")
    .basicAuth(StaticWebAppBasicAuthArgs.builder()
        .environments("string")
        .password("string")
        .build())
    .skuSize("string")
    .skuTier("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
static_web_app_resource = azure.appservice.StaticWebApp("staticWebAppResource",
    resource_group_name="string",
    preview_environments_enabled=False,
    repository_branch="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    name="string",
    app_settings={
        "string": "string",
    },
    public_network_access_enabled=False,
    configuration_file_changes_enabled=False,
    repository_token="string",
    repository_url="string",
    basic_auth={
        "environments": "string",
        "password": "string",
    },
    sku_size="string",
    sku_tier="string",
    tags={
        "string": "string",
    })
Copy
const staticWebAppResource = new azure.appservice.StaticWebApp("staticWebAppResource", {
    resourceGroupName: "string",
    previewEnvironmentsEnabled: false,
    repositoryBranch: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    appSettings: {
        string: "string",
    },
    publicNetworkAccessEnabled: false,
    configurationFileChangesEnabled: false,
    repositoryToken: "string",
    repositoryUrl: "string",
    basicAuth: {
        environments: "string",
        password: "string",
    },
    skuSize: "string",
    skuTier: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:appservice:StaticWebApp
properties:
    appSettings:
        string: string
    basicAuth:
        environments: string
        password: string
    configurationFileChangesEnabled: false
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    previewEnvironmentsEnabled: false
    publicNetworkAccessEnabled: false
    repositoryBranch: string
    repositoryToken: string
    repositoryUrl: string
    resourceGroupName: string
    skuSize: string
    skuTier: string
    tags:
        string: string
Copy

StaticWebApp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StaticWebApp resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
AppSettings Dictionary<string, string>
A key-value pair of App Settings.
BasicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
ConfigurationFileChangesEnabled bool
Should changes to the configuration file be permitted. Defaults to true.
Identity StaticWebAppIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
PreviewEnvironmentsEnabled bool
Are Preview (Staging) environments enabled. Defaults to true.
PublicNetworkAccessEnabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
RepositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
RepositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
RepositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
SkuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
SkuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
AppSettings map[string]string
A key-value pair of App Settings.
BasicAuth StaticWebAppBasicAuthArgs
A basic_auth block as defined below.
ConfigurationFileChangesEnabled bool
Should changes to the configuration file be permitted. Defaults to true.
Identity StaticWebAppIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
PreviewEnvironmentsEnabled bool
Are Preview (Staging) environments enabled. Defaults to true.
PublicNetworkAccessEnabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
RepositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
RepositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
RepositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
SkuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
SkuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
appSettings Map<String,String>
A key-value pair of App Settings.
basicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
configurationFileChangesEnabled Boolean
Should changes to the configuration file be permitted. Defaults to true.
identity StaticWebAppIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled Boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled Boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch String
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken String
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl String
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
skuSize String
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier String
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
appSettings {[key: string]: string}
A key-value pair of App Settings.
basicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
configurationFileChangesEnabled boolean
Should changes to the configuration file be permitted. Defaults to true.
identity StaticWebAppIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
skuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
app_settings Mapping[str, str]
A key-value pair of App Settings.
basic_auth StaticWebAppBasicAuthArgs
A basic_auth block as defined below.
configuration_file_changes_enabled bool
Should changes to the configuration file be permitted. Defaults to true.
identity StaticWebAppIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
preview_environments_enabled bool
Are Preview (Staging) environments enabled. Defaults to true.
public_network_access_enabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
repository_branch str
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repository_token str
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repository_url str
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
sku_size str
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
sku_tier str
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
appSettings Map<String>
A key-value pair of App Settings.
basicAuth Property Map
A basic_auth block as defined below.
configurationFileChangesEnabled Boolean
Should changes to the configuration file be permitted. Defaults to true.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled Boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled Boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch String
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken String
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl String
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
skuSize String
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier String
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the StaticWebApp resource produces the following output properties:

ApiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
DefaultHostName string
The default host name of the Static Web App.
Id string
The provider-assigned unique ID for this managed resource.
ApiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
DefaultHostName string
The default host name of the Static Web App.
Id string
The provider-assigned unique ID for this managed resource.
apiKey String
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
defaultHostName String
The default host name of the Static Web App.
id String
The provider-assigned unique ID for this managed resource.
apiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
defaultHostName string
The default host name of the Static Web App.
id string
The provider-assigned unique ID for this managed resource.
api_key str
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
default_host_name str
The default host name of the Static Web App.
id str
The provider-assigned unique ID for this managed resource.
apiKey String
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
defaultHostName String
The default host name of the Static Web App.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing StaticWebApp Resource

Get an existing StaticWebApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StaticWebAppState, opts?: CustomResourceOptions): StaticWebApp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        app_settings: Optional[Mapping[str, str]] = None,
        basic_auth: Optional[StaticWebAppBasicAuthArgs] = None,
        configuration_file_changes_enabled: Optional[bool] = None,
        default_host_name: Optional[str] = None,
        identity: Optional[StaticWebAppIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        preview_environments_enabled: Optional[bool] = None,
        public_network_access_enabled: Optional[bool] = None,
        repository_branch: Optional[str] = None,
        repository_token: Optional[str] = None,
        repository_url: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_size: Optional[str] = None,
        sku_tier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> StaticWebApp
func GetStaticWebApp(ctx *Context, name string, id IDInput, state *StaticWebAppState, opts ...ResourceOption) (*StaticWebApp, error)
public static StaticWebApp Get(string name, Input<string> id, StaticWebAppState? state, CustomResourceOptions? opts = null)
public static StaticWebApp get(String name, Output<String> id, StaticWebAppState state, CustomResourceOptions options)
resources:  _:    type: azure:appservice:StaticWebApp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
AppSettings Dictionary<string, string>
A key-value pair of App Settings.
BasicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
ConfigurationFileChangesEnabled bool
Should changes to the configuration file be permitted. Defaults to true.
DefaultHostName string
The default host name of the Static Web App.
Identity StaticWebAppIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
PreviewEnvironmentsEnabled bool
Are Preview (Staging) environments enabled. Defaults to true.
PublicNetworkAccessEnabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
RepositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
RepositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
RepositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
SkuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
SkuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ApiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
AppSettings map[string]string
A key-value pair of App Settings.
BasicAuth StaticWebAppBasicAuthArgs
A basic_auth block as defined below.
ConfigurationFileChangesEnabled bool
Should changes to the configuration file be permitted. Defaults to true.
DefaultHostName string
The default host name of the Static Web App.
Identity StaticWebAppIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
PreviewEnvironmentsEnabled bool
Are Preview (Staging) environments enabled. Defaults to true.
PublicNetworkAccessEnabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
RepositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
RepositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
RepositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
SkuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
SkuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
Tags map[string]string
A mapping of tags to assign to the resource.
apiKey String
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
appSettings Map<String,String>
A key-value pair of App Settings.
basicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
configurationFileChangesEnabled Boolean
Should changes to the configuration file be permitted. Defaults to true.
defaultHostName String
The default host name of the Static Web App.
identity StaticWebAppIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled Boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled Boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch String
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken String
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl String
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
skuSize String
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier String
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Map<String,String>
A mapping of tags to assign to the resource.
apiKey string
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
appSettings {[key: string]: string}
A key-value pair of App Settings.
basicAuth StaticWebAppBasicAuth
A basic_auth block as defined below.
configurationFileChangesEnabled boolean
Should changes to the configuration file be permitted. Defaults to true.
defaultHostName string
The default host name of the Static Web App.
identity StaticWebAppIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch string
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken string
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl string
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
skuSize string
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier string
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
api_key str
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
app_settings Mapping[str, str]
A key-value pair of App Settings.
basic_auth StaticWebAppBasicAuthArgs
A basic_auth block as defined below.
configuration_file_changes_enabled bool
Should changes to the configuration file be permitted. Defaults to true.
default_host_name str
The default host name of the Static Web App.
identity StaticWebAppIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
preview_environments_enabled bool
Are Preview (Staging) environments enabled. Defaults to true.
public_network_access_enabled bool
Should public network access be enabled for the Static Web App. Defaults to true.
repository_branch str
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repository_token str
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repository_url str
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
sku_size str
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
sku_tier str
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
apiKey String
The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, e.g. GitHub Action.
appSettings Map<String>
A key-value pair of App Settings.
basicAuth Property Map
A basic_auth block as defined below.
configurationFileChangesEnabled Boolean
Should changes to the configuration file be permitted. Defaults to true.
defaultHostName String
The default host name of the Static Web App.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.
previewEnvironmentsEnabled Boolean
Are Preview (Staging) environments enabled. Defaults to true.
publicNetworkAccessEnabled Boolean
Should public network access be enabled for the Static Web App. Defaults to true.
repositoryBranch String
Repository branch to use for the Static Web App. repository_url and repository_token must also be set.
repositoryToken String
Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.
repositoryUrl String
Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.
skuSize String
Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.
skuTier String
Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

StaticWebAppBasicAuth
, StaticWebAppBasicAuthArgs

Environments This property is required. string
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
Password This property is required. string
The password for the basic authentication access.
Environments This property is required. string
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
Password This property is required. string
The password for the basic authentication access.
environments This property is required. String
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
password This property is required. String
The password for the basic authentication access.
environments This property is required. string
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
password This property is required. string
The password for the basic authentication access.
environments This property is required. str
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
password This property is required. str
The password for the basic authentication access.
environments This property is required. String
The Environment types to use the Basic Auth for access. Possible values include AllEnvironments and StagingEnvironments.
password This property is required. String
The password for the basic authentication access.

StaticWebAppIdentity
, StaticWebAppIdentityArgs

Type This property is required. string
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
IdentityIds List<string>
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
PrincipalId string
TenantId string
Type This property is required. string
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
IdentityIds []string
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
PrincipalId string
TenantId string
type This property is required. String
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
identityIds List<String>
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
principalId String
tenantId String
type This property is required. string
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
identityIds string[]
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
principalId string
tenantId string
type This property is required. str
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
identity_ids Sequence[str]
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
principal_id str
tenant_id str
type This property is required. String
The Type of Managed Identity assigned to this Static Web App resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.
identityIds List<String>
A list of Managed Identity IDs which should be assigned to this Static Web App resource.
principalId String
tenantId String

Import

Static Web Apps can be imported using the resource id, e.g.

$ pulumi import azure:appservice/staticWebApp:StaticWebApp example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Web/staticSites/my-static-site1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure