StaticWebApp

class StaticWebApp : KotlinCustomResource

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,
});
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)
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,
});
});
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
})
}
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());
}
}
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}

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.Web: 2023-01-01

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

Properties

Link copied to clipboard
val apiKey: Output<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.

Link copied to clipboard
val appSettings: Output<Map<String, String>>?

A key-value pair of App Settings.

Link copied to clipboard

A basic_auth block as defined below.

Link copied to clipboard

Should changes to the configuration file be permitted. Defaults to true.

Link copied to clipboard
val defaultHostName: Output<String>

The default host name of the Static Web App.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An identity block as defined below.

Link copied to clipboard
val location: Output<String>

The Azure Region where the Static Web App should exist. Changing this forces a new Static Web App to be created.

Link copied to clipboard
val name: Output<String>

The name which should be used for this Static Web App. Changing this forces a new Static Web App to be created.

Link copied to clipboard

Are Preview (Staging) environments enabled. Defaults to true.

Link copied to clipboard

Should public network access be enabled for the Static Web App. Defaults to true.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val repositoryBranch: Output<String>?

Repository branch to use for the Static Web App. repository_url and repository_token must also be set.

Link copied to clipboard
val repositoryToken: Output<String>?

Repository Token with admin privileges to use for the Static Web App. repository_branch and repository_url must also be set.

Link copied to clipboard
val repositoryUrl: Output<String>?

Repository URL to use for the Static Web App. repository_branch and repository_token must also be set.

Link copied to clipboard

The name of the Resource Group where the Static Web App should exist. Changing this forces a new Static Web App to be created.

Link copied to clipboard
val skuSize: Output<String>?

Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free.

Link copied to clipboard
val skuTier: Output<String>?

Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val urn: Output<String>