We recommend using Azure Native.
azure.appservice.FunctionApp
Explore with Pulumi AI
Manages a Function App.
!> NOTE: This resource has been deprecated in version 5.0 of the provider and will be removed in version 6.0. Please use azure.appservice.LinuxFunctionApp
and azure.appservice.WindowsFunctionApp
resources instead.
Note: To connect an Azure Function App and a subnet within the same region
azure.appservice.VirtualNetworkSwiftConnection
can be used. For an example, check theazure.appservice.VirtualNetworkSwiftConnection
documentation.
Example Usage
With App Service Plan)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "azure-functions-test-rg",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "functionsapptestsa",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("example", {
name: "azure-functions-test-service-plan",
location: example.location,
resourceGroupName: example.name,
sku: {
tier: "Standard",
size: "S1",
},
});
const exampleFunctionApp = new azure.appservice.FunctionApp("example", {
name: "test-azure-functions",
location: example.location,
resourceGroupName: example.name,
appServicePlanId: examplePlan.id,
storageAccountName: exampleAccount.name,
storageAccountAccessKey: exampleAccount.primaryAccessKey,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="azure-functions-test-rg",
location="West Europe")
example_account = azure.storage.Account("example",
name="functionsapptestsa",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_plan = azure.appservice.Plan("example",
name="azure-functions-test-service-plan",
location=example.location,
resource_group_name=example.name,
sku={
"tier": "Standard",
"size": "S1",
})
example_function_app = azure.appservice.FunctionApp("example",
name="test-azure-functions",
location=example.location,
resource_group_name=example.name,
app_service_plan_id=example_plan.id,
storage_account_name=example_account.name,
storage_account_access_key=example_account.primary_access_key)
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-azure/sdk/v6/go/azure/storage"
"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("azure-functions-test-rg"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("functionsapptestsa"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
Name: pulumi.String("azure-functions-test-service-plan"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: &appservice.PlanSkuArgs{
Tier: pulumi.String("Standard"),
Size: pulumi.String("S1"),
},
})
if err != nil {
return err
}
_, err = appservice.NewFunctionApp(ctx, "example", &appservice.FunctionAppArgs{
Name: pulumi.String("test-azure-functions"),
Location: example.Location,
ResourceGroupName: example.Name,
AppServicePlanId: examplePlan.ID(),
StorageAccountName: exampleAccount.Name,
StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
})
if err != nil {
return err
}
return nil
})
}
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 = "azure-functions-test-rg",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "functionsapptestsa",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var examplePlan = new Azure.AppService.Plan("example", new()
{
Name = "azure-functions-test-service-plan",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = new Azure.AppService.Inputs.PlanSkuArgs
{
Tier = "Standard",
Size = "S1",
},
});
var exampleFunctionApp = new Azure.AppService.FunctionApp("example", new()
{
Name = "test-azure-functions",
Location = example.Location,
ResourceGroupName = example.Name,
AppServicePlanId = examplePlan.Id,
StorageAccountName = exampleAccount.Name,
StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.FunctionApp;
import com.pulumi.azure.appservice.FunctionAppArgs;
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("azure-functions-test-rg")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("functionsapptestsa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("azure-functions-test-service-plan")
.location(example.location())
.resourceGroupName(example.name())
.sku(PlanSkuArgs.builder()
.tier("Standard")
.size("S1")
.build())
.build());
var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
.name("test-azure-functions")
.location(example.location())
.resourceGroupName(example.name())
.appServicePlanId(examplePlan.id())
.storageAccountName(exampleAccount.name())
.storageAccountAccessKey(exampleAccount.primaryAccessKey())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: azure-functions-test-rg
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: functionsapptestsa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: azure-functions-test-service-plan
location: ${example.location}
resourceGroupName: ${example.name}
sku:
tier: Standard
size: S1
exampleFunctionApp:
type: azure:appservice:FunctionApp
name: example
properties:
name: test-azure-functions
location: ${example.location}
resourceGroupName: ${example.name}
appServicePlanId: ${examplePlan.id}
storageAccountName: ${exampleAccount.name}
storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
In A Consumption Plan)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "azure-functions-cptest-rg",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "functionsapptestsa",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("example", {
name: "azure-functions-test-service-plan",
location: example.location,
resourceGroupName: example.name,
kind: "FunctionApp",
sku: {
tier: "Dynamic",
size: "Y1",
},
});
const exampleFunctionApp = new azure.appservice.FunctionApp("example", {
name: "test-azure-functions",
location: example.location,
resourceGroupName: example.name,
appServicePlanId: examplePlan.id,
storageAccountName: exampleAccount.name,
storageAccountAccessKey: exampleAccount.primaryAccessKey,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="azure-functions-cptest-rg",
location="West Europe")
example_account = azure.storage.Account("example",
name="functionsapptestsa",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_plan = azure.appservice.Plan("example",
name="azure-functions-test-service-plan",
location=example.location,
resource_group_name=example.name,
kind="FunctionApp",
sku={
"tier": "Dynamic",
"size": "Y1",
})
example_function_app = azure.appservice.FunctionApp("example",
name="test-azure-functions",
location=example.location,
resource_group_name=example.name,
app_service_plan_id=example_plan.id,
storage_account_name=example_account.name,
storage_account_access_key=example_account.primary_access_key)
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-azure/sdk/v6/go/azure/storage"
"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("azure-functions-cptest-rg"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("functionsapptestsa"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
Name: pulumi.String("azure-functions-test-service-plan"),
Location: example.Location,
ResourceGroupName: example.Name,
Kind: pulumi.Any("FunctionApp"),
Sku: &appservice.PlanSkuArgs{
Tier: pulumi.String("Dynamic"),
Size: pulumi.String("Y1"),
},
})
if err != nil {
return err
}
_, err = appservice.NewFunctionApp(ctx, "example", &appservice.FunctionAppArgs{
Name: pulumi.String("test-azure-functions"),
Location: example.Location,
ResourceGroupName: example.Name,
AppServicePlanId: examplePlan.ID(),
StorageAccountName: exampleAccount.Name,
StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
})
if err != nil {
return err
}
return nil
})
}
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 = "azure-functions-cptest-rg",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "functionsapptestsa",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var examplePlan = new Azure.AppService.Plan("example", new()
{
Name = "azure-functions-test-service-plan",
Location = example.Location,
ResourceGroupName = example.Name,
Kind = "FunctionApp",
Sku = new Azure.AppService.Inputs.PlanSkuArgs
{
Tier = "Dynamic",
Size = "Y1",
},
});
var exampleFunctionApp = new Azure.AppService.FunctionApp("example", new()
{
Name = "test-azure-functions",
Location = example.Location,
ResourceGroupName = example.Name,
AppServicePlanId = examplePlan.Id,
StorageAccountName = exampleAccount.Name,
StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.FunctionApp;
import com.pulumi.azure.appservice.FunctionAppArgs;
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("azure-functions-cptest-rg")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("functionsapptestsa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("azure-functions-test-service-plan")
.location(example.location())
.resourceGroupName(example.name())
.kind("FunctionApp")
.sku(PlanSkuArgs.builder()
.tier("Dynamic")
.size("Y1")
.build())
.build());
var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
.name("test-azure-functions")
.location(example.location())
.resourceGroupName(example.name())
.appServicePlanId(examplePlan.id())
.storageAccountName(exampleAccount.name())
.storageAccountAccessKey(exampleAccount.primaryAccessKey())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: azure-functions-cptest-rg
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: functionsapptestsa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: azure-functions-test-service-plan
location: ${example.location}
resourceGroupName: ${example.name}
kind: FunctionApp
sku:
tier: Dynamic
size: Y1
exampleFunctionApp:
type: azure:appservice:FunctionApp
name: example
properties:
name: test-azure-functions
location: ${example.location}
resourceGroupName: ${example.name}
appServicePlanId: ${examplePlan.id}
storageAccountName: ${exampleAccount.name}
storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
Linux)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "azure-functions-cptest-rg",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "functionsapptestsa",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("example", {
name: "azure-functions-test-service-plan",
location: example.location,
resourceGroupName: example.name,
kind: "Linux",
reserved: true,
sku: {
tier: "Dynamic",
size: "Y1",
},
});
const exampleFunctionApp = new azure.appservice.FunctionApp("example", {
name: "test-azure-functions",
location: example.location,
resourceGroupName: example.name,
appServicePlanId: examplePlan.id,
storageAccountName: exampleAccount.name,
storageAccountAccessKey: exampleAccount.primaryAccessKey,
osType: "linux",
version: "~3",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="azure-functions-cptest-rg",
location="West Europe")
example_account = azure.storage.Account("example",
name="functionsapptestsa",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_plan = azure.appservice.Plan("example",
name="azure-functions-test-service-plan",
location=example.location,
resource_group_name=example.name,
kind="Linux",
reserved=True,
sku={
"tier": "Dynamic",
"size": "Y1",
})
example_function_app = azure.appservice.FunctionApp("example",
name="test-azure-functions",
location=example.location,
resource_group_name=example.name,
app_service_plan_id=example_plan.id,
storage_account_name=example_account.name,
storage_account_access_key=example_account.primary_access_key,
os_type="linux",
version="~3")
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-azure/sdk/v6/go/azure/storage"
"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("azure-functions-cptest-rg"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("functionsapptestsa"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
Name: pulumi.String("azure-functions-test-service-plan"),
Location: example.Location,
ResourceGroupName: example.Name,
Kind: pulumi.Any("Linux"),
Reserved: pulumi.Bool(true),
Sku: &appservice.PlanSkuArgs{
Tier: pulumi.String("Dynamic"),
Size: pulumi.String("Y1"),
},
})
if err != nil {
return err
}
_, err = appservice.NewFunctionApp(ctx, "example", &appservice.FunctionAppArgs{
Name: pulumi.String("test-azure-functions"),
Location: example.Location,
ResourceGroupName: example.Name,
AppServicePlanId: examplePlan.ID(),
StorageAccountName: exampleAccount.Name,
StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
OsType: pulumi.String("linux"),
Version: pulumi.String("~3"),
})
if err != nil {
return err
}
return nil
})
}
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 = "azure-functions-cptest-rg",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "functionsapptestsa",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var examplePlan = new Azure.AppService.Plan("example", new()
{
Name = "azure-functions-test-service-plan",
Location = example.Location,
ResourceGroupName = example.Name,
Kind = "Linux",
Reserved = true,
Sku = new Azure.AppService.Inputs.PlanSkuArgs
{
Tier = "Dynamic",
Size = "Y1",
},
});
var exampleFunctionApp = new Azure.AppService.FunctionApp("example", new()
{
Name = "test-azure-functions",
Location = example.Location,
ResourceGroupName = example.Name,
AppServicePlanId = examplePlan.Id,
StorageAccountName = exampleAccount.Name,
StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
OsType = "linux",
Version = "~3",
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.FunctionApp;
import com.pulumi.azure.appservice.FunctionAppArgs;
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("azure-functions-cptest-rg")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("functionsapptestsa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("azure-functions-test-service-plan")
.location(example.location())
.resourceGroupName(example.name())
.kind("Linux")
.reserved(true)
.sku(PlanSkuArgs.builder()
.tier("Dynamic")
.size("Y1")
.build())
.build());
var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
.name("test-azure-functions")
.location(example.location())
.resourceGroupName(example.name())
.appServicePlanId(examplePlan.id())
.storageAccountName(exampleAccount.name())
.storageAccountAccessKey(exampleAccount.primaryAccessKey())
.osType("linux")
.version("~3")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: azure-functions-cptest-rg
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: functionsapptestsa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: azure-functions-test-service-plan
location: ${example.location}
resourceGroupName: ${example.name}
kind: Linux
reserved: true
sku:
tier: Dynamic
size: Y1
exampleFunctionApp:
type: azure:appservice:FunctionApp
name: example
properties:
name: test-azure-functions
location: ${example.location}
resourceGroupName: ${example.name}
appServicePlanId: ${examplePlan.id}
storageAccountName: ${exampleAccount.name}
storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
osType: linux
version: ~3
Note: Version
~3
or~4
is required for Linux Function Apps.
Python In A Consumption Plan)
Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.FunctionApp;
import com.pulumi.azure.appservice.FunctionAppArgs;
import com.pulumi.azure.appservice.inputs.FunctionAppSiteConfigArgs;
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("azure-functions-example-rg")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("functionsappexamlpesa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("azure-functions-example-sp")
.location(example.location())
.resourceGroupName(example.name())
.kind("Linux")
.reserved(true)
.sku(PlanSkuArgs.builder()
.tier("Dynamic")
.size("Y1")
.build())
.build());
var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
.name("example-azure-function")
.location(example.location())
.resourceGroupName(example.name())
.appServicePlanId(examplePlan.id())
.storageAccountName(exampleAccount.name())
.storageAccountAccessKey(exampleAccount.primaryAccessKey())
.osType("linux")
.version("~4")
.appSettings(Map.of("FUNCTIONS_WORKER_RUNTIME", "python"))
.siteConfig(FunctionAppSiteConfigArgs.builder()
.linuxFxVersion("python|3.9")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: azure-functions-example-rg
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: functionsappexamlpesa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: azure-functions-example-sp
location: ${example.location}
resourceGroupName: ${example.name}
kind: Linux
reserved: true
sku:
tier: Dynamic
size: Y1
exampleFunctionApp:
type: azure:appservice:FunctionApp
name: example
properties:
name: example-azure-function
location: ${example.location}
resourceGroupName: ${example.name}
appServicePlanId: ${examplePlan.id}
storageAccountName: ${exampleAccount.name}
storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
osType: linux
version: ~4
appSettings:
- FUNCTIONS_WORKER_RUNTIME: python
siteConfig:
linuxFxVersion: python|3.9
Note: The Python runtime is only supported on a Linux based hosting plan. See the documentation for additional information.
Create FunctionApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FunctionApp(name: string, args: FunctionAppArgs, opts?: CustomResourceOptions);
@overload
def FunctionApp(resource_name: str,
args: FunctionAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FunctionApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_service_plan_id: Optional[str] = None,
storage_account_name: Optional[str] = None,
storage_account_access_key: Optional[str] = None,
resource_group_name: Optional[str] = None,
key_vault_reference_identity_id: Optional[str] = None,
os_type: Optional[str] = None,
enable_builtin_logging: Optional[bool] = None,
enabled: Optional[bool] = None,
https_only: Optional[bool] = None,
identity: Optional[FunctionAppIdentityArgs] = None,
connection_strings: Optional[Sequence[FunctionAppConnectionStringArgs]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
daily_memory_time_quota: Optional[int] = None,
client_cert_mode: Optional[str] = None,
site_config: Optional[FunctionAppSiteConfigArgs] = None,
source_control: Optional[FunctionAppSourceControlArgs] = None,
auth_settings: Optional[FunctionAppAuthSettingsArgs] = None,
app_settings: Optional[Mapping[str, str]] = None,
tags: Optional[Mapping[str, str]] = None,
version: Optional[str] = None)
func NewFunctionApp(ctx *Context, name string, args FunctionAppArgs, opts ...ResourceOption) (*FunctionApp, error)
public FunctionApp(string name, FunctionAppArgs args, CustomResourceOptions? opts = null)
public FunctionApp(String name, FunctionAppArgs args)
public FunctionApp(String name, FunctionAppArgs args, CustomResourceOptions options)
type: azure:appservice:FunctionApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FunctionAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FunctionAppArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FunctionAppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FunctionAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FunctionAppArgs
- 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 functionAppResource = new Azure.AppService.FunctionApp("functionAppResource", new()
{
AppServicePlanId = "string",
StorageAccountName = "string",
StorageAccountAccessKey = "string",
ResourceGroupName = "string",
KeyVaultReferenceIdentityId = "string",
OsType = "string",
EnableBuiltinLogging = false,
Enabled = false,
HttpsOnly = false,
Identity = new Azure.AppService.Inputs.FunctionAppIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
ConnectionStrings = new[]
{
new Azure.AppService.Inputs.FunctionAppConnectionStringArgs
{
Name = "string",
Type = "string",
Value = "string",
},
},
Location = "string",
Name = "string",
DailyMemoryTimeQuota = 0,
ClientCertMode = "string",
SiteConfig = new Azure.AppService.Inputs.FunctionAppSiteConfigArgs
{
AlwaysOn = false,
AppScaleLimit = 0,
AutoSwapSlotName = "string",
Cors = new Azure.AppService.Inputs.FunctionAppSiteConfigCorsArgs
{
AllowedOrigins = new[]
{
"string",
},
SupportCredentials = false,
},
DotnetFrameworkVersion = "string",
ElasticInstanceMinimum = 0,
FtpsState = "string",
HealthCheckPath = "string",
Http2Enabled = false,
IpRestrictions = new[]
{
new Azure.AppService.Inputs.FunctionAppSiteConfigIpRestrictionArgs
{
Action = "string",
Headers = new Azure.AppService.Inputs.FunctionAppSiteConfigIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
JavaVersion = "string",
LinuxFxVersion = "string",
MinTlsVersion = "string",
PreWarmedInstanceCount = 0,
RuntimeScaleMonitoringEnabled = false,
ScmIpRestrictions = new[]
{
new Azure.AppService.Inputs.FunctionAppSiteConfigScmIpRestrictionArgs
{
Action = "string",
Headers = new Azure.AppService.Inputs.FunctionAppSiteConfigScmIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
ScmType = "string",
ScmUseMainIpRestriction = false,
Use32BitWorkerProcess = false,
VnetRouteAllEnabled = false,
WebsocketsEnabled = false,
},
SourceControl = new Azure.AppService.Inputs.FunctionAppSourceControlArgs
{
Branch = "string",
ManualIntegration = false,
RepoUrl = "string",
RollbackEnabled = false,
UseMercurial = false,
},
AuthSettings = new Azure.AppService.Inputs.FunctionAppAuthSettingsArgs
{
Enabled = false,
Google = new Azure.AppService.Inputs.FunctionAppAuthSettingsGoogleArgs
{
ClientId = "string",
ClientSecret = "string",
OauthScopes = new[]
{
"string",
},
},
AllowedExternalRedirectUrls = new[]
{
"string",
},
DefaultProvider = "string",
AdditionalLoginParams =
{
{ "string", "string" },
},
Facebook = new Azure.AppService.Inputs.FunctionAppAuthSettingsFacebookArgs
{
AppId = "string",
AppSecret = "string",
OauthScopes = new[]
{
"string",
},
},
ActiveDirectory = new Azure.AppService.Inputs.FunctionAppAuthSettingsActiveDirectoryArgs
{
ClientId = "string",
AllowedAudiences = new[]
{
"string",
},
ClientSecret = "string",
},
Issuer = "string",
Microsoft = new Azure.AppService.Inputs.FunctionAppAuthSettingsMicrosoftArgs
{
ClientId = "string",
ClientSecret = "string",
OauthScopes = new[]
{
"string",
},
},
RuntimeVersion = "string",
TokenRefreshExtensionHours = 0,
TokenStoreEnabled = false,
Twitter = new Azure.AppService.Inputs.FunctionAppAuthSettingsTwitterArgs
{
ConsumerKey = "string",
ConsumerSecret = "string",
},
UnauthenticatedClientAction = "string",
},
AppSettings =
{
{ "string", "string" },
},
Tags =
{
{ "string", "string" },
},
Version = "string",
});
example, err := appservice.NewFunctionApp(ctx, "functionAppResource", &appservice.FunctionAppArgs{
AppServicePlanId: pulumi.String("string"),
StorageAccountName: pulumi.String("string"),
StorageAccountAccessKey: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
KeyVaultReferenceIdentityId: pulumi.String("string"),
OsType: pulumi.String("string"),
EnableBuiltinLogging: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
HttpsOnly: pulumi.Bool(false),
Identity: &appservice.FunctionAppIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
ConnectionStrings: appservice.FunctionAppConnectionStringArray{
&appservice.FunctionAppConnectionStringArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
DailyMemoryTimeQuota: pulumi.Int(0),
ClientCertMode: pulumi.String("string"),
SiteConfig: &appservice.FunctionAppSiteConfigArgs{
AlwaysOn: pulumi.Bool(false),
AppScaleLimit: pulumi.Int(0),
AutoSwapSlotName: pulumi.String("string"),
Cors: &appservice.FunctionAppSiteConfigCorsArgs{
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
SupportCredentials: pulumi.Bool(false),
},
DotnetFrameworkVersion: pulumi.String("string"),
ElasticInstanceMinimum: pulumi.Int(0),
FtpsState: pulumi.String("string"),
HealthCheckPath: pulumi.String("string"),
Http2Enabled: pulumi.Bool(false),
IpRestrictions: appservice.FunctionAppSiteConfigIpRestrictionArray{
&appservice.FunctionAppSiteConfigIpRestrictionArgs{
Action: pulumi.String("string"),
Headers: &appservice.FunctionAppSiteConfigIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
JavaVersion: pulumi.String("string"),
LinuxFxVersion: pulumi.String("string"),
MinTlsVersion: pulumi.String("string"),
PreWarmedInstanceCount: pulumi.Int(0),
RuntimeScaleMonitoringEnabled: pulumi.Bool(false),
ScmIpRestrictions: appservice.FunctionAppSiteConfigScmIpRestrictionArray{
&appservice.FunctionAppSiteConfigScmIpRestrictionArgs{
Action: pulumi.String("string"),
Headers: &appservice.FunctionAppSiteConfigScmIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
ScmType: pulumi.String("string"),
ScmUseMainIpRestriction: pulumi.Bool(false),
Use32BitWorkerProcess: pulumi.Bool(false),
VnetRouteAllEnabled: pulumi.Bool(false),
WebsocketsEnabled: pulumi.Bool(false),
},
SourceControl: &appservice.FunctionAppSourceControlArgs{
Branch: pulumi.String("string"),
ManualIntegration: pulumi.Bool(false),
RepoUrl: pulumi.String("string"),
RollbackEnabled: pulumi.Bool(false),
UseMercurial: pulumi.Bool(false),
},
AuthSettings: &appservice.FunctionAppAuthSettingsArgs{
Enabled: pulumi.Bool(false),
Google: &appservice.FunctionAppAuthSettingsGoogleArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
DefaultProvider: pulumi.String("string"),
AdditionalLoginParams: pulumi.StringMap{
"string": pulumi.String("string"),
},
Facebook: &appservice.FunctionAppAuthSettingsFacebookArgs{
AppId: pulumi.String("string"),
AppSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ActiveDirectory: &appservice.FunctionAppAuthSettingsActiveDirectoryArgs{
ClientId: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecret: pulumi.String("string"),
},
Issuer: pulumi.String("string"),
Microsoft: &appservice.FunctionAppAuthSettingsMicrosoftArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RuntimeVersion: pulumi.String("string"),
TokenRefreshExtensionHours: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
Twitter: &appservice.FunctionAppAuthSettingsTwitterArgs{
ConsumerKey: pulumi.String("string"),
ConsumerSecret: pulumi.String("string"),
},
UnauthenticatedClientAction: pulumi.String("string"),
},
AppSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Version: pulumi.String("string"),
})
var functionAppResource = new FunctionApp("functionAppResource", FunctionAppArgs.builder()
.appServicePlanId("string")
.storageAccountName("string")
.storageAccountAccessKey("string")
.resourceGroupName("string")
.keyVaultReferenceIdentityId("string")
.osType("string")
.enableBuiltinLogging(false)
.enabled(false)
.httpsOnly(false)
.identity(FunctionAppIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.connectionStrings(FunctionAppConnectionStringArgs.builder()
.name("string")
.type("string")
.value("string")
.build())
.location("string")
.name("string")
.dailyMemoryTimeQuota(0)
.clientCertMode("string")
.siteConfig(FunctionAppSiteConfigArgs.builder()
.alwaysOn(false)
.appScaleLimit(0)
.autoSwapSlotName("string")
.cors(FunctionAppSiteConfigCorsArgs.builder()
.allowedOrigins("string")
.supportCredentials(false)
.build())
.dotnetFrameworkVersion("string")
.elasticInstanceMinimum(0)
.ftpsState("string")
.healthCheckPath("string")
.http2Enabled(false)
.ipRestrictions(FunctionAppSiteConfigIpRestrictionArgs.builder()
.action("string")
.headers(FunctionAppSiteConfigIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.javaVersion("string")
.linuxFxVersion("string")
.minTlsVersion("string")
.preWarmedInstanceCount(0)
.runtimeScaleMonitoringEnabled(false)
.scmIpRestrictions(FunctionAppSiteConfigScmIpRestrictionArgs.builder()
.action("string")
.headers(FunctionAppSiteConfigScmIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.scmType("string")
.scmUseMainIpRestriction(false)
.use32BitWorkerProcess(false)
.vnetRouteAllEnabled(false)
.websocketsEnabled(false)
.build())
.sourceControl(FunctionAppSourceControlArgs.builder()
.branch("string")
.manualIntegration(false)
.repoUrl("string")
.rollbackEnabled(false)
.useMercurial(false)
.build())
.authSettings(FunctionAppAuthSettingsArgs.builder()
.enabled(false)
.google(FunctionAppAuthSettingsGoogleArgs.builder()
.clientId("string")
.clientSecret("string")
.oauthScopes("string")
.build())
.allowedExternalRedirectUrls("string")
.defaultProvider("string")
.additionalLoginParams(Map.of("string", "string"))
.facebook(FunctionAppAuthSettingsFacebookArgs.builder()
.appId("string")
.appSecret("string")
.oauthScopes("string")
.build())
.activeDirectory(FunctionAppAuthSettingsActiveDirectoryArgs.builder()
.clientId("string")
.allowedAudiences("string")
.clientSecret("string")
.build())
.issuer("string")
.microsoft(FunctionAppAuthSettingsMicrosoftArgs.builder()
.clientId("string")
.clientSecret("string")
.oauthScopes("string")
.build())
.runtimeVersion("string")
.tokenRefreshExtensionHours(0)
.tokenStoreEnabled(false)
.twitter(FunctionAppAuthSettingsTwitterArgs.builder()
.consumerKey("string")
.consumerSecret("string")
.build())
.unauthenticatedClientAction("string")
.build())
.appSettings(Map.of("string", "string"))
.tags(Map.of("string", "string"))
.version("string")
.build());
function_app_resource = azure.appservice.FunctionApp("functionAppResource",
app_service_plan_id="string",
storage_account_name="string",
storage_account_access_key="string",
resource_group_name="string",
key_vault_reference_identity_id="string",
os_type="string",
enable_builtin_logging=False,
enabled=False,
https_only=False,
identity={
"type": "string",
"identityIds": ["string"],
"principalId": "string",
"tenantId": "string",
},
connection_strings=[{
"name": "string",
"type": "string",
"value": "string",
}],
location="string",
name="string",
daily_memory_time_quota=0,
client_cert_mode="string",
site_config={
"alwaysOn": False,
"appScaleLimit": 0,
"autoSwapSlotName": "string",
"cors": {
"allowedOrigins": ["string"],
"supportCredentials": False,
},
"dotnetFrameworkVersion": "string",
"elasticInstanceMinimum": 0,
"ftpsState": "string",
"healthCheckPath": "string",
"http2Enabled": False,
"ipRestrictions": [{
"action": "string",
"headers": {
"xAzureFdids": ["string"],
"xFdHealthProbe": "string",
"xForwardedFors": ["string"],
"xForwardedHosts": ["string"],
},
"ipAddress": "string",
"name": "string",
"priority": 0,
"serviceTag": "string",
"virtualNetworkSubnetId": "string",
}],
"javaVersion": "string",
"linuxFxVersion": "string",
"minTlsVersion": "string",
"preWarmedInstanceCount": 0,
"runtimeScaleMonitoringEnabled": False,
"scmIpRestrictions": [{
"action": "string",
"headers": {
"xAzureFdids": ["string"],
"xFdHealthProbe": "string",
"xForwardedFors": ["string"],
"xForwardedHosts": ["string"],
},
"ipAddress": "string",
"name": "string",
"priority": 0,
"serviceTag": "string",
"virtualNetworkSubnetId": "string",
}],
"scmType": "string",
"scmUseMainIpRestriction": False,
"use32BitWorkerProcess": False,
"vnetRouteAllEnabled": False,
"websocketsEnabled": False,
},
source_control={
"branch": "string",
"manualIntegration": False,
"repoUrl": "string",
"rollbackEnabled": False,
"useMercurial": False,
},
auth_settings={
"enabled": False,
"google": {
"clientId": "string",
"clientSecret": "string",
"oauthScopes": ["string"],
},
"allowedExternalRedirectUrls": ["string"],
"defaultProvider": "string",
"additionalLoginParams": {
"string": "string",
},
"facebook": {
"appId": "string",
"appSecret": "string",
"oauthScopes": ["string"],
},
"activeDirectory": {
"clientId": "string",
"allowedAudiences": ["string"],
"clientSecret": "string",
},
"issuer": "string",
"microsoft": {
"clientId": "string",
"clientSecret": "string",
"oauthScopes": ["string"],
},
"runtimeVersion": "string",
"tokenRefreshExtensionHours": 0,
"tokenStoreEnabled": False,
"twitter": {
"consumerKey": "string",
"consumerSecret": "string",
},
"unauthenticatedClientAction": "string",
},
app_settings={
"string": "string",
},
tags={
"string": "string",
},
version="string")
const functionAppResource = new azure.appservice.FunctionApp("functionAppResource", {
appServicePlanId: "string",
storageAccountName: "string",
storageAccountAccessKey: "string",
resourceGroupName: "string",
keyVaultReferenceIdentityId: "string",
osType: "string",
enableBuiltinLogging: false,
enabled: false,
httpsOnly: false,
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
connectionStrings: [{
name: "string",
type: "string",
value: "string",
}],
location: "string",
name: "string",
dailyMemoryTimeQuota: 0,
clientCertMode: "string",
siteConfig: {
alwaysOn: false,
appScaleLimit: 0,
autoSwapSlotName: "string",
cors: {
allowedOrigins: ["string"],
supportCredentials: false,
},
dotnetFrameworkVersion: "string",
elasticInstanceMinimum: 0,
ftpsState: "string",
healthCheckPath: "string",
http2Enabled: false,
ipRestrictions: [{
action: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
javaVersion: "string",
linuxFxVersion: "string",
minTlsVersion: "string",
preWarmedInstanceCount: 0,
runtimeScaleMonitoringEnabled: false,
scmIpRestrictions: [{
action: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
scmType: "string",
scmUseMainIpRestriction: false,
use32BitWorkerProcess: false,
vnetRouteAllEnabled: false,
websocketsEnabled: false,
},
sourceControl: {
branch: "string",
manualIntegration: false,
repoUrl: "string",
rollbackEnabled: false,
useMercurial: false,
},
authSettings: {
enabled: false,
google: {
clientId: "string",
clientSecret: "string",
oauthScopes: ["string"],
},
allowedExternalRedirectUrls: ["string"],
defaultProvider: "string",
additionalLoginParams: {
string: "string",
},
facebook: {
appId: "string",
appSecret: "string",
oauthScopes: ["string"],
},
activeDirectory: {
clientId: "string",
allowedAudiences: ["string"],
clientSecret: "string",
},
issuer: "string",
microsoft: {
clientId: "string",
clientSecret: "string",
oauthScopes: ["string"],
},
runtimeVersion: "string",
tokenRefreshExtensionHours: 0,
tokenStoreEnabled: false,
twitter: {
consumerKey: "string",
consumerSecret: "string",
},
unauthenticatedClientAction: "string",
},
appSettings: {
string: "string",
},
tags: {
string: "string",
},
version: "string",
});
type: azure:appservice:FunctionApp
properties:
appServicePlanId: string
appSettings:
string: string
authSettings:
activeDirectory:
allowedAudiences:
- string
clientId: string
clientSecret: string
additionalLoginParams:
string: string
allowedExternalRedirectUrls:
- string
defaultProvider: string
enabled: false
facebook:
appId: string
appSecret: string
oauthScopes:
- string
google:
clientId: string
clientSecret: string
oauthScopes:
- string
issuer: string
microsoft:
clientId: string
clientSecret: string
oauthScopes:
- string
runtimeVersion: string
tokenRefreshExtensionHours: 0
tokenStoreEnabled: false
twitter:
consumerKey: string
consumerSecret: string
unauthenticatedClientAction: string
clientCertMode: string
connectionStrings:
- name: string
type: string
value: string
dailyMemoryTimeQuota: 0
enableBuiltinLogging: false
enabled: false
httpsOnly: false
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
keyVaultReferenceIdentityId: string
location: string
name: string
osType: string
resourceGroupName: string
siteConfig:
alwaysOn: false
appScaleLimit: 0
autoSwapSlotName: string
cors:
allowedOrigins:
- string
supportCredentials: false
dotnetFrameworkVersion: string
elasticInstanceMinimum: 0
ftpsState: string
healthCheckPath: string
http2Enabled: false
ipRestrictions:
- action: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
javaVersion: string
linuxFxVersion: string
minTlsVersion: string
preWarmedInstanceCount: 0
runtimeScaleMonitoringEnabled: false
scmIpRestrictions:
- action: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
scmType: string
scmUseMainIpRestriction: false
use32BitWorkerProcess: false
vnetRouteAllEnabled: false
websocketsEnabled: false
sourceControl:
branch: string
manualIntegration: false
repoUrl: string
rollbackEnabled: false
useMercurial: false
storageAccountAccessKey: string
storageAccountName: string
tags:
string: string
version: string
FunctionApp Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The FunctionApp resource accepts the following input properties:
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- Resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- Storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- App
Settings Dictionary<string, string> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- Auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - Client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - Connection
Strings List<FunctionApp Connection String> - An
connection_string
block as defined below. - Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- Enable
Builtin boolLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - Enabled bool
- Is the Function App enabled? Defaults to
true
. - Https
Only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - Identity
Function
App Identity - An
identity
block as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- Os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- Site
Config FunctionApp Site Config - A
site_config
object as defined below. - Source
Control FunctionApp Source Control - A
source_control
block, as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Version string
- The runtime version associated with the Function App. Defaults to
~1
.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- Resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- Storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- App
Settings map[string]string A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- Auth
Settings FunctionApp Auth Settings Args - A
auth_settings
block as defined below. - Client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - Connection
Strings []FunctionApp Connection String Args - An
connection_string
block as defined below. - Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- Enable
Builtin boolLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - Enabled bool
- Is the Function App enabled? Defaults to
true
. - Https
Only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - Identity
Function
App Identity Args - An
identity
block as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- Os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- Site
Config FunctionApp Site Config Args - A
site_config
object as defined below. - Source
Control FunctionApp Source Control Args - A
source_control
block, as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- Version string
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this Function App.
- resource
Group StringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- storage
Account StringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account StringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- app
Settings Map<String,String> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - client
Cert StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings List<FunctionApp Connection String> - An
connection_string
block as defined below. - daily
Memory IntegerTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- enable
Builtin BooleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled Boolean
- Is the Function App enabled? Defaults to
true
. - https
Only Boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity - An
identity
block as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type String A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- site
Config FunctionApp Site Config - A
site_config
object as defined below. - source
Control FunctionApp Source Control - A
source_control
block, as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- version String
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- app
Settings {[key: string]: string} A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings FunctionApp Connection String[] - An
connection_string
block as defined below. - daily
Memory numberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- enable
Builtin booleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled boolean
- Is the Function App enabled? Defaults to
true
. - https
Only boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity - An
identity
block as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- site
Config FunctionApp Site Config - A
site_config
object as defined below. - source
Control FunctionApp Source Control - A
source_control
block, as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- version string
- The runtime version associated with the Function App. Defaults to
~1
.
- app_
service_ strplan_ id - The ID of the App Service Plan within which to create this Function App.
- resource_
group_ strname - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- storage_
account_ straccess_ key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage_
account_ strname - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- app_
settings Mapping[str, str] A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth_
settings FunctionApp Auth Settings Args - A
auth_settings
block as defined below. - client_
cert_ strmode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection_
strings Sequence[FunctionApp Connection String Args] - An
connection_string
block as defined below. - daily_
memory_ inttime_ quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- enable_
builtin_ boollogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled bool
- Is the Function App enabled? Defaults to
true
. - https_
only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity Args - An
identity
block as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os_
type str A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- site_
config FunctionApp Site Config Args - A
site_config
object as defined below. - source_
control FunctionApp Source Control Args - A
source_control
block, as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- version str
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this Function App.
- resource
Group StringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- storage
Account StringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account StringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- app
Settings Map<String> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings Property Map - A
auth_settings
block as defined below. - client
Cert StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings List<Property Map> - An
connection_string
block as defined below. - daily
Memory NumberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- enable
Builtin BooleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled Boolean
- Is the Function App enabled? Defaults to
true
. - https
Only Boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity Property Map
- An
identity
block as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type String A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- site
Config Property Map - A
site_config
object as defined below. - source
Control Property Map - A
source_control
block, as defined below. - Map<String>
- A mapping of tags to assign to the resource.
- version String
- The runtime version associated with the Function App. Defaults to
~1
.
Outputs
All input properties are implicitly available as output properties. Additionally, the FunctionApp resource produces the following output properties:
- Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- The Function App kind - such as
functionapp,linux,container
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Site
Credentials List<FunctionApp Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- The Function App kind - such as
functionapp,linux,container
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Site
Credentials []FunctionApp Site Credential - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- The Function App kind - such as
functionapp,linux,container
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials List<FunctionApp Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- id string
- The provider-assigned unique ID for this managed resource.
- kind string
- The Function App kind - such as
functionapp,linux,container
- outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials FunctionApp Site Credential[] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom_
domain_ strverification_ id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
hostname str - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- id str
- The provider-assigned unique ID for this managed resource.
- kind str
- The Function App kind - such as
functionapp,linux,container
- outbound_
ip_ straddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible_
outbound_ strip_ addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site_
credentials Sequence[FunctionApp Site Credential] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- The Function App kind - such as
functionapp,linux,container
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials List<Property Map> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
Look up Existing FunctionApp Resource
Get an existing FunctionApp 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?: FunctionAppState, opts?: CustomResourceOptions): FunctionApp
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_service_plan_id: Optional[str] = None,
app_settings: Optional[Mapping[str, str]] = None,
auth_settings: Optional[FunctionAppAuthSettingsArgs] = None,
client_cert_mode: Optional[str] = None,
connection_strings: Optional[Sequence[FunctionAppConnectionStringArgs]] = None,
custom_domain_verification_id: Optional[str] = None,
daily_memory_time_quota: Optional[int] = None,
default_hostname: Optional[str] = None,
enable_builtin_logging: Optional[bool] = None,
enabled: Optional[bool] = None,
https_only: Optional[bool] = None,
identity: Optional[FunctionAppIdentityArgs] = None,
key_vault_reference_identity_id: Optional[str] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
os_type: Optional[str] = None,
outbound_ip_addresses: Optional[str] = None,
possible_outbound_ip_addresses: Optional[str] = None,
resource_group_name: Optional[str] = None,
site_config: Optional[FunctionAppSiteConfigArgs] = None,
site_credentials: Optional[Sequence[FunctionAppSiteCredentialArgs]] = None,
source_control: Optional[FunctionAppSourceControlArgs] = None,
storage_account_access_key: Optional[str] = None,
storage_account_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
version: Optional[str] = None) -> FunctionApp
func GetFunctionApp(ctx *Context, name string, id IDInput, state *FunctionAppState, opts ...ResourceOption) (*FunctionApp, error)
public static FunctionApp Get(string name, Input<string> id, FunctionAppState? state, CustomResourceOptions? opts = null)
public static FunctionApp get(String name, Output<String> id, FunctionAppState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- App
Settings Dictionary<string, string> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- Auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - Client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - Connection
Strings List<FunctionApp Connection String> - An
connection_string
block as defined below. - Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- Default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- Enable
Builtin boolLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - Enabled bool
- Is the Function App enabled? Defaults to
true
. - Https
Only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - Identity
Function
App Identity - An
identity
block as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- Kind string
- The Function App kind - such as
functionapp,linux,container
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- Os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- Site
Config FunctionApp Site Config - A
site_config
object as defined below. - Site
Credentials List<FunctionApp Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - Source
Control FunctionApp Source Control - A
source_control
block, as defined below. - Storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Version string
- The runtime version associated with the Function App. Defaults to
~1
.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- App
Settings map[string]string A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- Auth
Settings FunctionApp Auth Settings Args - A
auth_settings
block as defined below. - Client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - Connection
Strings []FunctionApp Connection String Args - An
connection_string
block as defined below. - Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- Default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- Enable
Builtin boolLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - Enabled bool
- Is the Function App enabled? Defaults to
true
. - Https
Only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - Identity
Function
App Identity Args - An
identity
block as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- Kind string
- The Function App kind - such as
functionapp,linux,container
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- Os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- Site
Config FunctionApp Site Config Args - A
site_config
object as defined below. - Site
Credentials []FunctionApp Site Credential Args - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - Source
Control FunctionApp Source Control Args - A
source_control
block, as defined below. - Storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource.
- Version string
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this Function App.
- app
Settings Map<String,String> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - client
Cert StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings List<FunctionApp Connection String> - An
connection_string
block as defined below. - custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory IntegerTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- default
Hostname String - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- enable
Builtin BooleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled Boolean
- Is the Function App enabled? Defaults to
true
. - https
Only Boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity - An
identity
block as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- kind String
- The Function App kind - such as
functionapp,linux,container
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type String A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group StringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- site
Config FunctionApp Site Config - A
site_config
object as defined below. - site
Credentials List<FunctionApp Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control FunctionApp Source Control - A
source_control
block, as defined below. - storage
Account StringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account StringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource.
- version String
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service stringPlan Id - The ID of the App Service Plan within which to create this Function App.
- app
Settings {[key: string]: string} A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings FunctionApp Auth Settings - A
auth_settings
block as defined below. - client
Cert stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings FunctionApp Connection String[] - An
connection_string
block as defined below. - custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory numberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- default
Hostname string - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- enable
Builtin booleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled boolean
- Is the Function App enabled? Defaults to
true
. - https
Only boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity - An
identity
block as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- kind string
- The Function App kind - such as
functionapp,linux,container
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type string A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group stringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- site
Config FunctionApp Site Config - A
site_config
object as defined below. - site
Credentials FunctionApp Site Credential[] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control FunctionApp Source Control - A
source_control
block, as defined below. - storage
Account stringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account stringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- version string
- The runtime version associated with the Function App. Defaults to
~1
.
- app_
service_ strplan_ id - The ID of the App Service Plan within which to create this Function App.
- app_
settings Mapping[str, str] A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth_
settings FunctionApp Auth Settings Args - A
auth_settings
block as defined below. - client_
cert_ strmode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection_
strings Sequence[FunctionApp Connection String Args] - An
connection_string
block as defined below. - custom_
domain_ strverification_ id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily_
memory_ inttime_ quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- default_
hostname str - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- enable_
builtin_ boollogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled bool
- Is the Function App enabled? Defaults to
true
. - https_
only bool - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity
Function
App Identity Args - An
identity
block as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- kind str
- The Function App kind - such as
functionapp,linux,container
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os_
type str A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- outbound_
ip_ straddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible_
outbound_ strip_ addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource_
group_ strname - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- site_
config FunctionApp Site Config Args - A
site_config
object as defined below. - site_
credentials Sequence[FunctionApp Site Credential Args] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source_
control FunctionApp Source Control Args - A
source_control
block, as defined below. - storage_
account_ straccess_ key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage_
account_ strname - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- version str
- The runtime version associated with the Function App. Defaults to
~1
.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this Function App.
- app
Settings Map<String> A map of key-value pairs for App Settings and custom values.
NOTE: The values for
AzureWebJobsStorage
andFUNCTIONS_EXTENSION_VERSION
will be filled by other input arguments and shouldn't be configured separately.AzureWebJobsStorage
is filled based onstorage_account_name
andstorage_account_access_key
.FUNCTIONS_EXTENSION_VERSION
is filled based onversion
.- auth
Settings Property Map - A
auth_settings
block as defined below. - client
Cert StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required
andOptional
. - connection
Strings List<Property Map> - An
connection_string
block as defined below. - custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory NumberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan.
- default
Hostname String - The default hostname associated with the Function App - such as
mysite.azurewebsites.net
- enable
Builtin BooleanLogging - Should the built-in logging of this Function App be enabled? Defaults to
true
. - enabled Boolean
- Is the Function App enabled? Defaults to
true
. - https
Only Boolean - Can the Function App only be accessed via HTTPS? Defaults to
false
. - identity Property Map
- An
identity
block as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See Access vaults with a user-assigned identity for more information.
- kind String
- The Function App kind - such as
functionapp,linux,container
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Function App. Changing this forces a new resource to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule.
- os
Type String A string indicating the Operating System type for this function app. Possible values are
linux
and ``(empty string). Changing this forces a new resource to be created. Defaults to""
.NOTE: This value will be
linux
for Linux derivatives, or an empty string for Windows (default). When set tolinux
you must also setazure.appservice.Plan
arguments askind = "Linux"
andreserved = true
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group StringName - The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.
- site
Config Property Map - A
site_config
object as defined below. - site
Credentials List<Property Map> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control Property Map - A
source_control
block, as defined below. - storage
Account StringAccess Key The access key which will be used to access the backend storage account for the Function App.
Note: When integrating a
CI/CD pipeline
and expecting to run from a deployed package inAzure
you must seed yourapp settings
as part of the application code for function app to be successfully deployed.Important Default key pairs
: ("WEBSITE_RUN_FROM_PACKAGE" = ""
,"FUNCTIONS_WORKER_RUNTIME" = "node"
(or python, etc),"WEBSITE_NODE_DEFAULT_VERSION" = "10.14.1"
,"APPINSIGHTS_INSTRUMENTATIONKEY" = ""
).Note: When using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- storage
Account StringName - The backend storage account name which will be used by this Function App (such as the dashboard, logs). Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the resource.
- version String
- The runtime version associated with the Function App. Defaults to
~1
.
Supporting Types
FunctionAppAuthSettings, FunctionAppAuthSettingsArgs
- Enabled bool
- Is Authentication enabled?
- Active
Directory FunctionApp Auth Settings Active Directory - A
active_directory
block as defined below. - Additional
Login Dictionary<string, string>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- Allowed
External List<string>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- Default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- Facebook
Function
App Auth Settings Facebook - A
facebook
block as defined below. - Google
Function
App Auth Settings Google - A
google
block as defined below. - Issuer string
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Function
App Auth Settings Microsoft - A
microsoft
block as defined below. - Runtime
Version string - The runtime version of the Authentication/Authorization module.
- Token
Refresh doubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - Token
Store boolEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - Twitter
Function
App Auth Settings Twitter - A
twitter
block as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- Enabled bool
- Is Authentication enabled?
- Active
Directory FunctionApp Auth Settings Active Directory - A
active_directory
block as defined below. - Additional
Login map[string]stringParams - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- Allowed
External []stringRedirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- Default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- Facebook
Function
App Auth Settings Facebook - A
facebook
block as defined below. - Google
Function
App Auth Settings Google - A
google
block as defined below. - Issuer string
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Function
App Auth Settings Microsoft - A
microsoft
block as defined below. - Runtime
Version string - The runtime version of the Authentication/Authorization module.
- Token
Refresh float64Extension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - Token
Store boolEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - Twitter
Function
App Auth Settings Twitter - A
twitter
block as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled Boolean
- Is Authentication enabled?
- active
Directory FunctionApp Auth Settings Active Directory - A
active_directory
block as defined below. - additional
Login Map<String,String>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
External List<String>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider String The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
Function
App Auth Settings Facebook - A
facebook
block as defined below. - google
Function
App Auth Settings Google - A
google
block as defined below. - issuer String
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Function
App Auth Settings Microsoft - A
microsoft
block as defined below. - runtime
Version String - The runtime version of the Authentication/Authorization module.
- token
Refresh DoubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store BooleanEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
Function
App Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled boolean
- Is Authentication enabled?
- active
Directory FunctionApp Auth Settings Active Directory - A
active_directory
block as defined below. - additional
Login {[key: string]: string}Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
External string[]Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
Function
App Auth Settings Facebook - A
facebook
block as defined below. - google
Function
App Auth Settings Google - A
google
block as defined below. - issuer string
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Function
App Auth Settings Microsoft - A
microsoft
block as defined below. - runtime
Version string - The runtime version of the Authentication/Authorization module.
- token
Refresh numberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store booleanEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
Function
App Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled bool
- Is Authentication enabled?
- active_
directory FunctionApp Auth Settings Active Directory - A
active_directory
block as defined below. - additional_
login_ Mapping[str, str]params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed_
external_ Sequence[str]redirect_ urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default_
provider str The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
Function
App Auth Settings Facebook - A
facebook
block as defined below. - google
Function
App Auth Settings Google - A
google
block as defined below. - issuer str
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Function
App Auth Settings Microsoft - A
microsoft
block as defined below. - runtime_
version str - The runtime version of the Authentication/Authorization module.
- token_
refresh_ floatextension_ hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token_
store_ boolenabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
Function
App Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated_
client_ straction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled Boolean
- Is Authentication enabled?
- active
Directory Property Map - A
active_directory
block as defined below. - additional
Login Map<String>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
External List<String>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider String The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook Property Map
- A
facebook
block as defined below. - google Property Map
- A
google
block as defined below. - issuer String
- Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft Property Map
- A
microsoft
block as defined below. - runtime
Version String - The runtime version of the Authentication/Authorization module.
- token
Refresh NumberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store BooleanEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter Property Map
- A
twitter
block as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
FunctionAppAuthSettingsActiveDirectory, FunctionAppAuthSettingsActiveDirectoryArgs
- Client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- Allowed
Audiences List<string> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- Client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- Allowed
Audiences []string - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client
Id String - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences List<String> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences string[] - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret string - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client_
id str - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed_
audiences Sequence[str] - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client_
secret str - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client
Id String - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences List<String> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
FunctionAppAuthSettingsFacebook, FunctionAppAuthSettingsFacebookArgs
- App
Id string - The App ID of the Facebook app used for login
- App
Secret string - The App Secret of the Facebook app used for Facebook login.
- Oauth
Scopes List<string> - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
- App
Id string - The App ID of the Facebook app used for login
- App
Secret string - The App Secret of the Facebook app used for Facebook login.
- Oauth
Scopes []string - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
- app
Id String - The App ID of the Facebook app used for login
- app
Secret String - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
- app
Id string - The App ID of the Facebook app used for login
- app
Secret string - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes string[] - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
- app_
id str - The App ID of the Facebook app used for login
- app_
secret str - The App Secret of the Facebook app used for Facebook login.
- oauth_
scopes Sequence[str] - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
- app
Id String - The App ID of the Facebook app used for login
- app
Secret String - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login
FunctionAppAuthSettingsGoogle, FunctionAppAuthSettingsGoogleArgs
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application.
- Oauth
Scopes List<string> - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application.
- Oauth
Scopes []string - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret string - The client secret associated with the Google web application.
- oauth
Scopes string[] - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
- client_
id str - The OpenID Connect Client ID for the Google web application.
- client_
secret str - The client secret associated with the Google web application.
- oauth_
scopes Sequence[str] - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/
FunctionAppAuthSettingsMicrosoft, FunctionAppAuthSettingsMicrosoftArgs
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- Oauth
Scopes List<string> - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- Oauth
Scopes []string - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
- client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes string[] - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
- client_
id str - The OAuth 2.0 client ID that was created for the app used for authentication.
- client_
secret str - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth_
scopes Sequence[str] - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes List<String> - The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx
FunctionAppAuthSettingsTwitter, FunctionAppAuthSettingsTwitterArgs
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer_
key str - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer_
secret str - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String - The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
FunctionAppConnectionString, FunctionAppConnectionStringArgs
FunctionAppIdentity, FunctionAppIdentityArgs
- Type string
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- Identity
Ids List<string> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - Principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- Tenant
Id string - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
- Type string
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- Identity
Ids []string - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - Principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- Tenant
Id string - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
- type String
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- identity
Ids List<String> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id String - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id String - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
- type string
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- identity
Ids string[] - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id string - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
- type str
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- identity_
ids Sequence[str] - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal_
id str - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant_
id str - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
- type String
Specifies the identity type of the Function App. Possible values are
SystemAssigned
(where Azure will generate a Service Principal for you),UserAssigned
where you can specify the Service Principal IDs in theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the Function App has been created. More details are available below.- identity
Ids List<String> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id String - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id String - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
FunctionAppSiteConfig, FunctionAppSiteConfigArgs
- Always
On bool - Should the Function App be loaded at all times? Defaults to
false
. - App
Scale intLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- Auto
Swap stringSlot Name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- Cors
Function
App Site Config Cors - A
cors
block as defined below. - Dotnet
Framework stringVersion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - Elastic
Instance intMinimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - Ftps
State string - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - Health
Check stringPath - Path which will be checked for this function app health.
- Http2Enabled bool
- Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - Ip
Restrictions List<FunctionApp Site Config Ip Restriction> A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- Java
Version string - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - Linux
Fx stringVersion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - Min
Tls stringVersion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - Pre
Warmed intInstance Count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- Runtime
Scale boolMonitoring Enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - Scm
Ip List<FunctionRestrictions App Site Config Scm Ip Restriction> A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- Scm
Type string The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- Scm
Use boolMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- Use32Bit
Worker boolProcess Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Vnet
Route boolAll Enabled - Websockets
Enabled bool - Should WebSockets be enabled?
- Always
On bool - Should the Function App be loaded at all times? Defaults to
false
. - App
Scale intLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- Auto
Swap stringSlot Name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- Cors
Function
App Site Config Cors - A
cors
block as defined below. - Dotnet
Framework stringVersion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - Elastic
Instance intMinimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - Ftps
State string - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - Health
Check stringPath - Path which will be checked for this function app health.
- Http2Enabled bool
- Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - Ip
Restrictions []FunctionApp Site Config Ip Restriction A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- Java
Version string - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - Linux
Fx stringVersion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - Min
Tls stringVersion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - Pre
Warmed intInstance Count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- Runtime
Scale boolMonitoring Enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - Scm
Ip []FunctionRestrictions App Site Config Scm Ip Restriction A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- Scm
Type string The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- Scm
Use boolMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- Use32Bit
Worker boolProcess Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Vnet
Route boolAll Enabled - Websockets
Enabled bool - Should WebSockets be enabled?
- always
On Boolean - Should the Function App be loaded at all times? Defaults to
false
. - app
Scale IntegerLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- auto
Swap StringSlot Name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- cors
Function
App Site Config Cors - A
cors
block as defined below. - dotnet
Framework StringVersion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - elastic
Instance IntegerMinimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - ftps
State String - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - health
Check StringPath - Path which will be checked for this function app health.
- http2Enabled Boolean
- Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - ip
Restrictions List<FunctionApp Site Config Ip Restriction> A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Version String - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - linux
Fx StringVersion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - min
Tls StringVersion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - pre
Warmed IntegerInstance Count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- runtime
Scale BooleanMonitoring Enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - scm
Ip List<FunctionRestrictions App Site Config Scm Ip Restriction> A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type String The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- scm
Use BooleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker BooleanProcess Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route BooleanAll Enabled - websockets
Enabled Boolean - Should WebSockets be enabled?
- always
On boolean - Should the Function App be loaded at all times? Defaults to
false
. - app
Scale numberLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- auto
Swap stringSlot Name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- cors
Function
App Site Config Cors - A
cors
block as defined below. - dotnet
Framework stringVersion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - elastic
Instance numberMinimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - ftps
State string - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - health
Check stringPath - Path which will be checked for this function app health.
- http2Enabled boolean
- Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - ip
Restrictions FunctionApp Site Config Ip Restriction[] A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Version string - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - linux
Fx stringVersion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - min
Tls stringVersion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - pre
Warmed numberInstance Count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- runtime
Scale booleanMonitoring Enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - scm
Ip FunctionRestrictions App Site Config Scm Ip Restriction[] A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type string The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- scm
Use booleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker booleanProcess Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route booleanAll Enabled - websockets
Enabled boolean - Should WebSockets be enabled?
- always_
on bool - Should the Function App be loaded at all times? Defaults to
false
. - app_
scale_ intlimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- auto_
swap_ strslot_ name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- cors
Function
App Site Config Cors - A
cors
block as defined below. - dotnet_
framework_ strversion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - elastic_
instance_ intminimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - ftps_
state str - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - health_
check_ strpath - Path which will be checked for this function app health.
- http2_
enabled bool - Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - ip_
restrictions Sequence[FunctionApp Site Config Ip Restriction] A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java_
version str - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - linux_
fx_ strversion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - min_
tls_ strversion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - pre_
warmed_ intinstance_ count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- runtime_
scale_ boolmonitoring_ enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - scm_
ip_ Sequence[Functionrestrictions App Site Config Scm Ip Restriction] A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm_
type str The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- scm_
use_ boolmain_ ip_ restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32_
bit_ boolworker_ process Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet_
route_ boolall_ enabled - websockets_
enabled bool - Should WebSockets be enabled?
- always
On Boolean - Should the Function App be loaded at all times? Defaults to
false
. - app
Scale NumberLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- auto
Swap StringSlot Name The name of the slot to automatically swap to during deployment
NOTE: This attribute is only used for slots.
- cors Property Map
- A
cors
block as defined below. - dotnet
Framework StringVersion - The version of the .NET framework's CLR used in this function app. Possible values are
v4.0
(including .NET Core 2.1 and 3.1),v5.0
andv6.0
. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults tov4.0
. - elastic
Instance NumberMinimum - The number of minimum instances for this function app. Only affects apps on the Premium plan. Possible values are between
1
and20
. - ftps
State String - State of FTP / FTPS service for this function app. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. Defaults toAllAllowed
. - health
Check StringPath - Path which will be checked for this function app health.
- http2Enabled Boolean
- Specifies whether or not the HTTP2 protocol should be enabled. Defaults to
false
. - ip
Restrictions List<Property Map> A list of
ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Version String - Java version hosted by the function app in Azure. Possible values are
1.8
,11
&17
(In-Preview). - linux
Fx StringVersion - Linux App Framework and version for the AppService, e.g.
DOCKER|(golang:latest)
. - min
Tls StringVersion - The minimum supported TLS version for the function app. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new function apps. - pre
Warmed NumberInstance Count - The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.
- runtime
Scale BooleanMonitoring Enabled - Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to
false
. - scm
Ip List<Property Map>Restrictions A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type String The type of Source Control used by the Function App. Valid values include:
BitBucketGit
,BitBucketHg
,CodePlexGit
,CodePlexHg
,Dropbox
,ExternalGit
,ExternalHg
,GitHub
,LocalGit
,None
(default),OneDrive
,Tfs
,VSO
, andVSTSRM
.NOTE: This setting is incompatible with the
source_control
block which updates this value based on the setting provided.- scm
Use BooleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker BooleanProcess Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to
true
.Note: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route BooleanAll Enabled - websockets
Enabled Boolean - Should WebSockets be enabled?
FunctionAppSiteConfigCors, FunctionAppSiteConfigCorsArgs
- Allowed
Origins List<string> - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - Support
Credentials bool - Are credentials supported?
- Allowed
Origins []string - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - Support
Credentials bool - Are credentials supported?
- allowed
Origins List<String> - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials Boolean - Are credentials supported?
- allowed
Origins string[] - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials boolean - Are credentials supported?
- allowed_
origins Sequence[str] - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support_
credentials bool - Are credentials supported?
- allowed
Origins List<String> - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials Boolean - Are credentials supported?
FunctionAppSiteConfigIpRestriction, FunctionAppSiteConfigIpRestrictionArgs
- Action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - Headers
Function
App Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - Ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- Name string
- The name for this IP Restriction.
- Priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- Action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - Headers
Function
App Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - Ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- Name string
- The name for this IP Restriction.
- Priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
Function
App Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - ip
Address String - The IP Address used for this IP Restriction in CIDR notation.
- name String
- The name for this IP Restriction.
- priority Integer
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
Function
App Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- name string
- The name for this IP Restriction.
- priority number
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action str
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
Function
App Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - ip_
address str - The IP Address used for this IP Restriction in CIDR notation.
- name str
- The name for this IP Restriction.
- priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers Property Map
- The
headers
block for this specificip_restriction
as defined below. - ip
Address String - The IP Address used for this IP Restriction in CIDR notation.
- name String
- The name for this IP Restriction.
- priority Number
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, the priority is set to 65000 if not specified.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
FunctionAppSiteConfigIpRestrictionHeaders, FunctionAppSiteConfigIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors List<string> - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts List<string> - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- XAzure
Fdids []string - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors []string - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts []string - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure string[]Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd stringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded string[]Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded string[]Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x_
azure_ Sequence[str]fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x_
fd_ strhealth_ probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x_
forwarded_ Sequence[str]fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x_
forwarded_ Sequence[str]hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
FunctionAppSiteConfigScmIpRestriction, FunctionAppSiteConfigScmIpRestrictionArgs
- Action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - Headers
Function
App Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - Ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- Name string
- The name for this IP Restriction.
- Priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- Action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - Headers
Function
App Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - Ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- Name string
- The name for this IP Restriction.
- Priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
Function
App Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address String - The IP Address used for this IP Restriction in CIDR notation.
- name String
- The name for this IP Restriction.
- priority Integer
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
Function
App Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address string - The IP Address used for this IP Restriction in CIDR notation.
- name string
- The name for this IP Restriction.
- priority number
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action str
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
Function
App Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - ip_
address str - The IP Address used for this IP Restriction in CIDR notation.
- name str
- The name for this IP Restriction.
- priority int
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers Property Map
- The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address String - The IP Address used for this IP Restriction in CIDR notation.
- name String
- The name for this IP Restriction.
- priority Number
- The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
FunctionAppSiteConfigScmIpRestrictionHeaders, FunctionAppSiteConfigScmIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors List<string> - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts List<string> - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- XAzure
Fdids []string - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors []string - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts []string - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure string[]Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd stringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded string[]Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded string[]Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x_
azure_ Sequence[str]fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x_
fd_ strhealth_ probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x_
forwarded_ Sequence[str]fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x_
forwarded_ Sequence[str]hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
FunctionAppSiteCredential, FunctionAppSiteCredentialArgs
FunctionAppSourceControl, FunctionAppSourceControlArgs
- Branch string
- The branch of the remote repository to use. Defaults to 'master'.
- Manual
Integration bool - Limits to manual integration. Defaults to
false
if not specified. - Repo
Url string - The URL of the source code repository.
- Rollback
Enabled bool - Enable roll-back for the repository. Defaults to
false
if not specified. - Use
Mercurial bool - Use Mercurial if
true
, otherwise uses Git.
- Branch string
- The branch of the remote repository to use. Defaults to 'master'.
- Manual
Integration bool - Limits to manual integration. Defaults to
false
if not specified. - Repo
Url string - The URL of the source code repository.
- Rollback
Enabled bool - Enable roll-back for the repository. Defaults to
false
if not specified. - Use
Mercurial bool - Use Mercurial if
true
, otherwise uses Git.
- branch String
- The branch of the remote repository to use. Defaults to 'master'.
- manual
Integration Boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url String - The URL of the source code repository.
- rollback
Enabled Boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial Boolean - Use Mercurial if
true
, otherwise uses Git.
- branch string
- The branch of the remote repository to use. Defaults to 'master'.
- manual
Integration boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url string - The URL of the source code repository.
- rollback
Enabled boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial boolean - Use Mercurial if
true
, otherwise uses Git.
- branch str
- The branch of the remote repository to use. Defaults to 'master'.
- manual_
integration bool - Limits to manual integration. Defaults to
false
if not specified. - repo_
url str - The URL of the source code repository.
- rollback_
enabled bool - Enable roll-back for the repository. Defaults to
false
if not specified. - use_
mercurial bool - Use Mercurial if
true
, otherwise uses Git.
- branch String
- The branch of the remote repository to use. Defaults to 'master'.
- manual
Integration Boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url String - The URL of the source code repository.
- rollback
Enabled Boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial Boolean - Use Mercurial if
true
, otherwise uses Git.
Import
Function Apps can be imported using the resource id
, e.g.
$ pulumi import azure:appservice/functionApp:FunctionApp functionapp1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/sites/functionapp1
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.