1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. appservice
  5. WindowsFunctionApp
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.appservice.WindowsFunctionApp

Manages a Windows Function App.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleServicePlan = new Azure.AppService.ServicePlan("exampleServicePlan", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        OsType = "Windows",
        SkuName = "Y1",
    });

    var exampleWindowsFunctionApp = new Azure.AppService.WindowsFunctionApp("exampleWindowsFunctionApp", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        StorageAccountName = exampleAccount.Name,
        StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
        ServicePlanId = exampleServicePlan.Id,
        SiteConfig = null,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		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
		}
		exampleServicePlan, err := appservice.NewServicePlan(ctx, "exampleServicePlan", &appservice.ServicePlanArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			OsType:            pulumi.String("Windows"),
			SkuName:           pulumi.String("Y1"),
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewWindowsFunctionApp(ctx, "exampleWindowsFunctionApp", &appservice.WindowsFunctionAppArgs{
			ResourceGroupName:       exampleResourceGroup.Name,
			Location:                exampleResourceGroup.Location,
			StorageAccountName:      exampleAccount.Name,
			StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
			ServicePlanId:           exampleServicePlan.ID(),
			SiteConfig:              nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.appservice.ServicePlan;
import com.pulumi.azure.appservice.ServicePlanArgs;
import com.pulumi.azure.appservice.WindowsFunctionApp;
import com.pulumi.azure.appservice.WindowsFunctionAppArgs;
import com.pulumi.azure.appservice.inputs.WindowsFunctionAppSiteConfigArgs;
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 exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .osType("Windows")
            .skuName("Y1")
            .build());

        var exampleWindowsFunctionApp = new WindowsFunctionApp("exampleWindowsFunctionApp", WindowsFunctionAppArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .storageAccountName(exampleAccount.name())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .servicePlanId(exampleServicePlan.id())
            .siteConfig()
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
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_service_plan = azure.appservice.ServicePlan("exampleServicePlan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    os_type="Windows",
    sku_name="Y1")
example_windows_function_app = azure.appservice.WindowsFunctionApp("exampleWindowsFunctionApp",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    storage_account_name=example_account.name,
    storage_account_access_key=example_account.primary_access_key,
    service_plan_id=example_service_plan.id,
    site_config=azure.appservice.WindowsFunctionAppSiteConfigArgs())

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleServicePlan = new azure.appservice.ServicePlan("exampleServicePlan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    osType: "Windows",
    skuName: "Y1",
});
const exampleWindowsFunctionApp = new azure.appservice.WindowsFunctionApp("exampleWindowsFunctionApp", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    storageAccountName: exampleAccount.name,
    storageAccountAccessKey: exampleAccount.primaryAccessKey,
    servicePlanId: exampleServicePlan.id,
    siteConfig: {},
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleServicePlan:
    type: azure:appservice:ServicePlan
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      osType: Windows
      skuName: Y1
  exampleWindowsFunctionApp:
    type: azure:appservice:WindowsFunctionApp
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      storageAccountName: ${exampleAccount.name}
      storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
      servicePlanId: ${exampleServicePlan.id}
      siteConfig: {}

Create WindowsFunctionApp Resource

new WindowsFunctionApp(name: string, args: WindowsFunctionAppArgs, opts?: CustomResourceOptions);
@overload
def WindowsFunctionApp(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       app_settings: Optional[Mapping[str, str]] = None,
                       auth_settings: Optional[WindowsFunctionAppAuthSettingsArgs] = None,
                       auth_settings_v2: Optional[WindowsFunctionAppAuthSettingsV2Args] = None,
                       backup: Optional[WindowsFunctionAppBackupArgs] = None,
                       builtin_logging_enabled: Optional[bool] = None,
                       client_certificate_enabled: Optional[bool] = None,
                       client_certificate_exclusion_paths: Optional[str] = None,
                       client_certificate_mode: Optional[str] = None,
                       connection_strings: Optional[Sequence[WindowsFunctionAppConnectionStringArgs]] = None,
                       content_share_force_disabled: Optional[bool] = None,
                       daily_memory_time_quota: Optional[int] = None,
                       enabled: Optional[bool] = None,
                       functions_extension_version: Optional[str] = None,
                       https_only: Optional[bool] = None,
                       identity: Optional[WindowsFunctionAppIdentityArgs] = None,
                       key_vault_reference_identity_id: Optional[str] = None,
                       location: Optional[str] = None,
                       name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_plan_id: Optional[str] = None,
                       site_config: Optional[WindowsFunctionAppSiteConfigArgs] = None,
                       sticky_settings: Optional[WindowsFunctionAppStickySettingsArgs] = None,
                       storage_account_access_key: Optional[str] = None,
                       storage_account_name: Optional[str] = None,
                       storage_accounts: Optional[Sequence[WindowsFunctionAppStorageAccountArgs]] = None,
                       storage_key_vault_secret_id: Optional[str] = None,
                       storage_uses_managed_identity: Optional[bool] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       virtual_network_subnet_id: Optional[str] = None)
@overload
def WindowsFunctionApp(resource_name: str,
                       args: WindowsFunctionAppArgs,
                       opts: Optional[ResourceOptions] = None)
func NewWindowsFunctionApp(ctx *Context, name string, args WindowsFunctionAppArgs, opts ...ResourceOption) (*WindowsFunctionApp, error)
public WindowsFunctionApp(string name, WindowsFunctionAppArgs args, CustomResourceOptions? opts = null)
public WindowsFunctionApp(String name, WindowsFunctionAppArgs args)
public WindowsFunctionApp(String name, WindowsFunctionAppArgs args, CustomResourceOptions options)

type: azure:appservice:WindowsFunctionApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WindowsFunctionAppArgs
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 WindowsFunctionAppArgs
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 WindowsFunctionAppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WindowsFunctionAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args WindowsFunctionAppArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ResourceGroupName string

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

ServicePlanId string

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

SiteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

AppSettings Dictionary<string, string>

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

AuthSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

AuthSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

Backup WindowsFunctionAppBackupArgs

A backup block as defined below.

BuiltinLoggingEnabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

ClientCertificateEnabled bool

Should the function app use Client Certificates.

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

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

ConnectionStrings List<WindowsFunctionAppConnectionStringArgs>

One or more connection_string blocks as defined below.

ContentShareForceDisabled bool

Should Content Share Settings be disabled. Defaults to false.

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.

Enabled bool

Is the Function App enabled? Defaults to true.

FunctionsExtensionVersion string

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

HttpsOnly bool

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

Identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

Location string

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

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

StickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App.

StorageAccounts List<WindowsFunctionAppStorageAccountArgs>

One or more storage_account blocks as defined below.

StorageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

StorageUsesManagedIdentity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Windows Function App.

VirtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

ResourceGroupName string

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

ServicePlanId string

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

SiteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

AppSettings map[string]string

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

AuthSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

AuthSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

Backup WindowsFunctionAppBackupArgs

A backup block as defined below.

BuiltinLoggingEnabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

ClientCertificateEnabled bool

Should the function app use Client Certificates.

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

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

ConnectionStrings []WindowsFunctionAppConnectionStringArgs

One or more connection_string blocks as defined below.

ContentShareForceDisabled bool

Should Content Share Settings be disabled. Defaults to false.

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.

Enabled bool

Is the Function App enabled? Defaults to true.

FunctionsExtensionVersion string

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

HttpsOnly bool

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

Identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

Location string

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

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

StickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App.

StorageAccounts []WindowsFunctionAppStorageAccountArgs

One or more storage_account blocks as defined below.

StorageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

StorageUsesManagedIdentity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

Tags map[string]string

A mapping of tags which should be assigned to the Windows Function App.

VirtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

resourceGroupName String

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

servicePlanId String

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

siteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

appSettings Map<String,String>

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

authSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

authSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtinLoggingEnabled Boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled Boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

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

connectionStrings List<WindowsFunctionAppConnectionStringArgs>

One or more connection_string blocks as defined below.

contentShareForceDisabled Boolean

Should Content Share Settings be disabled. Defaults to false.

dailyMemoryTimeQuota Integer

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.

enabled Boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion String

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

httpsOnly Boolean

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

location String

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

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

stickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccountAccessKey String

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

storageAccountName String

The backend storage account name which will be used by this Function App.

storageAccounts List<WindowsFunctionAppStorageAccountArgs>

One or more storage_account blocks as defined below.

storageKeyVaultSecretId String

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity Boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Map<String,String>

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId String

The subnet id which will be used by this Function App for regional virtual network integration.

resourceGroupName string

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

servicePlanId string

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

siteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

appSettings {[key: string]: string}

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

authSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

authSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtinLoggingEnabled boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

clientCertificateMode string

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

connectionStrings WindowsFunctionAppConnectionStringArgs[]

One or more connection_string blocks as defined below.

contentShareForceDisabled boolean

Should Content Share Settings be disabled. Defaults to false.

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.

enabled boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion string

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

httpsOnly boolean

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

keyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

location string

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

name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

stickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccountAccessKey string

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

storageAccountName string

The backend storage account name which will be used by this Function App.

storageAccounts WindowsFunctionAppStorageAccountArgs[]

One or more storage_account blocks as defined below.

storageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

resource_group_name str

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

service_plan_id str

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

site_config WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

app_settings Mapping[str, str]

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

auth_settings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

auth_settings_v2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtin_logging_enabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

client_certificate_enabled bool

Should the function app use Client Certificates.

client_certificate_exclusion_paths str

Paths to exclude when using client certificates, separated by ;

client_certificate_mode str

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

connection_strings Sequence[WindowsFunctionAppConnectionStringArgs]

One or more connection_string blocks as defined below.

content_share_force_disabled bool

Should Content Share Settings be disabled. Defaults to false.

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

enabled bool

Is the Function App enabled? Defaults to true.

functions_extension_version str

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

https_only bool

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

key_vault_reference_identity_id str

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

location str

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

name str

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

sticky_settings WindowsFunctionAppStickySettingsArgs

A sticky_settings block 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. Conflicts with storage_uses_managed_identity.

storage_account_name str

The backend storage account name which will be used by this Function App.

storage_accounts Sequence[WindowsFunctionAppStorageAccountArgs]

One or more storage_account blocks as defined below.

storage_key_vault_secret_id str

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storage_uses_managed_identity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Windows Function App.

virtual_network_subnet_id str

The subnet id which will be used by this Function App for regional virtual network integration.

resourceGroupName String

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

servicePlanId String

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

siteConfig Property Map

A site_config block as defined below.

appSettings Map<String>

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

authSettings Property Map

A auth_settings block as defined below.

authSettingsV2 Property Map

A auth_settings_v2 block as defined below.

backup Property Map

A backup block as defined below.

builtinLoggingEnabled Boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled Boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

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

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

contentShareForceDisabled Boolean

Should Content Share Settings be disabled. Defaults to false.

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.

enabled Boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion String

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

httpsOnly Boolean

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

identity Property Map

A identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

location String

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

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

stickySettings Property Map

A sticky_settings block as defined below.

storageAccountAccessKey String

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

storageAccountName String

The backend storage account name which will be used by this Function App.

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

storageKeyVaultSecretId String

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity Boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Map<String>

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId String

The subnet id which will be used by this Function App for regional virtual network integration.

Outputs

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

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Function App.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The Kind value for this Windows Function App.

OutboundIpAddressLists List<string>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

PossibleOutboundIpAddressLists List<string>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

PossibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

SiteCredentials List<WindowsFunctionAppSiteCredential>

A site_credential block as defined below.

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Function App.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The Kind value for this Windows Function App.

OutboundIpAddressLists []string

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

PossibleOutboundIpAddressLists []string

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

PossibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

SiteCredentials []WindowsFunctionAppSiteCredential

A site_credential block as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Function App.

id String

The provider-assigned unique ID for this managed resource.

kind String

The Kind value for this Windows Function App.

outboundIpAddressLists List<String>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists List<String>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses String

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

siteCredentials List<WindowsFunctionAppSiteCredential>

A site_credential block as defined below.

customDomainVerificationId string

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

defaultHostname string

The default hostname of the Windows Function App.

id string

The provider-assigned unique ID for this managed resource.

kind string

The Kind value for this Windows Function App.

outboundIpAddressLists string[]

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists string[]

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

siteCredentials WindowsFunctionAppSiteCredential[]

A site_credential block as defined below.

custom_domain_verification_id str

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

default_hostname str

The default hostname of the Windows Function App.

id str

The provider-assigned unique ID for this managed resource.

kind str

The Kind value for this Windows Function App.

outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outbound_ip_addresses str

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possible_outbound_ip_address_lists Sequence[str]

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possible_outbound_ip_addresses str

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

site_credentials Sequence[WindowsFunctionAppSiteCredential]

A site_credential block as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Function App.

id String

The provider-assigned unique ID for this managed resource.

kind String

The Kind value for this Windows Function App.

outboundIpAddressLists List<String>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists List<String>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses String

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

siteCredentials List<Property Map>

A site_credential block as defined below.

Look up Existing WindowsFunctionApp Resource

Get an existing WindowsFunctionApp 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?: WindowsFunctionAppState, opts?: CustomResourceOptions): WindowsFunctionApp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_settings: Optional[Mapping[str, str]] = None,
        auth_settings: Optional[WindowsFunctionAppAuthSettingsArgs] = None,
        auth_settings_v2: Optional[WindowsFunctionAppAuthSettingsV2Args] = None,
        backup: Optional[WindowsFunctionAppBackupArgs] = None,
        builtin_logging_enabled: Optional[bool] = None,
        client_certificate_enabled: Optional[bool] = None,
        client_certificate_exclusion_paths: Optional[str] = None,
        client_certificate_mode: Optional[str] = None,
        connection_strings: Optional[Sequence[WindowsFunctionAppConnectionStringArgs]] = None,
        content_share_force_disabled: Optional[bool] = None,
        custom_domain_verification_id: Optional[str] = None,
        daily_memory_time_quota: Optional[int] = None,
        default_hostname: Optional[str] = None,
        enabled: Optional[bool] = None,
        functions_extension_version: Optional[str] = None,
        https_only: Optional[bool] = None,
        identity: Optional[WindowsFunctionAppIdentityArgs] = None,
        key_vault_reference_identity_id: Optional[str] = None,
        kind: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        outbound_ip_address_lists: Optional[Sequence[str]] = None,
        outbound_ip_addresses: Optional[str] = None,
        possible_outbound_ip_address_lists: Optional[Sequence[str]] = None,
        possible_outbound_ip_addresses: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        service_plan_id: Optional[str] = None,
        site_config: Optional[WindowsFunctionAppSiteConfigArgs] = None,
        site_credentials: Optional[Sequence[WindowsFunctionAppSiteCredentialArgs]] = None,
        sticky_settings: Optional[WindowsFunctionAppStickySettingsArgs] = None,
        storage_account_access_key: Optional[str] = None,
        storage_account_name: Optional[str] = None,
        storage_accounts: Optional[Sequence[WindowsFunctionAppStorageAccountArgs]] = None,
        storage_key_vault_secret_id: Optional[str] = None,
        storage_uses_managed_identity: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_network_subnet_id: Optional[str] = None) -> WindowsFunctionApp
func GetWindowsFunctionApp(ctx *Context, name string, id IDInput, state *WindowsFunctionAppState, opts ...ResourceOption) (*WindowsFunctionApp, error)
public static WindowsFunctionApp Get(string name, Input<string> id, WindowsFunctionAppState? state, CustomResourceOptions? opts = null)
public static WindowsFunctionApp get(String name, Output<String> id, WindowsFunctionAppState 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.
The following state arguments are supported:
AppSettings Dictionary<string, string>

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

AuthSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

AuthSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

Backup WindowsFunctionAppBackupArgs

A backup block as defined below.

BuiltinLoggingEnabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

ClientCertificateEnabled bool

Should the function app use Client Certificates.

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

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

ConnectionStrings List<WindowsFunctionAppConnectionStringArgs>

One or more connection_string blocks as defined below.

ContentShareForceDisabled bool

Should Content Share Settings be disabled. Defaults to false.

CustomDomainVerificationId string

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

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 of the Windows Function App.

Enabled bool

Is the Function App enabled? Defaults to true.

FunctionsExtensionVersion string

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

HttpsOnly bool

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

Identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

Kind string

The Kind value for this Windows Function App.

Location string

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

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

OutboundIpAddressLists List<string>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

PossibleOutboundIpAddressLists List<string>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

PossibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

ResourceGroupName string

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

ServicePlanId string

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

SiteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

SiteCredentials List<WindowsFunctionAppSiteCredentialArgs>

A site_credential block as defined below.

StickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App.

StorageAccounts List<WindowsFunctionAppStorageAccountArgs>

One or more storage_account blocks as defined below.

StorageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

StorageUsesManagedIdentity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Windows Function App.

VirtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

AppSettings map[string]string

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

AuthSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

AuthSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

Backup WindowsFunctionAppBackupArgs

A backup block as defined below.

BuiltinLoggingEnabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

ClientCertificateEnabled bool

Should the function app use Client Certificates.

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

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

ConnectionStrings []WindowsFunctionAppConnectionStringArgs

One or more connection_string blocks as defined below.

ContentShareForceDisabled bool

Should Content Share Settings be disabled. Defaults to false.

CustomDomainVerificationId string

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

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 of the Windows Function App.

Enabled bool

Is the Function App enabled? Defaults to true.

FunctionsExtensionVersion string

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

HttpsOnly bool

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

Identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

Kind string

The Kind value for this Windows Function App.

Location string

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

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

OutboundIpAddressLists []string

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

PossibleOutboundIpAddressLists []string

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

PossibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

ResourceGroupName string

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

ServicePlanId string

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

SiteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

SiteCredentials []WindowsFunctionAppSiteCredentialArgs

A site_credential block as defined below.

StickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccountAccessKey string

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

StorageAccountName string

The backend storage account name which will be used by this Function App.

StorageAccounts []WindowsFunctionAppStorageAccountArgs

One or more storage_account blocks as defined below.

StorageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

StorageUsesManagedIdentity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

Tags map[string]string

A mapping of tags which should be assigned to the Windows Function App.

VirtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

appSettings Map<String,String>

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

authSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

authSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtinLoggingEnabled Boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled Boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

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

connectionStrings List<WindowsFunctionAppConnectionStringArgs>

One or more connection_string blocks as defined below.

contentShareForceDisabled Boolean

Should Content Share Settings be disabled. Defaults to false.

customDomainVerificationId String

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

dailyMemoryTimeQuota Integer

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 of the Windows Function App.

enabled Boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion String

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

httpsOnly Boolean

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

kind String

The Kind value for this Windows Function App.

location String

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

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

outboundIpAddressLists List<String>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists List<String>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses String

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

resourceGroupName String

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

servicePlanId String

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

siteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

siteCredentials List<WindowsFunctionAppSiteCredentialArgs>

A site_credential block as defined below.

stickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccountAccessKey String

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

storageAccountName String

The backend storage account name which will be used by this Function App.

storageAccounts List<WindowsFunctionAppStorageAccountArgs>

One or more storage_account blocks as defined below.

storageKeyVaultSecretId String

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity Boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Map<String,String>

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId String

The subnet id which will be used by this Function App for regional virtual network integration.

appSettings {[key: string]: string}

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

authSettings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

authSettingsV2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtinLoggingEnabled boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

clientCertificateMode string

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

connectionStrings WindowsFunctionAppConnectionStringArgs[]

One or more connection_string blocks as defined below.

contentShareForceDisabled boolean

Should Content Share Settings be disabled. Defaults to false.

customDomainVerificationId string

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

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 of the Windows Function App.

enabled boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion string

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

httpsOnly boolean

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

keyVaultReferenceIdentityId string

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

kind string

The Kind value for this Windows Function App.

location string

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

name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

outboundIpAddressLists string[]

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses string

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists string[]

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses string

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

resourceGroupName string

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

servicePlanId string

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

siteConfig WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

siteCredentials WindowsFunctionAppSiteCredentialArgs[]

A site_credential block as defined below.

stickySettings WindowsFunctionAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccountAccessKey string

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

storageAccountName string

The backend storage account name which will be used by this Function App.

storageAccounts WindowsFunctionAppStorageAccountArgs[]

One or more storage_account blocks as defined below.

storageKeyVaultSecretId string

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId string

The subnet id which will be used by this Function App for regional virtual network integration.

app_settings Mapping[str, str]

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

auth_settings WindowsFunctionAppAuthSettingsArgs

A auth_settings block as defined below.

auth_settings_v2 WindowsFunctionAppAuthSettingsV2Args

A auth_settings_v2 block as defined below.

backup WindowsFunctionAppBackupArgs

A backup block as defined below.

builtin_logging_enabled bool

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

client_certificate_enabled bool

Should the function app use Client Certificates.

client_certificate_exclusion_paths str

Paths to exclude when using client certificates, separated by ;

client_certificate_mode str

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

connection_strings Sequence[WindowsFunctionAppConnectionStringArgs]

One or more connection_string blocks as defined below.

content_share_force_disabled bool

Should Content Share Settings be disabled. Defaults to false.

custom_domain_verification_id str

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

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

default_hostname str

The default hostname of the Windows Function App.

enabled bool

Is the Function App enabled? Defaults to true.

functions_extension_version str

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

https_only bool

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

identity WindowsFunctionAppIdentityArgs

A identity block as defined below.

key_vault_reference_identity_id str

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

kind str

The Kind value for this Windows Function App.

location str

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

name str

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outbound_ip_addresses str

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possible_outbound_ip_address_lists Sequence[str]

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possible_outbound_ip_addresses str

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

resource_group_name str

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

service_plan_id str

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

site_config WindowsFunctionAppSiteConfigArgs

A site_config block as defined below.

site_credentials Sequence[WindowsFunctionAppSiteCredentialArgs]

A site_credential block as defined below.

sticky_settings WindowsFunctionAppStickySettingsArgs

A sticky_settings block 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. Conflicts with storage_uses_managed_identity.

storage_account_name str

The backend storage account name which will be used by this Function App.

storage_accounts Sequence[WindowsFunctionAppStorageAccountArgs]

One or more storage_account blocks as defined below.

storage_key_vault_secret_id str

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storage_uses_managed_identity bool

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Windows Function App.

virtual_network_subnet_id str

The subnet id which will be used by this Function App for regional virtual network integration.

appSettings Map<String>

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

authSettings Property Map

A auth_settings block as defined below.

authSettingsV2 Property Map

A auth_settings_v2 block as defined below.

backup Property Map

A backup block as defined below.

builtinLoggingEnabled Boolean

Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true.

clientCertificateEnabled Boolean

Should the function app use Client Certificates.

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

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

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

contentShareForceDisabled Boolean

Should Content Share Settings be disabled. Defaults to false.

customDomainVerificationId String

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

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 of the Windows Function App.

enabled Boolean

Is the Function App enabled? Defaults to true.

functionsExtensionVersion String

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

httpsOnly Boolean

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

identity Property Map

A identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity

kind String

The Kind value for this Windows Function App.

location String

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

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

outboundIpAddressLists List<String>

A list of outbound IP addresses. For example ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

A comma separated list of outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12.

possibleOutboundIpAddressLists List<String>

A list of possible outbound IP addresses, not all of which are necessarily in use. This is a superset of outbound_ip_address_list. For example ["52.23.25.3", "52.143.43.12"].

possibleOutboundIpAddresses String

A comma separated list of possible outbound IP addresses as a string. For example 52.23.25.3,52.143.43.12,52.143.43.17. This is a superset of outbound_ip_addresses. For example ["52.23.25.3", "52.143.43.12","52.143.43.17"].

resourceGroupName String

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

servicePlanId String

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

siteConfig Property Map

A site_config block as defined below.

siteCredentials List<Property Map>

A site_credential block as defined below.

stickySettings Property Map

A sticky_settings block as defined below.

storageAccountAccessKey String

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

storageAccountName String

The backend storage account name which will be used by this Function App.

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

storageKeyVaultSecretId String

The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.

storageUsesManagedIdentity Boolean

Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key.

tags Map<String>

A mapping of tags which should be assigned to the Windows Function App.

virtualNetworkSubnetId String

The subnet id which will be used by this Function App for regional virtual network integration.

Supporting Types

WindowsFunctionAppAuthSettings

Enabled bool

Should the Authentication / Authorization feature be enabled for the Windows Function App?

ActiveDirectory WindowsFunctionAppAuthSettingsActiveDirectory

An active_directory block as defined above.

AdditionalLoginParameters Dictionary<string, string>

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

AllowedExternalRedirectUrls List<string>

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

DefaultProvider string

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

Facebook WindowsFunctionAppAuthSettingsFacebook

A facebook block as defined below.

Github WindowsFunctionAppAuthSettingsGithub

A github block as defined below.

Google WindowsFunctionAppAuthSettingsGoogle

A google block as defined below.

Issuer string

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

Microsoft WindowsFunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

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

TokenStoreEnabled bool

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

Twitter WindowsFunctionAppAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

Enabled bool

Should the Authentication / Authorization feature be enabled for the Windows Function App?

ActiveDirectory WindowsFunctionAppAuthSettingsActiveDirectory

An active_directory block as defined above.

AdditionalLoginParameters map[string]string

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

AllowedExternalRedirectUrls []string

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

DefaultProvider string

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

Facebook WindowsFunctionAppAuthSettingsFacebook

A facebook block as defined below.

Github WindowsFunctionAppAuthSettingsGithub

A github block as defined below.

Google WindowsFunctionAppAuthSettingsGoogle

A google block as defined below.

Issuer string

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

Microsoft WindowsFunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

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

TokenStoreEnabled bool

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

Twitter WindowsFunctionAppAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

enabled Boolean

Should the Authentication / Authorization feature be enabled for the Windows Function App?

activeDirectory WindowsFunctionAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additionalLoginParameters Map<String,String>

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

allowedExternalRedirectUrls List<String>

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

defaultProvider String

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

facebook WindowsFunctionAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsFunctionAppAuthSettingsGithub

A github block as defined below.

google WindowsFunctionAppAuthSettingsGoogle

A google block as defined below.

issuer String

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

microsoft WindowsFunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion String

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

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

tokenStoreEnabled Boolean

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

twitter WindowsFunctionAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction String

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

enabled boolean

Should the Authentication / Authorization feature be enabled for the Windows Function App?

activeDirectory WindowsFunctionAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additionalLoginParameters {[key: string]: string}

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

allowedExternalRedirectUrls string[]

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

defaultProvider string

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

facebook WindowsFunctionAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsFunctionAppAuthSettingsGithub

A github block as defined below.

google WindowsFunctionAppAuthSettingsGoogle

A google block as defined below.

issuer string

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

microsoft WindowsFunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion string

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

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

tokenStoreEnabled boolean

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

twitter WindowsFunctionAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

enabled bool

Should the Authentication / Authorization feature be enabled for the Windows Function App?

active_directory WindowsFunctionAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additional_login_parameters Mapping[str, str]

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

allowed_external_redirect_urls Sequence[str]

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

default_provider str

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

facebook WindowsFunctionAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsFunctionAppAuthSettingsGithub

A github block as defined below.

google WindowsFunctionAppAuthSettingsGoogle

A google block as defined below.

issuer str

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

microsoft WindowsFunctionAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtime_version str

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

token_refresh_extension_hours 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 hours.

token_store_enabled bool

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

twitter WindowsFunctionAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticated_client_action str

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

enabled Boolean

Should the Authentication / Authorization feature be enabled for the Windows Function App?

activeDirectory Property Map

An active_directory block as defined above.

additionalLoginParameters Map<String>

Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.

allowedExternalRedirectUrls List<String>

Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Function App.

defaultProvider String

The Default Authentication Provider to use when more than one Authentication Provider is configured and the unauthenticated_action is set to RedirectToLoginPage.

facebook Property Map

A facebook block as defined below.

github Property Map

A github block as defined below.

google Property Map

A google block as defined below.

issuer String

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.

microsoft Property Map

A microsoft block as defined below.

runtimeVersion String

The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to ~1.

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

tokenStoreEnabled Boolean

Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to false.

twitter Property Map

A twitter block as defined below.

unauthenticatedClientAction String

The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage, AllowAnonymous.

WindowsFunctionAppAuthSettingsActiveDirectory

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

AllowedAudiences List<string>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

AllowedAudiences []string

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret String

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

allowedAudiences string[]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret string

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

allowed_audiences Sequence[str]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

client_secret str

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret String

The Client Secret for the Client ID. Cannot be used with client_secret_setting_name.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

WindowsFunctionAppAuthSettingsFacebook

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. Cannot be specified with app_secret_setting_name.

AppSecretSettingName string

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

OauthScopes List<string>

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

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. Cannot be specified with app_secret_setting_name.

AppSecretSettingName string

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

OauthScopes []string

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

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. Cannot be specified with app_secret_setting_name.

appSecretSettingName String

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

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. Cannot be specified with app_secret_setting_name.

appSecretSettingName string

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

oauthScopes string[]

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

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. Cannot be specified with app_secret_setting_name.

app_secret_setting_name str

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

oauth_scopes Sequence[str]

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

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. Cannot be specified with app_secret_setting_name.

appSecretSettingName String

The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.

WindowsFunctionAppAuthSettingsGithub

ClientId string

The ID of the GitHub app used for login.

ClientSecret string

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

OauthScopes List<string>

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

ClientId string

The ID of the GitHub app used for login.

ClientSecret string

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

OauthScopes []string

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

clientId String

The ID of the GitHub app used for login.

clientSecret String

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

clientId string

The ID of the GitHub app used for login.

clientSecret string

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

clientSecretSettingName string

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

oauthScopes string[]

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

client_id str

The ID of the GitHub app used for login.

client_secret str

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

client_secret_setting_name str

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

oauth_scopes Sequence[str]

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

clientId String

The ID of the GitHub app used for login.

clientSecret String

The Client Secret of the GitHub app used for GitHub login. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name that contains the client_secret value used for GitHub login. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.

WindowsFunctionAppAuthSettingsGoogle

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

OauthScopes List<string>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

OauthScopes []string

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

clientId string

The OpenID Connect Client ID for the Google web application.

clientSecret string

The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name.

clientSecretSettingName string

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

oauthScopes string[]

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

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. Cannot be specified with client_secret_setting_name.

client_secret_setting_name str

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

oauth_scopes Sequence[str]

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name that contains the client_secret value used for Google login. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, openid, profile, and email are used as default scopes.

WindowsFunctionAppAuthSettingsMicrosoft

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. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

OauthScopes List<string>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

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. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

OauthScopes []string

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

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. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

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. Cannot be specified with client_secret_setting_name.

clientSecretSettingName string

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

oauthScopes string[]

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

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. Cannot be specified with client_secret_setting_name.

client_secret_setting_name str

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

oauth_scopes Sequence[str]

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

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. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret.

oauthScopes List<String>

Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope.

WindowsFunctionAppAuthSettingsTwitter

ConsumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

ConsumerSecret string

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name.

ConsumerSecretSettingName string

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

ConsumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

ConsumerSecret string

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name.

ConsumerSecretSettingName string

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

consumerKey String

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecret String

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name.

consumerSecretSettingName String

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

consumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecret string

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name.

consumerSecretSettingName string

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

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. Cannot be specified with consumer_secret_setting_name.

consumer_secret_setting_name str

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

consumerKey String

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecret String

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name.

consumerSecretSettingName String

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret.

WindowsFunctionAppAuthSettingsV2

Login WindowsFunctionAppAuthSettingsV2Login

A login block as defined below.

ActiveDirectoryV2 WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

AppleV2 WindowsFunctionAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

AuthEnabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

AzureStaticWebAppV2 WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

ConfigFilePath string

The path to the App Auth settings.

CustomOidcV2s List<WindowsFunctionAppAuthSettingsV2CustomOidcV2>

Zero or more custom_oidc_v2 blocks as defined below.

DefaultProvider string

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

ExcludedPaths List<string>

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

FacebookV2 WindowsFunctionAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

ForwardProxyConvention string

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

ForwardProxyCustomHostHeaderName string

The name of the custom header containing the host of the request.

ForwardProxyCustomSchemeHeaderName string

The name of the custom header containing the scheme of the request.

GithubV2 WindowsFunctionAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

GoogleV2 WindowsFunctionAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

HttpRouteApiPrefix string

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

MicrosoftV2 WindowsFunctionAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

RequireAuthentication bool

Should the authentication flow be used for all requests.

RequireHttps bool

Should HTTPS be required on connections? Defaults to true.

RuntimeVersion string

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

TwitterV2 WindowsFunctionAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

UnauthenticatedAction string

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

Login WindowsFunctionAppAuthSettingsV2Login

A login block as defined below.

ActiveDirectoryV2 WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

AppleV2 WindowsFunctionAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

AuthEnabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

AzureStaticWebAppV2 WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

ConfigFilePath string

The path to the App Auth settings.

CustomOidcV2s []WindowsFunctionAppAuthSettingsV2CustomOidcV2

Zero or more custom_oidc_v2 blocks as defined below.

DefaultProvider string

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

ExcludedPaths []string

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

FacebookV2 WindowsFunctionAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

ForwardProxyConvention string

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

ForwardProxyCustomHostHeaderName string

The name of the custom header containing the host of the request.

ForwardProxyCustomSchemeHeaderName string

The name of the custom header containing the scheme of the request.

GithubV2 WindowsFunctionAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

GoogleV2 WindowsFunctionAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

HttpRouteApiPrefix string

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

MicrosoftV2 WindowsFunctionAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

RequireAuthentication bool

Should the authentication flow be used for all requests.

RequireHttps bool

Should HTTPS be required on connections? Defaults to true.

RuntimeVersion string

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

TwitterV2 WindowsFunctionAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

UnauthenticatedAction string

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

login WindowsFunctionAppAuthSettingsV2Login

A login block as defined below.

activeDirectoryV2 WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

appleV2 WindowsFunctionAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

authEnabled Boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

configFilePath String

The path to the App Auth settings.

customOidcV2s List<WindowsFunctionAppAuthSettingsV2CustomOidcV2>

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider String

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

excludedPaths List<String>

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

facebookV2 WindowsFunctionAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forwardProxyConvention String

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

forwardProxyCustomHostHeaderName String

The name of the custom header containing the host of the request.

forwardProxyCustomSchemeHeaderName String

The name of the custom header containing the scheme of the request.

githubV2 WindowsFunctionAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

googleV2 WindowsFunctionAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

httpRouteApiPrefix String

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

microsoftV2 WindowsFunctionAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

requireAuthentication Boolean

Should the authentication flow be used for all requests.

requireHttps Boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion String

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

twitterV2 WindowsFunctionAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticatedAction String

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

login WindowsFunctionAppAuthSettingsV2Login

A login block as defined below.

activeDirectoryV2 WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

appleV2 WindowsFunctionAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

authEnabled boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

configFilePath string

The path to the App Auth settings.

customOidcV2s WindowsFunctionAppAuthSettingsV2CustomOidcV2[]

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider string

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

excludedPaths string[]

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

facebookV2 WindowsFunctionAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forwardProxyConvention string

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

forwardProxyCustomHostHeaderName string

The name of the custom header containing the host of the request.

forwardProxyCustomSchemeHeaderName string

The name of the custom header containing the scheme of the request.

githubV2 WindowsFunctionAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

googleV2 WindowsFunctionAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

httpRouteApiPrefix string

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

microsoftV2 WindowsFunctionAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

requireAuthentication boolean

Should the authentication flow be used for all requests.

requireHttps boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion string

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

twitterV2 WindowsFunctionAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticatedAction string

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

login WindowsFunctionAppAuthSettingsV2Login

A login block as defined below.

active_directory_v2 WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

apple_v2 WindowsFunctionAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

auth_enabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

azure_static_web_app_v2 WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

config_file_path str

The path to the App Auth settings.

custom_oidc_v2s Sequence[WindowsFunctionAppAuthSettingsV2CustomOidcV2]

Zero or more custom_oidc_v2 blocks as defined below.

default_provider str

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

excluded_paths Sequence[str]

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

facebook_v2 WindowsFunctionAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forward_proxy_convention str

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

forward_proxy_custom_host_header_name str

The name of the custom header containing the host of the request.

forward_proxy_custom_scheme_header_name str

The name of the custom header containing the scheme of the request.

github_v2 WindowsFunctionAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

google_v2 WindowsFunctionAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

http_route_api_prefix str

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

microsoft_v2 WindowsFunctionAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

require_authentication bool

Should the authentication flow be used for all requests.

require_https bool

Should HTTPS be required on connections? Defaults to true.

runtime_version str

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

twitter_v2 WindowsFunctionAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticated_action str

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

login Property Map

A login block as defined below.

activeDirectoryV2 Property Map

An active_directory_v2 block as defined below.

appleV2 Property Map

An apple_v2 block as defined below.

authEnabled Boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 Property Map

An azure_static_web_app_v2 block as defined below.

configFilePath String

The path to the App Auth settings.

customOidcV2s List<Property Map>

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider String

The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github

excludedPaths List<String>

The paths which should be excluded from the unauthenticated_action when it is set to RedirectToLoginPage.

facebookV2 Property Map

A facebook_v2 block as defined below.

forwardProxyConvention String

The convention used to determine the url of the request made. Possible values include ForwardProxyConventionNoProxy, ForwardProxyConventionStandard, ForwardProxyConventionCustom. Defaults to ForwardProxyConventionNoProxy.

forwardProxyCustomHostHeaderName String

The name of the custom header containing the host of the request.

forwardProxyCustomSchemeHeaderName String

The name of the custom header containing the scheme of the request.

githubV2 Property Map

A github_v2 block as defined below.

googleV2 Property Map

A google_v2 block as defined below.

httpRouteApiPrefix String

The prefix that should precede all the authentication and authorisation paths. Defaults to /.auth.

microsoftV2 Property Map

A microsoft_v2 block as defined below.

requireAuthentication Boolean

Should the authentication flow be used for all requests.

requireHttps Boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion String

The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.

twitterV2 Property Map

A twitter_v2 block as defined below.

unauthenticatedAction String

The action to take for requests made without authentication. Possible values include RedirectToLoginPage, AllowAnonymous, Return401, and Return403. Defaults to RedirectToLoginPage.

WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

TenantAuthEndpoint string

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

AllowedApplications List<string>

The list of allowed Applications for the Default Authorisation Policy.

AllowedAudiences List<string>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

AllowedGroups List<string>

The list of allowed Group Names for the Default Authorisation Policy.

AllowedIdentities List<string>

The list of allowed Identities for the Default Authorisation Policy.

ClientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

JwtAllowedClientApplications List<string>

A list of Allowed Client Applications in the JWT Claim.

JwtAllowedGroups List<string>

A list of Allowed Groups in the JWT Claim.

LoginParameters Dictionary<string, string>

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

WwwAuthenticationDisabled bool

Should the www-authenticate provider should be omitted from the request? Defaults to false

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

TenantAuthEndpoint string

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

AllowedApplications []string

The list of allowed Applications for the Default Authorisation Policy.

AllowedAudiences []string

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

AllowedGroups []string

The list of allowed Group Names for the Default Authorisation Policy.

AllowedIdentities []string

The list of allowed Identities for the Default Authorisation Policy.

ClientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

JwtAllowedClientApplications []string

A list of Allowed Client Applications in the JWT Claim.

JwtAllowedGroups []string

A list of Allowed Groups in the JWT Claim.

LoginParameters map[string]string

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

WwwAuthenticationDisabled bool

Should the www-authenticate provider should be omitted from the request? Defaults to false

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

tenantAuthEndpoint String

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

allowedApplications List<String>

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

allowedGroups List<String>

The list of allowed Group Names for the Default Authorisation Policy.

allowedIdentities List<String>

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint String

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

jwtAllowedClientApplications List<String>

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups List<String>

A list of Allowed Groups in the JWT Claim.

loginParameters Map<String,String>

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

wwwAuthenticationDisabled Boolean

Should the www-authenticate provider should be omitted from the request? Defaults to false

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

tenantAuthEndpoint string

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

allowedApplications string[]

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences string[]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

allowedGroups string[]

The list of allowed Group Names for the Default Authorisation Policy.

allowedIdentities string[]

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

jwtAllowedClientApplications string[]

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups string[]

A list of Allowed Groups in the JWT Claim.

loginParameters {[key: string]: string}

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

wwwAuthenticationDisabled boolean

Should the www-authenticate provider should be omitted from the request? Defaults to false

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

tenant_auth_endpoint str

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

allowed_applications Sequence[str]

The list of allowed Applications for the Default Authorisation Policy.

allowed_audiences Sequence[str]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

allowed_groups Sequence[str]

The list of allowed Group Names for the Default Authorisation Policy.

allowed_identities Sequence[str]

The list of allowed Identities for the Default Authorisation Policy.

client_secret_certificate_thumbprint str

The thumbprint of the certificate used for signing purposes.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

jwt_allowed_client_applications Sequence[str]

A list of Allowed Client Applications in the JWT Claim.

jwt_allowed_groups Sequence[str]

A list of Allowed Groups in the JWT Claim.

login_parameters Mapping[str, str]

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

www_authentication_disabled bool

Should the www-authenticate provider should be omitted from the request? Defaults to false

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

tenantAuthEndpoint String

The Azure Tenant Endpoint for the Authenticating Tenant. e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/

allowedApplications List<String>

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

allowedGroups List<String>

The list of allowed Group Names for the Default Authorisation Policy.

allowedIdentities List<String>

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint String

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

jwtAllowedClientApplications List<String>

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups List<String>

A list of Allowed Groups in the JWT Claim.

loginParameters Map<String>

A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.

wwwAuthenticationDisabled Boolean

Should the www-authenticate provider should be omitted from the request? Defaults to false

WindowsFunctionAppAuthSettingsV2AppleV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

WindowsFunctionAppAuthSettingsV2CustomOidcV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

OpenidConfigurationEndpoint string

The app setting name that contains the client_secret value used for the Custom OIDC Login.

AuthorisationEndpoint string

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

CertificationUri string

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

ClientCredentialMethod string

The Client Credential Method used.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

IssuerEndpoint string

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

NameClaimType string

The name of the claim that contains the users name.

Scopes List<string>

The list of the scopes that should be requested while authenticating.

TokenEndpoint string

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

OpenidConfigurationEndpoint string

The app setting name that contains the client_secret value used for the Custom OIDC Login.

AuthorisationEndpoint string

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

CertificationUri string

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

ClientCredentialMethod string

The Client Credential Method used.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

IssuerEndpoint string

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

NameClaimType string

The name of the claim that contains the users name.

Scopes []string

The list of the scopes that should be requested while authenticating.

TokenEndpoint string

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

openidConfigurationEndpoint String

The app setting name that contains the client_secret value used for the Custom OIDC Login.

authorisationEndpoint String

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

certificationUri String

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

clientCredentialMethod String

The Client Credential Method used.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

issuerEndpoint String

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

nameClaimType String

The name of the claim that contains the users name.

scopes List<String>

The list of the scopes that should be requested while authenticating.

tokenEndpoint String

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

openidConfigurationEndpoint string

The app setting name that contains the client_secret value used for the Custom OIDC Login.

authorisationEndpoint string

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

certificationUri string

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

clientCredentialMethod string

The Client Credential Method used.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

issuerEndpoint string

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

nameClaimType string

The name of the claim that contains the users name.

scopes string[]

The list of the scopes that should be requested while authenticating.

tokenEndpoint string

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

name str

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

openid_configuration_endpoint str

The app setting name that contains the client_secret value used for the Custom OIDC Login.

authorisation_endpoint str

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

certification_uri str

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

client_credential_method str

The Client Credential Method used.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

issuer_endpoint str

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

name_claim_type str

The name of the claim that contains the users name.

scopes Sequence[str]

The list of the scopes that should be requested while authenticating.

token_endpoint str

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

openidConfigurationEndpoint String

The app setting name that contains the client_secret value used for the Custom OIDC Login.

authorisationEndpoint String

The endpoint to make the Authorisation Request as supplied by openid_configuration_endpoint response.

certificationUri String

The endpoint that provides the keys necessary to validate the token as supplied by openid_configuration_endpoint response.

clientCredentialMethod String

The Client Credential Method used.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

issuerEndpoint String

The endpoint that issued the Token as supplied by openid_configuration_endpoint response.

nameClaimType String

The name of the claim that contains the users name.

scopes List<String>

The list of the scopes that should be requested while authenticating.

tokenEndpoint String

The endpoint used to request a Token as supplied by openid_configuration_endpoint response.

WindowsFunctionAppAuthSettingsV2FacebookV2

AppId string

The App ID of the Facebook app used for login.

AppSecretSettingName string

The app setting name that contains the app_secret value used for Facebook Login.

GraphApiVersion string

The version of the Facebook API to be used while logging in.

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

AppId string

The App ID of the Facebook app used for login.

AppSecretSettingName string

The app setting name that contains the app_secret value used for Facebook Login.

GraphApiVersion string

The version of the Facebook API to be used while logging in.

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

appId String

The App ID of the Facebook app used for login.

appSecretSettingName String

The app setting name that contains the app_secret value used for Facebook Login.

graphApiVersion String

The version of the Facebook API to be used while logging in.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

appId string

The App ID of the Facebook app used for login.

appSecretSettingName string

The app setting name that contains the app_secret value used for Facebook Login.

graphApiVersion string

The version of the Facebook API to be used while logging in.

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

app_id str

The App ID of the Facebook app used for login.

app_secret_setting_name str

The app setting name that contains the app_secret value used for Facebook Login.

graph_api_version str

The version of the Facebook API to be used while logging in.

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

appId String

The App ID of the Facebook app used for login.

appSecretSettingName String

The app setting name that contains the app_secret value used for Facebook Login.

graphApiVersion String

The version of the Facebook API to be used while logging in.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsFunctionAppAuthSettingsV2GithubV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsFunctionAppAuthSettingsV2GoogleV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

AllowedAudiences List<string>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

AllowedAudiences []string

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences string[]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowed_audiences Sequence[str]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsFunctionAppAuthSettingsV2Login

AllowedExternalRedirectUrls List<string>

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

CookieExpirationConvention string

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

CookieExpirationTime string

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

LogoutEndpoint string

The endpoint to which logout requests should be made.

NonceExpirationTime string

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

PreserveUrlFragmentsForLogins bool

Should the fragments from the request be preserved after the login request is made. Defaults to false.

TokenRefreshExtensionTime 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 hours.

TokenStoreEnabled bool

Should the Token Store configuration Enabled. Defaults to false

TokenStorePath string

The directory path in the App Filesystem in which the tokens will be stored.

TokenStoreSasSettingName string

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

ValidateNonce bool

Should the nonce be validated while completing the login flow. Defaults to true.

AllowedExternalRedirectUrls []string

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

CookieExpirationConvention string

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

CookieExpirationTime string

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

LogoutEndpoint string

The endpoint to which logout requests should be made.

NonceExpirationTime string

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

PreserveUrlFragmentsForLogins bool

Should the fragments from the request be preserved after the login request is made. Defaults to false.

TokenRefreshExtensionTime 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 hours.

TokenStoreEnabled bool

Should the Token Store configuration Enabled. Defaults to false

TokenStorePath string

The directory path in the App Filesystem in which the tokens will be stored.

TokenStoreSasSettingName string

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

ValidateNonce bool

Should the nonce be validated while completing the login flow. Defaults to true.

allowedExternalRedirectUrls List<String>

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

cookieExpirationConvention String

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

cookieExpirationTime String

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

logoutEndpoint String

The endpoint to which logout requests should be made.

nonceExpirationTime String

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

preserveUrlFragmentsForLogins Boolean

Should the fragments from the request be preserved after the login request is made. Defaults to false.

tokenRefreshExtensionTime 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 hours.

tokenStoreEnabled Boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath String

The directory path in the App Filesystem in which the tokens will be stored.

tokenStoreSasSettingName String

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

validateNonce Boolean

Should the nonce be validated while completing the login flow. Defaults to true.

allowedExternalRedirectUrls string[]

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

cookieExpirationConvention string

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

cookieExpirationTime string

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

logoutEndpoint string

The endpoint to which logout requests should be made.

nonceExpirationTime string

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

preserveUrlFragmentsForLogins boolean

Should the fragments from the request be preserved after the login request is made. Defaults to false.

tokenRefreshExtensionTime 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 hours.

tokenStoreEnabled boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath string

The directory path in the App Filesystem in which the tokens will be stored.

tokenStoreSasSettingName string

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

validateNonce boolean

Should the nonce be validated while completing the login flow. Defaults to true.

allowed_external_redirect_urls Sequence[str]

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

cookie_expiration_convention str

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

cookie_expiration_time str

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

logout_endpoint str

The endpoint to which logout requests should be made.

nonce_expiration_time str

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

preserve_url_fragments_for_logins bool

Should the fragments from the request be preserved after the login request is made. Defaults to false.

token_refresh_extension_time 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 hours.

token_store_enabled bool

Should the Token Store configuration Enabled. Defaults to false

token_store_path str

The directory path in the App Filesystem in which the tokens will be stored.

token_store_sas_setting_name str

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

validate_nonce bool

Should the nonce be validated while completing the login flow. Defaults to true.

allowedExternalRedirectUrls List<String>

External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.

cookieExpirationConvention String

The method by which cookies expire. Possible values include: FixedTime, and IdentityProviderDerived. Defaults to FixedTime.

cookieExpirationTime String

The time after the request is made when the session cookie should expire. Defaults to 08:00:00.

logoutEndpoint String

The endpoint to which logout requests should be made.

nonceExpirationTime String

The time after the request is made when the nonce should expire. Defaults to 00:05:00.

preserveUrlFragmentsForLogins Boolean

Should the fragments from the request be preserved after the login request is made. Defaults to false.

tokenRefreshExtensionTime 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 hours.

tokenStoreEnabled Boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath String

The directory path in the App Filesystem in which the tokens will be stored.

tokenStoreSasSettingName String

The name of the app setting which contains the SAS URL of the blob storage containing the tokens.

validateNonce Boolean

Should the nonce be validated while completing the login flow. Defaults to true.

WindowsFunctionAppAuthSettingsV2MicrosoftV2

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

AllowedAudiences List<string>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

The ID of the Client to use to authenticate with Azure Active Directory.

ClientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

AllowedAudiences []string

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName string

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences string[]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

The ID of the Client to use to authenticate with Azure Active Directory.

client_secret_setting_name str

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowed_audiences Sequence[str]

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

The ID of the Client to use to authenticate with Azure Active Directory.

clientSecretSettingName String

The App Setting name that contains the client secret of the Client. Cannot be used with client_secret.

allowedAudiences List<String>

Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsFunctionAppAuthSettingsV2TwitterV2

ConsumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

ConsumerSecretSettingName string

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

ConsumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

ConsumerSecretSettingName string

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

consumerKey String

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecretSettingName String

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

consumerKey string

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecretSettingName string

The app setting name that contains 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_setting_name str

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

consumerKey String

The OAuth 1.0a consumer key of the Twitter application used for sign-in.

consumerSecretSettingName String

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

WindowsFunctionAppBackup

Name string

The name which should be used for this Backup.

Schedule WindowsFunctionAppBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to the container.

Enabled bool

Should this backup job be enabled? Defaults to true.

Name string

The name which should be used for this Backup.

Schedule WindowsFunctionAppBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to the container.

Enabled bool

Should this backup job be enabled? Defaults to true.

name String

The name which should be used for this Backup.

schedule WindowsFunctionAppBackupSchedule

A schedule block as defined below.

storageAccountUrl String

The SAS URL to the container.

enabled Boolean

Should this backup job be enabled? Defaults to true.

name string

The name which should be used for this Backup.

schedule WindowsFunctionAppBackupSchedule

A schedule block as defined below.

storageAccountUrl string

The SAS URL to the container.

enabled boolean

Should this backup job be enabled? Defaults to true.

name str

The name which should be used for this Backup.

schedule WindowsFunctionAppBackupSchedule

A schedule block as defined below.

storage_account_url str

The SAS URL to the container.

enabled bool

Should this backup job be enabled? Defaults to true.

name String

The name which should be used for this Backup.

schedule Property Map

A schedule block as defined below.

storageAccountUrl String

The SAS URL to the container.

enabled Boolean

Should this backup job be enabled? Defaults to true.

WindowsFunctionAppBackupSchedule

FrequencyInterval int

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

FrequencyUnit string

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

KeepAtLeastOneBackup bool

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

LastExecutionTime string
RetentionPeriodDays int

After how many days backups should be deleted. Defaults to 30.

StartTime string

When the schedule should start working in RFC-3339 format.

FrequencyInterval int

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

FrequencyUnit string

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

KeepAtLeastOneBackup bool

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

LastExecutionTime string
RetentionPeriodDays int

After how many days backups should be deleted. Defaults to 30.

StartTime string

When the schedule should start working in RFC-3339 format.

frequencyInterval Integer

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

frequencyUnit String

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

keepAtLeastOneBackup Boolean

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

lastExecutionTime String
retentionPeriodDays Integer

After how many days backups should be deleted. Defaults to 30.

startTime String

When the schedule should start working in RFC-3339 format.

frequencyInterval number

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

frequencyUnit string

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

keepAtLeastOneBackup boolean

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

lastExecutionTime string
retentionPeriodDays number

After how many days backups should be deleted. Defaults to 30.

startTime string

When the schedule should start working in RFC-3339 format.

frequency_interval int

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

frequency_unit str

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

keep_at_least_one_backup bool

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

last_execution_time str
retention_period_days int

After how many days backups should be deleted. Defaults to 30.

start_time str

When the schedule should start working in RFC-3339 format.

frequencyInterval Number

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day).

frequencyUnit String

The unit of time for how often the backup should take place. Possible values include: Day and Hour.

keepAtLeastOneBackup Boolean

Should the service keep at least one backup, regardless of age of backup. Defaults to false.

lastExecutionTime String
retentionPeriodDays Number

After how many days backups should be deleted. Defaults to 30.

startTime String

When the schedule should start working in RFC-3339 format.

WindowsFunctionAppConnectionString

Name string

The name which should be used for this Connection.

Type string

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

Value string

The connection string value.

Name string

The name which should be used for this Connection.

Type string

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

Value string

The connection string value.

name String

The name which should be used for this Connection.

type String

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

value String

The connection string value.

name string

The name which should be used for this Connection.

type string

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

value string

The connection string value.

name str

The name which should be used for this Connection.

type str

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

value str

The connection string value.

name String

The name which should be used for this Connection.

type String

Type of database. Possible values include: APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

value String

The connection string value.

WindowsFunctionAppIdentity

Type string

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

IdentityIds List<string>

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

IdentityIds []string

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

type String

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

identityIds List<String>

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

type string

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

identityIds string[]

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type str

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

identity_ids Sequence[str]

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The Tenant ID associated with this Managed Service Identity.

type String

Specifies the type of Managed Service Identity that should be configured on this Windows Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).

identityIds List<String>

A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

WindowsFunctionAppSiteConfig

AlwaysOn bool

If this Windows Function App is Always On enabled. Defaults to false.

ApiDefinitionUrl string

The URL of the API definition that describes this Windows Function App.

ApiManagementApiId string

The ID of the API Management API for this Windows Function App.

AppCommandLine string

The App command line to launch.

AppScaleLimit int

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

AppServiceLogs WindowsFunctionAppSiteConfigAppServiceLogs

An app_service_logs block as defined above.

ApplicationInsightsConnectionString string

The Connection String for linking the Windows Function App to Application Insights.

ApplicationInsightsKey string

The Instrumentation Key for connecting the Windows Function App to Application Insights.

ApplicationStack WindowsFunctionAppSiteConfigApplicationStack

An application_stack block as defined above.

Cors WindowsFunctionAppSiteConfigCors

A cors block as defined above.

DefaultDocuments List<string>

Specifies a list of Default Documents for the Windows Function App.

DetailedErrorLoggingEnabled bool
ElasticInstanceMinimum int

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

FtpsState string

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

HealthCheckEvictionTimeInMin int

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

HealthCheckPath string

The path to be checked for this Windows Function App health.

Http2Enabled bool

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

IpRestrictions List<WindowsFunctionAppSiteConfigIpRestriction>

One or more ip_restriction blocks as defined above.

LoadBalancingMode string

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

ManagedPipelineMode string

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

MinimumTlsVersion string

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

PreWarmedInstanceCount int

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

RemoteDebuggingEnabled bool

Should Remote Debugging be enabled. Defaults to false.

RemoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

RuntimeScaleMonitoringEnabled bool

Should Scale Monitoring of the Functions Runtime be enabled?

ScmIpRestrictions List<WindowsFunctionAppSiteConfigScmIpRestriction>

One or more scm_ip_restriction blocks as defined above.

ScmMinimumTlsVersion string

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

ScmType string
ScmUseMainIpRestriction bool

Should the Windows Function App ip_restriction configuration be used for the SCM also.

Use32BitWorker bool

Should the Windows Function App use a 32-bit worker process. Defaults to true.

VnetRouteAllEnabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

WebsocketsEnabled bool

Should Web Sockets be enabled. Defaults to false.

WindowsFxVersion string
WorkerCount int

The number of Workers for this Windows Function App.

AlwaysOn bool

If this Windows Function App is Always On enabled. Defaults to false.

ApiDefinitionUrl string

The URL of the API definition that describes this Windows Function App.

ApiManagementApiId string

The ID of the API Management API for this Windows Function App.

AppCommandLine string

The App command line to launch.

AppScaleLimit int

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

AppServiceLogs WindowsFunctionAppSiteConfigAppServiceLogs

An app_service_logs block as defined above.

ApplicationInsightsConnectionString string

The Connection String for linking the Windows Function App to Application Insights.

ApplicationInsightsKey string

The Instrumentation Key for connecting the Windows Function App to Application Insights.

ApplicationStack WindowsFunctionAppSiteConfigApplicationStack

An application_stack block as defined above.

Cors WindowsFunctionAppSiteConfigCors

A cors block as defined above.

DefaultDocuments []string

Specifies a list of Default Documents for the Windows Function App.

DetailedErrorLoggingEnabled bool
ElasticInstanceMinimum int

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

FtpsState string

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

HealthCheckEvictionTimeInMin int

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

HealthCheckPath string

The path to be checked for this Windows Function App health.

Http2Enabled bool

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

IpRestrictions []WindowsFunctionAppSiteConfigIpRestriction

One or more ip_restriction blocks as defined above.

LoadBalancingMode string

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

ManagedPipelineMode string

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

MinimumTlsVersion string

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

PreWarmedInstanceCount int

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

RemoteDebuggingEnabled bool

Should Remote Debugging be enabled. Defaults to false.

RemoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

RuntimeScaleMonitoringEnabled bool

Should Scale Monitoring of the Functions Runtime be enabled?

ScmIpRestrictions []WindowsFunctionAppSiteConfigScmIpRestriction

One or more scm_ip_restriction blocks as defined above.

ScmMinimumTlsVersion string

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

ScmType string
ScmUseMainIpRestriction bool

Should the Windows Function App ip_restriction configuration be used for the SCM also.

Use32BitWorker bool

Should the Windows Function App use a 32-bit worker process. Defaults to true.

VnetRouteAllEnabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

WebsocketsEnabled bool

Should Web Sockets be enabled. Defaults to false.

WindowsFxVersion string
WorkerCount int

The number of Workers for this Windows Function App.

alwaysOn Boolean

If this Windows Function App is Always On enabled. Defaults to false.

apiDefinitionUrl String

The URL of the API definition that describes this Windows Function App.

apiManagementApiId String

The ID of the API Management API for this Windows Function App.

appCommandLine String

The App command line to launch.

appScaleLimit Integer

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

appServiceLogs WindowsFunctionAppSiteConfigAppServiceLogs

An app_service_logs block as defined above.

applicationInsightsConnectionString String

The Connection String for linking the Windows Function App to Application Insights.

applicationInsightsKey String

The Instrumentation Key for connecting the Windows Function App to Application Insights.

applicationStack WindowsFunctionAppSiteConfigApplicationStack

An application_stack block as defined above.

cors WindowsFunctionAppSiteConfigCors

A cors block as defined above.

defaultDocuments List<String>

Specifies a list of Default Documents for the Windows Function App.

detailedErrorLoggingEnabled Boolean
elasticInstanceMinimum Integer

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

ftpsState String

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

healthCheckEvictionTimeInMin Integer

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

healthCheckPath String

The path to be checked for this Windows Function App health.

http2Enabled Boolean

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

ipRestrictions List<WindowsFunctionAppSiteConfigIpRestriction>

One or more ip_restriction blocks as defined above.

loadBalancingMode String

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

managedPipelineMode String

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

minimumTlsVersion String

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

preWarmedInstanceCount Integer

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

remoteDebuggingEnabled Boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion String

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

runtimeScaleMonitoringEnabled Boolean

Should Scale Monitoring of the Functions Runtime be enabled?

scmIpRestrictions List<WindowsFunctionAppSiteConfigScmIpRestriction>

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion String

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

scmType String
scmUseMainIpRestriction Boolean

Should the Windows Function App ip_restriction configuration be used for the SCM also.

use32BitWorker Boolean

Should the Windows Function App use a 32-bit worker process. Defaults to true.

vnetRouteAllEnabled Boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled Boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion String
workerCount Integer

The number of Workers for this Windows Function App.

alwaysOn boolean

If this Windows Function App is Always On enabled. Defaults to false.

apiDefinitionUrl string

The URL of the API definition that describes this Windows Function App.

apiManagementApiId string

The ID of the API Management API for this Windows Function App.

appCommandLine string

The App command line to launch.

appScaleLimit number

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

appServiceLogs WindowsFunctionAppSiteConfigAppServiceLogs

An app_service_logs block as defined above.

applicationInsightsConnectionString string

The Connection String for linking the Windows Function App to Application Insights.

applicationInsightsKey string

The Instrumentation Key for connecting the Windows Function App to Application Insights.

applicationStack WindowsFunctionAppSiteConfigApplicationStack

An application_stack block as defined above.

cors WindowsFunctionAppSiteConfigCors

A cors block as defined above.

defaultDocuments string[]

Specifies a list of Default Documents for the Windows Function App.

detailedErrorLoggingEnabled boolean
elasticInstanceMinimum number

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

ftpsState string

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

healthCheckEvictionTimeInMin number

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

healthCheckPath string

The path to be checked for this Windows Function App health.

http2Enabled boolean

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

ipRestrictions WindowsFunctionAppSiteConfigIpRestriction[]

One or more ip_restriction blocks as defined above.

loadBalancingMode string

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

managedPipelineMode string

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

minimumTlsVersion string

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

preWarmedInstanceCount number

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

remoteDebuggingEnabled boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

runtimeScaleMonitoringEnabled boolean

Should Scale Monitoring of the Functions Runtime be enabled?

scmIpRestrictions WindowsFunctionAppSiteConfigScmIpRestriction[]

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion string

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

scmType string
scmUseMainIpRestriction boolean

Should the Windows Function App ip_restriction configuration be used for the SCM also.

use32BitWorker boolean

Should the Windows Function App use a 32-bit worker process. Defaults to true.

vnetRouteAllEnabled boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion string
workerCount number

The number of Workers for this Windows Function App.

always_on bool

If this Windows Function App is Always On enabled. Defaults to false.

api_definition_url str

The URL of the API definition that describes this Windows Function App.

api_management_api_id str

The ID of the API Management API for this Windows Function App.

app_command_line str

The App command line to launch.

app_scale_limit int

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

app_service_logs WindowsFunctionAppSiteConfigAppServiceLogs

An app_service_logs block as defined above.

application_insights_connection_string str

The Connection String for linking the Windows Function App to Application Insights.

application_insights_key str

The Instrumentation Key for connecting the Windows Function App to Application Insights.

application_stack WindowsFunctionAppSiteConfigApplicationStack

An application_stack block as defined above.

cors WindowsFunctionAppSiteConfigCors

A cors block as defined above.

default_documents Sequence[str]

Specifies a list of Default Documents for the Windows Function App.

detailed_error_logging_enabled bool
elastic_instance_minimum int

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

ftps_state str

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

health_check_eviction_time_in_min int

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

health_check_path str

The path to be checked for this Windows Function App health.

http2_enabled bool

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

ip_restrictions Sequence[WindowsFunctionAppSiteConfigIpRestriction]

One or more ip_restriction blocks as defined above.

load_balancing_mode str

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

managed_pipeline_mode str

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

minimum_tls_version str

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

pre_warmed_instance_count int

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

remote_debugging_enabled bool

Should Remote Debugging be enabled. Defaults to false.

remote_debugging_version str

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

runtime_scale_monitoring_enabled bool

Should Scale Monitoring of the Functions Runtime be enabled?

scm_ip_restrictions Sequence[WindowsFunctionAppSiteConfigScmIpRestriction]

One or more scm_ip_restriction blocks as defined above.

scm_minimum_tls_version str

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

scm_type str
scm_use_main_ip_restriction bool

Should the Windows Function App ip_restriction configuration be used for the SCM also.

use32_bit_worker bool

Should the Windows Function App use a 32-bit worker process. Defaults to true.

vnet_route_all_enabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websockets_enabled bool

Should Web Sockets be enabled. Defaults to false.

windows_fx_version str
worker_count int

The number of Workers for this Windows Function App.

alwaysOn Boolean

If this Windows Function App is Always On enabled. Defaults to false.

apiDefinitionUrl String

The URL of the API definition that describes this Windows Function App.

apiManagementApiId String

The ID of the API Management API for this Windows Function App.

appCommandLine String

The App command line to launch.

appScaleLimit Number

The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.

appServiceLogs Property Map

An app_service_logs block as defined above.

applicationInsightsConnectionString String

The Connection String for linking the Windows Function App to Application Insights.

applicationInsightsKey String

The Instrumentation Key for connecting the Windows Function App to Application Insights.

applicationStack Property Map

An application_stack block as defined above.

cors Property Map

A cors block as defined above.

defaultDocuments List<String>

Specifies a list of Default Documents for the Windows Function App.

detailedErrorLoggingEnabled Boolean
elasticInstanceMinimum Number

The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.

ftpsState String

State of FTP / FTPS service for this Windows Function App. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled.

healthCheckEvictionTimeInMin Number

The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path.

healthCheckPath String

The path to be checked for this Windows Function App health.

http2Enabled Boolean

Specifies if the HTTP2 protocol should be enabled. Defaults to false.

ipRestrictions List<Property Map>

One or more ip_restriction blocks as defined above.

loadBalancingMode String

The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted.

managedPipelineMode String

Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated.

minimumTlsVersion String

Configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

preWarmedInstanceCount Number

The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.

remoteDebuggingEnabled Boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion String

The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022.

runtimeScaleMonitoringEnabled Boolean

Should Scale Monitoring of the Functions Runtime be enabled?

scmIpRestrictions List<Property Map>

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion String

Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2.

scmType String
scmUseMainIpRestriction Boolean

Should the Windows Function App ip_restriction configuration be used for the SCM also.

use32BitWorker Boolean

Should the Windows Function App use a 32-bit worker process. Defaults to true.

vnetRouteAllEnabled Boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled Boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion String
workerCount Number

The number of Workers for this Windows Function App.

WindowsFunctionAppSiteConfigAppServiceLogs

DiskQuotaMb int

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

RetentionPeriodDays int

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

DiskQuotaMb int

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

RetentionPeriodDays int

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

diskQuotaMb Integer

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

retentionPeriodDays Integer

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

diskQuotaMb number

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

retentionPeriodDays number

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

disk_quota_mb int

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

retention_period_days int

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

diskQuotaMb Number

The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35.

retentionPeriodDays Number

The retention period for logs in days. Valid values are between 0 and 99999.(never delete).

WindowsFunctionAppSiteConfigApplicationStack

DotnetVersion string

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

JavaVersion string

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

NodeVersion string

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

PowershellCoreVersion string

The version of PowerShell Core to run. Possible values are 7, and 7.2.

UseCustomRuntime bool

Should the Windows Function App use a custom runtime?

UseDotnetIsolatedRuntime bool

Should the DotNet process use an isolated runtime. Defaults to false.

DotnetVersion string

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

JavaVersion string

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

NodeVersion string

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

PowershellCoreVersion string

The version of PowerShell Core to run. Possible values are 7, and 7.2.

UseCustomRuntime bool

Should the Windows Function App use a custom runtime?

UseDotnetIsolatedRuntime bool

Should the DotNet process use an isolated runtime. Defaults to false.

dotnetVersion String

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

javaVersion String

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

nodeVersion String

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

powershellCoreVersion String

The version of PowerShell Core to run. Possible values are 7, and 7.2.

useCustomRuntime Boolean

Should the Windows Function App use a custom runtime?

useDotnetIsolatedRuntime Boolean

Should the DotNet process use an isolated runtime. Defaults to false.

dotnetVersion string

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

javaVersion string

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

nodeVersion string

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

powershellCoreVersion string

The version of PowerShell Core to run. Possible values are 7, and 7.2.

useCustomRuntime boolean

Should the Windows Function App use a custom runtime?

useDotnetIsolatedRuntime boolean

Should the DotNet process use an isolated runtime. Defaults to false.

dotnet_version str

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

java_version str

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

node_version str

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

powershell_core_version str

The version of PowerShell Core to run. Possible values are 7, and 7.2.

use_custom_runtime bool

Should the Windows Function App use a custom runtime?

use_dotnet_isolated_runtime bool

Should the DotNet process use an isolated runtime. Defaults to false.

dotnetVersion String

The version of .NET to use. Possible values include v3.0, v4.0 v6.0 and v7.0.

javaVersion String

The Version of Java to use. Supported versions include 1.8, 11 & 17 (In-Preview).

nodeVersion String

The version of Node to run. Possible values include ~12, ~14, ~16 and ~18.

powershellCoreVersion String

The version of PowerShell Core to run. Possible values are 7, and 7.2.

useCustomRuntime Boolean

Should the Windows Function App use a custom runtime?

useDotnetIsolatedRuntime Boolean

Should the DotNet process use an isolated runtime. Defaults to false.

WindowsFunctionAppSiteConfigCors

AllowedOrigins List<string>

Specifies a list of origins that should be allowed to make cross-origin calls.

SupportCredentials bool

Are credentials allowed in CORS requests? Defaults to false.

AllowedOrigins []string

Specifies a list of origins that should be allowed to make cross-origin calls.

SupportCredentials bool

Are credentials allowed in CORS requests? Defaults to false.

allowedOrigins List<String>

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials Boolean

Are credentials allowed in CORS requests? Defaults to false.

allowedOrigins string[]

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials boolean

Are credentials allowed in CORS requests? Defaults to false.

allowed_origins Sequence[str]

Specifies a list of origins that should be allowed to make cross-origin calls.

support_credentials bool

Are credentials allowed in CORS requests? Defaults to false.

allowedOrigins List<String>

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials Boolean

Are credentials allowed in CORS requests? Defaults to false.

WindowsFunctionAppSiteConfigIpRestriction

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsFunctionAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsFunctionAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Integer

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ipAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name string

The name which should be used for this ip_restriction.

priority number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ip_address str

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name str

The name which should be used for this ip_restriction.

priority int

The priority value of this ip_restriction. Defaults to 65000.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers Property Map

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

WindowsFunctionAppSiteConfigIpRestrictionHeaders

XAzureFdids List<string>

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors List<string>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts List<string>

Specifies a list of Hosts for which matching should be applied.

XAzureFdids []string

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors []string

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts []string

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

xAzureFdids string[]

Specifies a list of Azure Front Door IDs.

xFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors string[]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts string[]

Specifies a list of Hosts for which matching should be applied.

x_azure_fdids Sequence[str]

Specifies a list of Azure Front Door IDs.

x_fd_health_probe str

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

x_forwarded_fors Sequence[str]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

x_forwarded_hosts Sequence[str]

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

WindowsFunctionAppSiteConfigScmIpRestriction

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Integer

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ipAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name string

The name which should be used for this ip_restriction.

priority number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

The action to take. Possible values are Allow or Deny.

headers WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ip_address str

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name str

The name which should be used for this ip_restriction.

priority int

The priority value of this ip_restriction. Defaults to 65000.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers Property Map

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

WindowsFunctionAppSiteConfigScmIpRestrictionHeaders

XAzureFdids List<string>

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors List<string>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts List<string>

Specifies a list of Hosts for which matching should be applied.

XAzureFdids []string

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors []string

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts []string

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

xAzureFdids string[]

Specifies a list of Azure Front Door IDs.

xFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors string[]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts string[]

Specifies a list of Hosts for which matching should be applied.

x_azure_fdids Sequence[str]

Specifies a list of Azure Front Door IDs.

x_fd_health_probe str

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

x_forwarded_fors Sequence[str]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

x_forwarded_hosts Sequence[str]

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

WindowsFunctionAppSiteCredential

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

Password string

The Site Credentials Password used for publishing.

Name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

Password string

The Site Credentials Password used for publishing.

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

password String

The Site Credentials Password used for publishing.

name string

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

password string

The Site Credentials Password used for publishing.

name str

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

password str

The Site Credentials Password used for publishing.

name String

The name which should be used for this Windows Function App. Changing this forces a new Windows Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions

password String

The Site Credentials Password used for publishing.

WindowsFunctionAppStickySettings

AppSettingNames List<string>

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

ConnectionStringNames List<string>

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

AppSettingNames []string

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

ConnectionStringNames []string

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

appSettingNames List<String>

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

connectionStringNames List<String>

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

appSettingNames string[]

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

connectionStringNames string[]

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

app_setting_names Sequence[str]

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

connection_string_names Sequence[str]

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

appSettingNames List<String>

A list of app_setting names that the Windows Function App will not swap between Slots when a swap operation is triggered.

connectionStringNames List<String>

A list of connection_string names that the Windows Function App will not swap between Slots when a swap operation is triggered.

WindowsFunctionAppStorageAccount

AccessKey string

The Access key for the storage account.

AccountName string

The Name of the Storage Account.

Name string

The name which should be used for this Storage Account.

ShareName string

The Name of the File Share or Container Name for Blob storage.

Type string

The Azure Storage Type. Possible values include AzureFiles.

MountPath string

The path at which to mount the storage share.

AccessKey string

The Access key for the storage account.

AccountName string

The Name of the Storage Account.

Name string

The name which should be used for this Storage Account.

ShareName string

The Name of the File Share or Container Name for Blob storage.

Type string

The Azure Storage Type. Possible values include AzureFiles.

MountPath string

The path at which to mount the storage share.

accessKey String

The Access key for the storage account.

accountName String

The Name of the Storage Account.

name String

The name which should be used for this Storage Account.

shareName String

The Name of the File Share or Container Name for Blob storage.

type String

The Azure Storage Type. Possible values include AzureFiles.

mountPath String

The path at which to mount the storage share.

accessKey string

The Access key for the storage account.

accountName string

The Name of the Storage Account.

name string

The name which should be used for this Storage Account.

shareName string

The Name of the File Share or Container Name for Blob storage.

type string

The Azure Storage Type. Possible values include AzureFiles.

mountPath string

The path at which to mount the storage share.

access_key str

The Access key for the storage account.

account_name str

The Name of the Storage Account.

name str

The name which should be used for this Storage Account.

share_name str

The Name of the File Share or Container Name for Blob storage.

type str

The Azure Storage Type. Possible values include AzureFiles.

mount_path str

The path at which to mount the storage share.

accessKey String

The Access key for the storage account.

accountName String

The Name of the Storage Account.

name String

The name which should be used for this Storage Account.

shareName String

The Name of the File Share or Container Name for Blob storage.

type String

The Azure Storage Type. Possible values include AzureFiles.

mountPath String

The path at which to mount the storage share.

Import

Windows Function Apps can be imported using the resource id, e.g.

 $ pulumi import azure:appservice/windowsFunctionApp:WindowsFunctionApp example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Web/sites/site1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.