1. Docs
  2. Reference
  3. API
  4. Azure
  5. appservice
  6. FunctionApp

FunctionApp

Manages a Function App.

Example Usage

With App Service Plan)

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "westus2",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Standard",
                Size = "S1",
            },
        });
        var exampleFunctionApp = new Azure.AppService.FunctionApp("exampleFunctionApp", new Azure.AppService.FunctionAppArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
            StorageConnectionString = exampleAccount.PrimaryConnectionString,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("westus2"),
        })
        if err != nil {
            return err
        }
        exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
            ResourceGroupName:      exampleResourceGroup.Name,
            Location:               exampleResourceGroup.Location,
            AccountTier:            pulumi.String("Standard"),
            AccountReplicationType: pulumi.String("LRS"),
        })
        if err != nil {
            return err
        }
        examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Sku: &appservice.PlanSkuArgs{
                Tier: pulumi.String("Standard"),
                Size: pulumi.String("S1"),
            },
        })
        if err != nil {
            return err
        }
        _, err = appservice.NewFunctionApp(ctx, "exampleFunctionApp", &appservice.FunctionAppArgs{
            Location:                exampleResourceGroup.Location,
            ResourceGroupName:       exampleResourceGroup.Name,
            AppServicePlanId:        examplePlan.ID(),
            StorageConnectionString: exampleAccount.PrimaryConnectionString,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus2")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku={
        "tier": "Standard",
        "size": "S1",
    })
example_function_app = azure.appservice.FunctionApp("exampleFunctionApp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id,
    storage_connection_string=example_account.primary_connection_string)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westus2"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        tier: "Standard",
        size: "S1",
    },
});
const exampleFunctionApp = new azure.appservice.FunctionApp("exampleFunctionApp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
    storageConnectionString: exampleAccount.primaryConnectionString,
});

In A Consumption Plan)

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "westus2",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Kind = "FunctionApp",
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Dynamic",
                Size = "Y1",
            },
        });
        var exampleFunctionApp = new Azure.AppService.FunctionApp("exampleFunctionApp", new Azure.AppService.FunctionAppArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
            StorageConnectionString = exampleAccount.PrimaryConnectionString,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("westus2"),
        })
        if err != nil {
            return err
        }
        exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
            ResourceGroupName:      exampleResourceGroup.Name,
            Location:               exampleResourceGroup.Location,
            AccountTier:            pulumi.String("Standard"),
            AccountReplicationType: pulumi.String("LRS"),
        })
        if err != nil {
            return err
        }
        examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Kind:              pulumi.String("FunctionApp"),
            Sku: &appservice.PlanSkuArgs{
                Tier: pulumi.String("Dynamic"),
                Size: pulumi.String("Y1"),
            },
        })
        if err != nil {
            return err
        }
        _, err = appservice.NewFunctionApp(ctx, "exampleFunctionApp", &appservice.FunctionAppArgs{
            Location:                exampleResourceGroup.Location,
            ResourceGroupName:       exampleResourceGroup.Name,
            AppServicePlanId:        examplePlan.ID(),
            StorageConnectionString: exampleAccount.PrimaryConnectionString,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus2")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    kind="FunctionApp",
    sku={
        "tier": "Dynamic",
        "size": "Y1",
    })
example_function_app = azure.appservice.FunctionApp("exampleFunctionApp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id,
    storage_connection_string=example_account.primary_connection_string)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westus2"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    kind: "FunctionApp",
    sku: {
        tier: "Dynamic",
        size: "Y1",
    },
});
const exampleFunctionApp = new azure.appservice.FunctionApp("exampleFunctionApp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
    storageConnectionString: exampleAccount.primaryConnectionString,
});

Linux)

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "westus2",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Kind = "FunctionApp",
            Reserved = true,
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Dynamic",
                Size = "Y1",
            },
        });
        var exampleFunctionApp = new Azure.AppService.FunctionApp("exampleFunctionApp", new Azure.AppService.FunctionAppArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
            StorageConnectionString = exampleAccount.PrimaryConnectionString,
            OsType = "linux",
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("westus2"),
        })
        if err != nil {
            return err
        }
        exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
            ResourceGroupName:      exampleResourceGroup.Name,
            Location:               exampleResourceGroup.Location,
            AccountTier:            pulumi.String("Standard"),
            AccountReplicationType: pulumi.String("LRS"),
        })
        if err != nil {
            return err
        }
        examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Kind:              pulumi.String("FunctionApp"),
            Reserved:          pulumi.Bool(true),
            Sku: &appservice.PlanSkuArgs{
                Tier: pulumi.String("Dynamic"),
                Size: pulumi.String("Y1"),
            },
        })
        if err != nil {
            return err
        }
        _, err = appservice.NewFunctionApp(ctx, "exampleFunctionApp", &appservice.FunctionAppArgs{
            Location:                exampleResourceGroup.Location,
            ResourceGroupName:       exampleResourceGroup.Name,
            AppServicePlanId:        examplePlan.ID(),
            StorageConnectionString: exampleAccount.PrimaryConnectionString,
            OsType:                  pulumi.String("linux"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus2")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    kind="FunctionApp",
    reserved=True,
    sku={
        "tier": "Dynamic",
        "size": "Y1",
    })
example_function_app = azure.appservice.FunctionApp("exampleFunctionApp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id,
    storage_connection_string=example_account.primary_connection_string,
    os_type="linux")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westus2"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    kind: "FunctionApp",
    reserved: true,
    sku: {
        tier: "Dynamic",
        size: "Y1",
    },
});
const exampleFunctionApp = new azure.appservice.FunctionApp("exampleFunctionApp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
    storageConnectionString: exampleAccount.primaryConnectionString,
    osType: "linux",
});

Create a FunctionApp Resource

new FunctionApp(name: string, args: FunctionAppArgs, opts?: CustomResourceOptions);
def FunctionApp(resource_name, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, daily_memory_time_quota=None, enable_builtin_logging=None, enabled=None, https_only=None, identity=None, location=None, name=None, os_type=None, resource_group_name=None, site_config=None, storage_account_access_key=None, storage_account_name=None, storage_connection_string=None, tags=None, version=None, __props__=None);
func NewFunctionApp(ctx *Context, name string, args FunctionAppArgs, opts ...ResourceOption) (*FunctionApp, error)
public FunctionApp(string name, FunctionAppArgs args, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

FunctionApp Resource Properties

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

Inputs

The FunctionApp resource accepts the following input properties:

AppServicePlanId string

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

ResourceGroupName string

The name of the resource group in which to create the Function App.

AppSettings Dictionary<string, string>

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

AuthSettings FunctionAppAuthSettingsArgs

A auth_settings block as defined below.

ClientAffinityEnabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

ConnectionStrings List<FunctionAppConnectionStringArgs>

An connection_string block as defined below.

DailyMemoryTimeQuota 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. Defaults to 0.

EnableBuiltinLogging bool

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

Enabled bool

Is the Function App enabled?

HttpsOnly bool

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

Identity FunctionAppIdentityArgs

An identity block as defined below.

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.

OsType string

A string indicating the Operating System type for this function app.

SiteConfig FunctionAppSiteConfigArgs

A site_config object as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

StorageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

Tags 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.

AppServicePlanId string

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

ResourceGroupName string

The name of the resource group in which to create the Function App.

AppSettings map[string]string

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

AuthSettings FunctionAppAuthSettings

A auth_settings block as defined below.

ClientAffinityEnabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

ConnectionStrings []FunctionAppConnectionString

An connection_string block as defined below.

DailyMemoryTimeQuota 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. Defaults to 0.

EnableBuiltinLogging bool

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

Enabled bool

Is the Function App enabled?

HttpsOnly bool

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

Identity FunctionAppIdentity

An identity block as defined below.

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.

OsType string

A string indicating the Operating System type for this function app.

SiteConfig FunctionAppSiteConfig

A site_config object as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

StorageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

Tags 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.

appServicePlanId string

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

resourceGroupName string

The name of the resource group in which to create the Function App.

appSettings {[key: string]: string}

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

authSettings FunctionAppAuthSettings

A auth_settings block as defined below.

clientAffinityEnabled boolean

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

connectionStrings FunctionAppConnectionString[]

An connection_string block as defined below.

dailyMemoryTimeQuota number

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. Defaults to 0.

enableBuiltinLogging boolean

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

enabled boolean

Is the Function App enabled?

httpsOnly boolean

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

identity FunctionAppIdentity

An identity block as defined below.

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.

osType string

A string indicating the Operating System type for this function app.

siteConfig FunctionAppSiteConfig

A site_config object as defined below.

storageAccountAccessKey string

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

storageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

storageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

tags {[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_plan_id str

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

resource_group_name str

The name of the resource group in which to create the Function App.

app_settings Dict[str, str]

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

auth_settings Dict[FunctionAppAuthSettings]

A auth_settings block as defined below.

client_affinity_enabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

connection_strings List[FunctionAppConnectionString]

An connection_string block as defined below.

daily_memory_time_quota float

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. Defaults to 0.

enable_builtin_logging bool

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

enabled bool

Is the Function App enabled?

https_only bool

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

identity Dict[FunctionAppIdentity]

An identity block as defined below.

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.

os_type str

A string indicating the Operating System type for this function app.

site_config Dict[FunctionAppSiteConfig]

A site_config object as defined below.

storage_account_access_key str

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

storage_account_name str

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

storage_connection_string str

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

tags Dict[str, str]

A mapping of tags to assign to the resource.

version str

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:

DefaultHostname 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

OutboundIpAddresses string

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

PossibleOutboundIpAddresses 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.

SiteCredentials List<FunctionAppSiteCredential>

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

DefaultHostname 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

OutboundIpAddresses string

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

PossibleOutboundIpAddresses 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.

SiteCredentials []FunctionAppSiteCredential

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

defaultHostname 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

outboundIpAddresses string

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

possibleOutboundIpAddresses 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.

siteCredentials FunctionAppSiteCredential[]

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

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_addresses str

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

possible_outbound_ip_addresses str

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.

site_credentials List[FunctionAppSiteCredential]

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

Look up an 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
static get(resource_name, id, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, daily_memory_time_quota=None, default_hostname=None, enable_builtin_logging=None, enabled=None, https_only=None, identity=None, kind=None, location=None, name=None, os_type=None, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, resource_group_name=None, site_config=None, site_credentials=None, storage_account_access_key=None, storage_account_name=None, storage_connection_string=None, tags=None, version=None, __props__=None);
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)
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.

The following state arguments are supported:

AppServicePlanId string

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

AppSettings Dictionary<string, string>

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

AuthSettings FunctionAppAuthSettingsArgs

A auth_settings block as defined below.

ClientAffinityEnabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

ConnectionStrings List<FunctionAppConnectionStringArgs>

An connection_string block as defined below.

DailyMemoryTimeQuota 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. Defaults to 0.

DefaultHostname string

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

EnableBuiltinLogging bool

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

Enabled bool

Is the Function App enabled?

HttpsOnly bool

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

Identity FunctionAppIdentityArgs

An identity block as defined below.

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.

OsType string

A string indicating the Operating System type for this function app.

OutboundIpAddresses string

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

PossibleOutboundIpAddresses 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.

ResourceGroupName string

The name of the resource group in which to create the Function App.

SiteConfig FunctionAppSiteConfigArgs

A site_config object as defined below.

SiteCredentials List<FunctionAppSiteCredentialArgs>

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

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

StorageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

Tags 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.

AppServicePlanId string

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

AppSettings map[string]string

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

AuthSettings FunctionAppAuthSettings

A auth_settings block as defined below.

ClientAffinityEnabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

ConnectionStrings []FunctionAppConnectionString

An connection_string block as defined below.

DailyMemoryTimeQuota 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. Defaults to 0.

DefaultHostname string

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

EnableBuiltinLogging bool

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

Enabled bool

Is the Function App enabled?

HttpsOnly bool

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

Identity FunctionAppIdentity

An identity block as defined below.

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.

OsType string

A string indicating the Operating System type for this function app.

OutboundIpAddresses string

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

PossibleOutboundIpAddresses 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.

ResourceGroupName string

The name of the resource group in which to create the Function App.

SiteConfig FunctionAppSiteConfig

A site_config object as defined below.

SiteCredentials []FunctionAppSiteCredential

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

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

StorageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

Tags 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.

appServicePlanId string

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

appSettings {[key: string]: string}

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

authSettings FunctionAppAuthSettings

A auth_settings block as defined below.

clientAffinityEnabled boolean

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

connectionStrings FunctionAppConnectionString[]

An connection_string block as defined below.

dailyMemoryTimeQuota number

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. Defaults to 0.

defaultHostname string

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

enableBuiltinLogging boolean

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

enabled boolean

Is the Function App enabled?

httpsOnly boolean

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

identity FunctionAppIdentity

An identity block as defined below.

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.

osType string

A string indicating the Operating System type for this function app.

outboundIpAddresses string

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

possibleOutboundIpAddresses 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.

resourceGroupName string

The name of the resource group in which to create the Function App.

siteConfig FunctionAppSiteConfig

A site_config object as defined below.

siteCredentials FunctionAppSiteCredential[]

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

storageAccountAccessKey string

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

storageAccountName string

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

storageConnectionString string

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

tags {[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_plan_id str

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

app_settings Dict[str, str]

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

auth_settings Dict[FunctionAppAuthSettings]

A auth_settings block as defined below.

client_affinity_enabled bool

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

connection_strings List[FunctionAppConnectionString]

An connection_string block as defined below.

daily_memory_time_quota float

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. Defaults to 0.

default_hostname str

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

enable_builtin_logging bool

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

enabled bool

Is the Function App enabled?

https_only bool

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

identity Dict[FunctionAppIdentity]

An identity block as defined below.

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.

os_type str

A string indicating the Operating System type for this function app.

outbound_ip_addresses str

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

possible_outbound_ip_addresses str

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.

resource_group_name str

The name of the resource group in which to create the Function App.

site_config Dict[FunctionAppSiteConfig]

A site_config object as defined below.

site_credentials List[FunctionAppSiteCredential]

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

storage_account_access_key str

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

storage_account_name str

The backend storage account name which will be used by this Function App (such as the dashboard, logs).

storage_connection_string str

The connection string to the backend storage account which will be used by this Function App (such as the dashboard, logs). Typically set to the primary_connection_string of a storage account resource.

Deprecated: Deprecated in favor of storage_account_name and storage_account_access_key

tags Dict[str, str]

A mapping of tags to assign to the resource.

version str

The runtime version associated with the Function App. Defaults to ~1.

Supporting Types

FunctionAppAuthSettings

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool

Is Authentication enabled?

ActiveDirectory FunctionAppAuthSettingsActiveDirectoryArgs

A active_directory block as defined below.

AdditionalLoginParams Dictionary<string, string>

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

AllowedExternalRedirectUrls List<string>

External URLs that can be redirected to as part of logging in or logging out of the app.

DefaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

Facebook FunctionAppAuthSettingsFacebookArgs

A facebook block as defined below.

Google FunctionAppAuthSettingsGoogleArgs

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 FunctionAppAuthSettingsMicrosoftArgs

A microsoft block as defined below.

RuntimeVersion string

The runtime version of the Authentication/Authorization module.

TokenRefreshExtensionHours double

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

TokenStoreEnabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

Twitter FunctionAppAuthSettingsTwitterArgs

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

Enabled bool

Is Authentication enabled?

ActiveDirectory FunctionAppAuthSettingsActiveDirectory

A active_directory block as defined below.

AdditionalLoginParams map[string]string

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

AllowedExternalRedirectUrls []string

External URLs that can be redirected to as part of logging in or logging out of the app.

DefaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

Facebook FunctionAppAuthSettingsFacebook

A facebook block as defined below.

Google FunctionAppAuthSettingsGoogle

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 FunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

The runtime version of the Authentication/Authorization module.

TokenRefreshExtensionHours float64

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

TokenStoreEnabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

Twitter FunctionAppAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled boolean

Is Authentication enabled?

activeDirectory FunctionAppAuthSettingsActiveDirectory

A active_directory block as defined below.

additionalLoginParams {[key: string]: string}

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

allowedExternalRedirectUrls string[]

External URLs that can be redirected to as part of logging in or logging out of the app.

defaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook FunctionAppAuthSettingsFacebook

A facebook block as defined below.

google FunctionAppAuthSettingsGoogle

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 FunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion string

The runtime version of the Authentication/Authorization module.

tokenRefreshExtensionHours number

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

tokenStoreEnabled boolean

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter FunctionAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled bool

Is Authentication enabled?

active_directory Dict[FunctionAppAuthSettingsActiveDirectory]

A active_directory block as defined below.

additionalLoginParams Dict[str, str]

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

allowedExternalRedirectUrls List[str]

External URLs that can be redirected to as part of logging in or logging out of the app.

defaultProvider str

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook Dict[FunctionAppAuthSettingsFacebook]

A facebook block as defined below.

google Dict[FunctionAppAuthSettingsGoogle]

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 Dict[FunctionAppAuthSettingsMicrosoft]

A microsoft block as defined below.

runtimeVersion str

The runtime version of the Authentication/Authorization module.

tokenRefreshExtensionHours float

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

tokenStoreEnabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter Dict[FunctionAppAuthSettingsTwitter]

A twitter block as defined below.

unauthenticatedClientAction str

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

FunctionAppAuthSettingsActiveDirectory

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ClientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

AllowedAudiences List<string>

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

ClientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

AllowedAudiences []string

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

clientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

allowedAudiences string[]

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret 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.

allowedAudiences List[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.

FunctionAppAuthSettingsFacebook

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AppId string

The App ID of the Facebook app used for login

AppSecret string

The App Secret of the Facebook app used for Facebook Login.

OauthScopes List<string>

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

AppId string

The App ID of the Facebook app used for login

AppSecret string

The App Secret of the Facebook app used for Facebook Login.

OauthScopes []string

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

appId string

The App ID of the Facebook app used for login

appSecret string

The App Secret of the Facebook app used for Facebook Login.

oauthScopes 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.

oauthScopes List[str]

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

FunctionAppAuthSettingsGoogle

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application.

OauthScopes 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/

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application.

OauthScopes []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/

clientId string

The OpenID Connect Client ID for the Google web application.

clientSecret string

The client secret associated with the Google web application.

oauthScopes 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.

oauthScopes List[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/

FunctionAppAuthSettingsMicrosoft

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ClientId string

The OAuth 2.0 client ID that was created for the app used for authentication.

ClientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication.

OauthScopes 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

ClientId string

The OAuth 2.0 client ID that was created for the app used for authentication.

ClientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication.

OauthScopes []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

clientId string

The OAuth 2.0 client ID that was created for the app used for authentication.

clientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication.

oauthScopes 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.

oauthScopes List[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

FunctionAppAuthSettingsTwitter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ConsumerKey string
ConsumerSecret string
ConsumerKey string
ConsumerSecret string
consumerKey string
consumerSecret string
consumerKey str
consumerSecret str

FunctionAppConnectionString

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

The name of the Connection String.

Type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

Value string

The value for the Connection String.

Name string

The name of the Connection String.

Type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

Value string

The value for the Connection String.

name string

The name of the Connection String.

type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value string

The value for the Connection String.

name str

The name of the Connection String.

type str

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value str

The value for the Connection String.

FunctionAppIdentity

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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 the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds List<string>

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

TenantId 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 the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds []string

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

TenantId 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 the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds string[]

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

principalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

tenantId 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 the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds List[str]

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

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.

FunctionAppSiteConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AlwaysOn bool

Should the Function App be loaded at all times? Defaults to false.

Cors FunctionAppSiteConfigCorsArgs

A cors block as defined below.

FtpsState string

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

Http2Enabled bool

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

IpRestrictions List<FunctionAppSiteConfigIpRestrictionArgs>

A list of objects representing ip restrictions as defined below.

LinuxFxVersion string

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

MinTlsVersion string

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

PreWarmedInstanceCount int

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

Use32BitWorkerProcess bool

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

WebsocketsEnabled bool

Should WebSockets be enabled?

AlwaysOn bool

Should the Function App be loaded at all times? Defaults to false.

Cors FunctionAppSiteConfigCors

A cors block as defined below.

FtpsState string

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

Http2Enabled bool

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

IpRestrictions []FunctionAppSiteConfigIpRestriction

A list of objects representing ip restrictions as defined below.

LinuxFxVersion string

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

MinTlsVersion string

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

PreWarmedInstanceCount int

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

Use32BitWorkerProcess bool

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

WebsocketsEnabled bool

Should WebSockets be enabled?

alwaysOn boolean

Should the Function App be loaded at all times? Defaults to false.

cors FunctionAppSiteConfigCors

A cors block as defined below.

ftpsState string

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

http2Enabled boolean

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

ipRestrictions FunctionAppSiteConfigIpRestriction[]

A list of objects representing ip restrictions as defined below.

linuxFxVersion string

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

minTlsVersion string

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

preWarmedInstanceCount number

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

use32BitWorkerProcess boolean

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

websocketsEnabled boolean

Should WebSockets be enabled?

alwaysOn bool

Should the Function App be loaded at all times? Defaults to false.

cors Dict[FunctionAppSiteConfigCors]

A cors block as defined below.

ftpsState str

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

http2Enabled bool

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

ipRestrictions List[FunctionAppSiteConfigIpRestriction]

A list of objects representing ip restrictions as defined below.

linuxFxVersion str

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

minTlsVersion str

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

preWarmedInstanceCount float

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

use32BitWorkerProcess bool

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

websocketsEnabled bool

Should WebSockets be enabled?

FunctionAppSiteConfigCors

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AllowedOrigins List<string>

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

SupportCredentials bool

Are credentials supported?

AllowedOrigins []string

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

SupportCredentials bool

Are credentials supported?

allowedOrigins string[]

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

supportCredentials boolean

Are credentials supported?

allowedOrigins List[str]

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

supportCredentials bool

Are credentials supported?

FunctionAppSiteConfigIpRestriction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

IpAddress string

The IP Address CIDR notation used for this IP Restriction.

SubnetId string

The Subnet ID used for this IP Restriction.

IpAddress string

The IP Address CIDR notation used for this IP Restriction.

SubnetId string

The Subnet ID used for this IP Restriction.

ipAddress string

The IP Address CIDR notation used for this IP Restriction.

subnetId string

The Subnet ID used for this IP Restriction.

ip_address str

The IP Address CIDR notation used for this IP Restriction.

subnet_id str

The Subnet ID used for this IP Restriction.

FunctionAppSiteCredential

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Password string

The password associated with the username, which can be used to publish to this App Service.

Username string

The username which can be used to publish to this App Service

Password string

The password associated with the username, which can be used to publish to this App Service.

Username string

The username which can be used to publish to this App Service

password string

The password associated with the username, which can be used to publish to this App Service.

username string

The username which can be used to publish to this App Service

password str

The password associated with the username, which can be used to publish to this App Service.

username str

The username which can be used to publish to this App Service

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.