pulumi-azure-kotlin/com.pulumi.azure.appservice.kotlin/FunctionApp

FunctionApp

class FunctionApp : KotlinCustomResource

Manages a Function App. !>NOTE: This resource has been deprecated in version 3.0 of the AzureRM provider and will be removed in version 4.0. Please use azure.appservice.LinuxFunctionApp 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 the azure.appservice.VirtualNetworkSwiftConnection documentation.

Example Usage

With App Service Plan)

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var examplePlan = new Plan("examplePlan", PlanArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku(PlanSkuArgs.builder()
                .tier("Standard")
                .size("S1")
                .build())
            .build());
        var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .storageAccountName(exampleAccount.name())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .build());
    }
}

In A Consumption Plan)

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var examplePlan = new Plan("examplePlan", PlanArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .kind("FunctionApp")
            .sku(PlanSkuArgs.builder()
                .tier("Dynamic")
                .size("Y1")
                .build())
            .build());
        var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .storageAccountName(exampleAccount.name())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .build());
    }
}

Linux)

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var examplePlan = new Plan("examplePlan", PlanArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .kind("Linux")
            .reserved(true)
            .sku(PlanSkuArgs.builder()
                .tier("Dynamic")
                .size("Y1")
                .build())
            .build());
        var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .storageAccountName(exampleAccount.name())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .osType("linux")
            .version("~3")
            .build());
    }
}

Python In A Consumption Plan)

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var examplePlan = new Plan("examplePlan", PlanArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .kind("Linux")
            .reserved(true)
            .sku(PlanSkuArgs.builder()
                .tier("Dynamic")
                .size("Y1")
                .build())
            .build());
        var exampleFunctionApp = new FunctionApp("exampleFunctionApp", FunctionAppArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .storageAccountName(exampleAccount.name())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .osType("linux")
            .version("~4")
            .appSettings(Map.of("FUNCTIONSWORKERRUNTIME", "python"))
            .siteConfig(FunctionAppSiteConfigArgs.builder()
                .linuxFxVersion("python|3.9")
                .build())
            .build());
    }
}

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

Properties

appServicePlanId

val appServicePlanId: Output<String>

The ID of the App Service Plan within which to create this Function App.

appSettings

val appSettings: Output<Map<String, String>>

A map of key-value pairs for App Settings and custom values.

authSettings

val authSettings: Output<FunctionAppAuthSettings>

A auth_settings block as defined below.

clientCertMode

val clientCertMode: Output<String>?

The mode of the Function App's client certificates requirement for incoming requests. Possible values are Required and Optional.

connectionStrings

val connectionStrings: Output<List<FunctionAppConnectionString>>

An connection_string block as defined below.

customDomainVerificationId

val customDomainVerificationId: Output<String>

An identifier used by App Service to perform domain ownership verification via DNS TXT record.

dailyMemoryTimeQuota

val dailyMemoryTimeQuota: Output<Int>?

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.

defaultHostname

val defaultHostname: Output<String>

The default hostname associated with the Function App - such as mysite.azurewebsites.net

enableBuiltinLogging

val enableBuiltinLogging: Output<Boolean>?

Should the built-in logging of this Function App be enabled? Defaults to true.

enabled

val enabled: Output<Boolean>?

Is the Function App enabled? Defaults to true.

httpsOnly

val httpsOnly: Output<Boolean>?

Can the Function App only be accessed via HTTPS? Defaults to false.

val id: Output<String>

identity

val identity: Output<FunctionAppIdentity>?

An identity block as defined below.

keyVaultReferenceIdentityId

val keyVaultReferenceIdentityId: Output<String>

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

val kind: Output<String>

The Function App kind - such as functionapp,linux,container

location

val location: Output<String>

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name

val name: Output<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.

osType

val osType: Output<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 "".

outboundIpAddresses

val outboundIpAddresses: Output<String>

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12

possibleOutboundIpAddresses

val possibleOutboundIpAddresses: Output<String>

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 of outbound_ip_addresses.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<String>

The name of the resource group in which to create the Function App. Changing this forces a new resource to be created.

siteConfig

val siteConfig: Output<FunctionAppSiteConfig>

A site_config object as defined below.

siteCredentials

val siteCredentials: Output<List<FunctionAppSiteCredential>>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

sourceControl

val sourceControl: Output<FunctionAppSourceControl>

A source_control block, as defined below.

storageAccountAccessKey

val storageAccountAccessKey: Output<String>

The access key which will be used to access the backend storage account for the Function App.

storageAccountName

val storageAccountName: Output<String>

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.