1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. StaticSiteUserProvidedFunctionAppForStaticSiteBuild
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild

Explore with Pulumi AI

Static Site User Provided Function App ARM resource.

Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.

Other available API versions: 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

Example Usage

Register a user provided function app with a static site build

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var staticSiteUserProvidedFunctionAppForStaticSiteBuild = new AzureNative.Web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuild", new()
    {
        EnvironmentName = "default",
        FunctionAppName = "testFunctionApp",
        FunctionAppRegion = "West US 2",
        FunctionAppResourceId = "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
        IsForced = true,
        Name = "testStaticSite0",
        ResourceGroupName = "rg",
    });

});
Copy
package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewStaticSiteUserProvidedFunctionAppForStaticSiteBuild(ctx, "staticSiteUserProvidedFunctionAppForStaticSiteBuild", &web.StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs{
			EnvironmentName:       pulumi.String("default"),
			FunctionAppName:       pulumi.String("testFunctionApp"),
			FunctionAppRegion:     pulumi.String("West US 2"),
			FunctionAppResourceId: pulumi.String("/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp"),
			IsForced:              pulumi.Bool(true),
			Name:                  pulumi.String("testStaticSite0"),
			ResourceGroupName:     pulumi.String("rg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild;
import com.pulumi.azurenative.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs;
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 staticSiteUserProvidedFunctionAppForStaticSiteBuild = new StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuild", StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs.builder()
            .environmentName("default")
            .functionAppName("testFunctionApp")
            .functionAppRegion("West US 2")
            .functionAppResourceId("/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp")
            .isForced(true)
            .name("testStaticSite0")
            .resourceGroupName("rg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const staticSiteUserProvidedFunctionAppForStaticSiteBuild = new azure_native.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuild", {
    environmentName: "default",
    functionAppName: "testFunctionApp",
    functionAppRegion: "West US 2",
    functionAppResourceId: "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
    isForced: true,
    name: "testStaticSite0",
    resourceGroupName: "rg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

static_site_user_provided_function_app_for_static_site_build = azure_native.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuild",
    environment_name="default",
    function_app_name="testFunctionApp",
    function_app_region="West US 2",
    function_app_resource_id="/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
    is_forced=True,
    name="testStaticSite0",
    resource_group_name="rg")
Copy
resources:
  staticSiteUserProvidedFunctionAppForStaticSiteBuild:
    type: azure-native:web:StaticSiteUserProvidedFunctionAppForStaticSiteBuild
    properties:
      environmentName: default
      functionAppName: testFunctionApp
      functionAppRegion: West US 2
      functionAppResourceId: /subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp
      isForced: 'true'
      name: testStaticSite0
      resourceGroupName: rg
Copy

Create StaticSiteUserProvidedFunctionAppForStaticSiteBuild Resource

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

Constructor syntax

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

@overload
def StaticSiteUserProvidedFunctionAppForStaticSiteBuild(resource_name: str,
                                                        opts: Optional[ResourceOptions] = None,
                                                        environment_name: Optional[str] = None,
                                                        name: Optional[str] = None,
                                                        resource_group_name: Optional[str] = None,
                                                        function_app_name: Optional[str] = None,
                                                        function_app_region: Optional[str] = None,
                                                        function_app_resource_id: Optional[str] = None,
                                                        is_forced: Optional[bool] = None,
                                                        kind: Optional[str] = None)
func NewStaticSiteUserProvidedFunctionAppForStaticSiteBuild(ctx *Context, name string, args StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs, opts ...ResourceOption) (*StaticSiteUserProvidedFunctionAppForStaticSiteBuild, error)
public StaticSiteUserProvidedFunctionAppForStaticSiteBuild(string name, StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs args, CustomResourceOptions? opts = null)
public StaticSiteUserProvidedFunctionAppForStaticSiteBuild(String name, StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs args)
public StaticSiteUserProvidedFunctionAppForStaticSiteBuild(String name, StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs args, CustomResourceOptions options)
type: azure-native:web:StaticSiteUserProvidedFunctionAppForStaticSiteBuild
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. StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs
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. StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs
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. StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs
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. StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs
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. StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs
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 staticSiteUserProvidedFunctionAppForStaticSiteBuildResource = new AzureNative.Web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuildResource", new()
{
    EnvironmentName = "string",
    Name = "string",
    ResourceGroupName = "string",
    FunctionAppName = "string",
    FunctionAppRegion = "string",
    FunctionAppResourceId = "string",
    IsForced = false,
    Kind = "string",
});
Copy
example, err := web.NewStaticSiteUserProvidedFunctionAppForStaticSiteBuild(ctx, "staticSiteUserProvidedFunctionAppForStaticSiteBuildResource", &web.StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs{
	EnvironmentName:       pulumi.String("string"),
	Name:                  pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	FunctionAppName:       pulumi.String("string"),
	FunctionAppRegion:     pulumi.String("string"),
	FunctionAppResourceId: pulumi.String("string"),
	IsForced:              pulumi.Bool(false),
	Kind:                  pulumi.String("string"),
})
Copy
var staticSiteUserProvidedFunctionAppForStaticSiteBuildResource = new StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuildResource", StaticSiteUserProvidedFunctionAppForStaticSiteBuildArgs.builder()
    .environmentName("string")
    .name("string")
    .resourceGroupName("string")
    .functionAppName("string")
    .functionAppRegion("string")
    .functionAppResourceId("string")
    .isForced(false)
    .kind("string")
    .build());
Copy
static_site_user_provided_function_app_for_static_site_build_resource = azure_native.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuildResource",
    environment_name="string",
    name="string",
    resource_group_name="string",
    function_app_name="string",
    function_app_region="string",
    function_app_resource_id="string",
    is_forced=False,
    kind="string")
Copy
const staticSiteUserProvidedFunctionAppForStaticSiteBuildResource = new azure_native.web.StaticSiteUserProvidedFunctionAppForStaticSiteBuild("staticSiteUserProvidedFunctionAppForStaticSiteBuildResource", {
    environmentName: "string",
    name: "string",
    resourceGroupName: "string",
    functionAppName: "string",
    functionAppRegion: "string",
    functionAppResourceId: "string",
    isForced: false,
    kind: "string",
});
Copy
type: azure-native:web:StaticSiteUserProvidedFunctionAppForStaticSiteBuild
properties:
    environmentName: string
    functionAppName: string
    functionAppRegion: string
    functionAppResourceId: string
    isForced: false
    kind: string
    name: string
    resourceGroupName: string
Copy

StaticSiteUserProvidedFunctionAppForStaticSiteBuild 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 StaticSiteUserProvidedFunctionAppForStaticSiteBuild resource accepts the following input properties:

EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
The stage site identifier.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
FunctionAppName Changes to this property will trigger replacement. string
Name of the function app to register with the static site build.
FunctionAppRegion string
The region of the function app registered with the static site
FunctionAppResourceId string
The resource id of the function app registered with the static site
IsForced bool
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
Kind string
Kind of resource.
EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
The stage site identifier.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
FunctionAppName Changes to this property will trigger replacement. string
Name of the function app to register with the static site build.
FunctionAppRegion string
The region of the function app registered with the static site
FunctionAppResourceId string
The resource id of the function app registered with the static site
IsForced bool
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
Kind string
Kind of resource.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
The stage site identifier.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
functionAppName Changes to this property will trigger replacement. String
Name of the function app to register with the static site build.
functionAppRegion String
The region of the function app registered with the static site
functionAppResourceId String
The resource id of the function app registered with the static site
isForced Boolean
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
kind String
Kind of resource.
environmentName
This property is required.
Changes to this property will trigger replacement.
string
The stage site identifier.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
functionAppName Changes to this property will trigger replacement. string
Name of the function app to register with the static site build.
functionAppRegion string
The region of the function app registered with the static site
functionAppResourceId string
The resource id of the function app registered with the static site
isForced boolean
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
kind string
Kind of resource.
environment_name
This property is required.
Changes to this property will trigger replacement.
str
The stage site identifier.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the static site.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
function_app_name Changes to this property will trigger replacement. str
Name of the function app to register with the static site build.
function_app_region str
The region of the function app registered with the static site
function_app_resource_id str
The resource id of the function app registered with the static site
is_forced bool
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
kind str
Kind of resource.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
The stage site identifier.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
functionAppName Changes to this property will trigger replacement. String
Name of the function app to register with the static site build.
functionAppRegion String
The region of the function app registered with the static site
functionAppResourceId String
The resource id of the function app registered with the static site
isForced Boolean
Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.
kind String
Kind of resource.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
CreatedOn string
The date and time on which the function app was registered with the static site.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
CreatedOn string
The date and time on which the function app was registered with the static site.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
createdOn String
The date and time on which the function app was registered with the static site.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
createdOn string
The date and time on which the function app was registered with the static site.
id string
The provider-assigned unique ID for this managed resource.
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
created_on str
The date and time on which the function app was registered with the static site.
id str
The provider-assigned unique ID for this managed resource.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
createdOn String
The date and time on which the function app was registered with the static site.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:web:StaticSiteUserProvidedFunctionAppForStaticSiteBuild testFunctionApp /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0