Docs Home
We recommend using Azure Native.
Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
azure.appservice.WindowsFunctionApp
Explore with Pulumi AI
Manages a Windows Function App.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "windowsfunctionappsa",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleServicePlan = new azure.appservice.ServicePlan("example", {
name: "example-app-service-plan",
resourceGroupName: example.name,
location: example.location,
osType: "Windows",
skuName: "Y1",
});
const exampleWindowsFunctionApp = new azure.appservice.WindowsFunctionApp("example", {
name: "example-windows-function-app",
resourceGroupName: example.name,
location: example.location,
storageAccountName: exampleAccount.name,
storageAccountAccessKey: exampleAccount.primaryAccessKey,
servicePlanId: exampleServicePlan.id,
siteConfig: {},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_account = azure.storage.Account("example",
name="windowsfunctionappsa",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_service_plan = azure.appservice.ServicePlan("example",
name="example-app-service-plan",
resource_group_name=example.name,
location=example.location,
os_type="Windows",
sku_name="Y1")
example_windows_function_app = azure.appservice.WindowsFunctionApp("example",
name="example-windows-function-app",
resource_group_name=example.name,
location=example.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={})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("windowsfunctionappsa"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
exampleServicePlan, err := appservice.NewServicePlan(ctx, "example", &appservice.ServicePlanArgs{
Name: pulumi.String("example-app-service-plan"),
ResourceGroupName: example.Name,
Location: example.Location,
OsType: pulumi.String("Windows"),
SkuName: pulumi.String("Y1"),
})
if err != nil {
return err
}
_, err = appservice.NewWindowsFunctionApp(ctx, "example", &appservice.WindowsFunctionAppArgs{
Name: pulumi.String("example-windows-function-app"),
ResourceGroupName: example.Name,
Location: example.Location,
StorageAccountName: exampleAccount.Name,
StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
ServicePlanId: exampleServicePlan.ID(),
SiteConfig: &appservice.WindowsFunctionAppSiteConfigArgs{},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "windowsfunctionappsa",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleServicePlan = new Azure.AppService.ServicePlan("example", new()
{
Name = "example-app-service-plan",
ResourceGroupName = example.Name,
Location = example.Location,
OsType = "Windows",
SkuName = "Y1",
});
var exampleWindowsFunctionApp = new Azure.AppService.WindowsFunctionApp("example", new()
{
Name = "example-windows-function-app",
ResourceGroupName = example.Name,
Location = example.Location,
StorageAccountName = exampleAccount.Name,
StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
ServicePlanId = exampleServicePlan.Id,
SiteConfig = null,
});
});
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("windowsfunctionappsa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()
.name("example-app-service-plan")
.resourceGroupName(example.name())
.location(example.location())
.osType("Windows")
.skuName("Y1")
.build());
var exampleWindowsFunctionApp = new WindowsFunctionApp("exampleWindowsFunctionApp", WindowsFunctionAppArgs.builder()
.name("example-windows-function-app")
.resourceGroupName(example.name())
.location(example.location())
.storageAccountName(exampleAccount.name())
.storageAccountAccessKey(exampleAccount.primaryAccessKey())
.servicePlanId(exampleServicePlan.id())
.siteConfig()
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: windowsfunctionappsa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
exampleServicePlan:
type: azure:appservice:ServicePlan
name: example
properties:
name: example-app-service-plan
resourceGroupName: ${example.name}
location: ${example.location}
osType: Windows
skuName: Y1
exampleWindowsFunctionApp:
type: azure:appservice:WindowsFunctionApp
name: example
properties:
name: example-windows-function-app
resourceGroupName: ${example.name}
location: ${example.location}
storageAccountName: ${exampleAccount.name}
storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
servicePlanId: ${exampleServicePlan.id}
siteConfig: {}
Create WindowsFunctionApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WindowsFunctionApp(name: string, args: WindowsFunctionAppArgs, opts?: CustomResourceOptions);@overload
def WindowsFunctionApp(resource_name: str,
args: WindowsFunctionAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WindowsFunctionApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
site_config: Optional[WindowsFunctionAppSiteConfigArgs] = None,
service_plan_id: Optional[str] = None,
key_vault_reference_identity_id: Optional[str] = None,
backup: Optional[WindowsFunctionAppBackupArgs] = 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,
public_network_access_enabled: Optional[bool] = None,
ftp_publish_basic_authentication_enabled: Optional[bool] = None,
functions_extension_version: Optional[str] = None,
https_only: Optional[bool] = None,
identity: Optional[WindowsFunctionAppIdentityArgs] = None,
app_settings: Optional[Mapping[str, str]] = None,
builtin_logging_enabled: Optional[bool] = None,
location: Optional[str] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
auth_settings_v2: Optional[WindowsFunctionAppAuthSettingsV2Args] = None,
auth_settings: Optional[WindowsFunctionAppAuthSettingsArgs] = 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_backup_restore_enabled: Optional[bool] = None,
virtual_network_subnet_id: Optional[str] = None,
vnet_image_pull_enabled: Optional[bool] = None,
webdeploy_publish_basic_authentication_enabled: Optional[bool] = None,
zip_deploy_file: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var windowsFunctionAppResource = new Azure.AppService.WindowsFunctionApp("windowsFunctionAppResource", new()
{
ResourceGroupName = "string",
SiteConfig = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigArgs
{
AlwaysOn = false,
ApiDefinitionUrl = "string",
ApiManagementApiId = "string",
AppCommandLine = "string",
AppScaleLimit = 0,
AppServiceLogs = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigAppServiceLogsArgs
{
DiskQuotaMb = 0,
RetentionPeriodDays = 0,
},
ApplicationInsightsConnectionString = "string",
ApplicationInsightsKey = "string",
ApplicationStack = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigApplicationStackArgs
{
DotnetVersion = "string",
JavaVersion = "string",
NodeVersion = "string",
PowershellCoreVersion = "string",
UseCustomRuntime = false,
UseDotnetIsolatedRuntime = false,
},
Cors = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigCorsArgs
{
AllowedOrigins = new[]
{
"string",
},
SupportCredentials = false,
},
DefaultDocuments = new[]
{
"string",
},
DetailedErrorLoggingEnabled = false,
ElasticInstanceMinimum = 0,
FtpsState = "string",
HealthCheckEvictionTimeInMin = 0,
HealthCheckPath = "string",
Http2Enabled = false,
IpRestrictionDefaultAction = "string",
IpRestrictions = new[]
{
new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigIpRestrictionArgs
{
Action = "string",
Description = "string",
Headers = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
LoadBalancingMode = "string",
ManagedPipelineMode = "string",
MinimumTlsVersion = "string",
PreWarmedInstanceCount = 0,
RemoteDebuggingEnabled = false,
RemoteDebuggingVersion = "string",
RuntimeScaleMonitoringEnabled = false,
ScmIpRestrictionDefaultAction = "string",
ScmIpRestrictions = new[]
{
new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigScmIpRestrictionArgs
{
Action = "string",
Description = "string",
Headers = new Azure.AppService.Inputs.WindowsFunctionAppSiteConfigScmIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
ScmMinimumTlsVersion = "string",
ScmType = "string",
ScmUseMainIpRestriction = false,
Use32BitWorker = false,
VnetRouteAllEnabled = false,
WebsocketsEnabled = false,
WindowsFxVersion = "string",
WorkerCount = 0,
},
ServicePlanId = "string",
KeyVaultReferenceIdentityId = "string",
Backup = new Azure.AppService.Inputs.WindowsFunctionAppBackupArgs
{
Name = "string",
Schedule = new Azure.AppService.Inputs.WindowsFunctionAppBackupScheduleArgs
{
FrequencyInterval = 0,
FrequencyUnit = "string",
KeepAtLeastOneBackup = false,
LastExecutionTime = "string",
RetentionPeriodDays = 0,
StartTime = "string",
},
StorageAccountUrl = "string",
Enabled = false,
},
ClientCertificateEnabled = false,
ClientCertificateExclusionPaths = "string",
ClientCertificateMode = "string",
ConnectionStrings = new[]
{
new Azure.AppService.Inputs.WindowsFunctionAppConnectionStringArgs
{
Name = "string",
Type = "string",
Value = "string",
},
},
ContentShareForceDisabled = false,
DailyMemoryTimeQuota = 0,
PublicNetworkAccessEnabled = false,
FtpPublishBasicAuthenticationEnabled = false,
FunctionsExtensionVersion = "string",
HttpsOnly = false,
Identity = new Azure.AppService.Inputs.WindowsFunctionAppIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
AppSettings =
{
{ "string", "string" },
},
BuiltinLoggingEnabled = false,
Location = "string",
Enabled = false,
Name = "string",
AuthSettingsV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2Args
{
Login = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2LoginArgs
{
AllowedExternalRedirectUrls = new[]
{
"string",
},
CookieExpirationConvention = "string",
CookieExpirationTime = "string",
LogoutEndpoint = "string",
NonceExpirationTime = "string",
PreserveUrlFragmentsForLogins = false,
TokenRefreshExtensionTime = 0,
TokenStoreEnabled = false,
TokenStorePath = "string",
TokenStoreSasSettingName = "string",
ValidateNonce = false,
},
CustomOidcV2s = new[]
{
new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2CustomOidcV2Args
{
ClientId = "string",
Name = "string",
OpenidConfigurationEndpoint = "string",
AuthorisationEndpoint = "string",
CertificationUri = "string",
ClientCredentialMethod = "string",
ClientSecretSettingName = "string",
IssuerEndpoint = "string",
NameClaimType = "string",
Scopes = new[]
{
"string",
},
TokenEndpoint = "string",
},
},
GithubV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2GithubV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
LoginScopes = new[]
{
"string",
},
},
AzureStaticWebAppV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2Args
{
ClientId = "string",
},
ConfigFilePath = "string",
ActiveDirectoryV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2Args
{
ClientId = "string",
TenantAuthEndpoint = "string",
AllowedApplications = new[]
{
"string",
},
AllowedAudiences = new[]
{
"string",
},
AllowedGroups = new[]
{
"string",
},
AllowedIdentities = new[]
{
"string",
},
ClientSecretCertificateThumbprint = "string",
ClientSecretSettingName = "string",
JwtAllowedClientApplications = new[]
{
"string",
},
JwtAllowedGroups = new[]
{
"string",
},
LoginParameters =
{
{ "string", "string" },
},
WwwAuthenticationDisabled = false,
},
DefaultProvider = "string",
ExcludedPaths = new[]
{
"string",
},
FacebookV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2FacebookV2Args
{
AppId = "string",
AppSecretSettingName = "string",
GraphApiVersion = "string",
LoginScopes = new[]
{
"string",
},
},
ForwardProxyConvention = "string",
ForwardProxyCustomHostHeaderName = "string",
AuthEnabled = false,
GoogleV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2GoogleV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
AllowedAudiences = new[]
{
"string",
},
LoginScopes = new[]
{
"string",
},
},
ForwardProxyCustomSchemeHeaderName = "string",
HttpRouteApiPrefix = "string",
AppleV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2AppleV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
LoginScopes = new[]
{
"string",
},
},
MicrosoftV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2MicrosoftV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
AllowedAudiences = new[]
{
"string",
},
LoginScopes = new[]
{
"string",
},
},
RequireAuthentication = false,
RequireHttps = false,
RuntimeVersion = "string",
TwitterV2 = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsV2TwitterV2Args
{
ConsumerKey = "string",
ConsumerSecretSettingName = "string",
},
UnauthenticatedAction = "string",
},
AuthSettings = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsArgs
{
Enabled = false,
Github = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsGithubArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
Issuer = "string",
DefaultProvider = "string",
AdditionalLoginParameters =
{
{ "string", "string" },
},
Facebook = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsFacebookArgs
{
AppId = "string",
AppSecret = "string",
AppSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
ActiveDirectory = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsActiveDirectoryArgs
{
ClientId = "string",
AllowedAudiences = new[]
{
"string",
},
ClientSecret = "string",
ClientSecretSettingName = "string",
},
Google = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsGoogleArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
AllowedExternalRedirectUrls = new[]
{
"string",
},
Microsoft = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsMicrosoftArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
RuntimeVersion = "string",
TokenRefreshExtensionHours = 0,
TokenStoreEnabled = false,
Twitter = new Azure.AppService.Inputs.WindowsFunctionAppAuthSettingsTwitterArgs
{
ConsumerKey = "string",
ConsumerSecret = "string",
ConsumerSecretSettingName = "string",
},
UnauthenticatedClientAction = "string",
},
StickySettings = new Azure.AppService.Inputs.WindowsFunctionAppStickySettingsArgs
{
AppSettingNames = new[]
{
"string",
},
ConnectionStringNames = new[]
{
"string",
},
},
StorageAccountAccessKey = "string",
StorageAccountName = "string",
StorageAccounts = new[]
{
new Azure.AppService.Inputs.WindowsFunctionAppStorageAccountArgs
{
AccessKey = "string",
AccountName = "string",
Name = "string",
ShareName = "string",
Type = "string",
MountPath = "string",
},
},
StorageKeyVaultSecretId = "string",
StorageUsesManagedIdentity = false,
Tags =
{
{ "string", "string" },
},
VirtualNetworkBackupRestoreEnabled = false,
VirtualNetworkSubnetId = "string",
VnetImagePullEnabled = false,
WebdeployPublishBasicAuthenticationEnabled = false,
ZipDeployFile = "string",
});
example, err := appservice.NewWindowsFunctionApp(ctx, "windowsFunctionAppResource", &appservice.WindowsFunctionAppArgs{
ResourceGroupName: pulumi.String("string"),
SiteConfig: &appservice.WindowsFunctionAppSiteConfigArgs{
AlwaysOn: pulumi.Bool(false),
ApiDefinitionUrl: pulumi.String("string"),
ApiManagementApiId: pulumi.String("string"),
AppCommandLine: pulumi.String("string"),
AppScaleLimit: pulumi.Int(0),
AppServiceLogs: &appservice.WindowsFunctionAppSiteConfigAppServiceLogsArgs{
DiskQuotaMb: pulumi.Int(0),
RetentionPeriodDays: pulumi.Int(0),
},
ApplicationInsightsConnectionString: pulumi.String("string"),
ApplicationInsightsKey: pulumi.String("string"),
ApplicationStack: &appservice.WindowsFunctionAppSiteConfigApplicationStackArgs{
DotnetVersion: pulumi.String("string"),
JavaVersion: pulumi.String("string"),
NodeVersion: pulumi.String("string"),
PowershellCoreVersion: pulumi.String("string"),
UseCustomRuntime: pulumi.Bool(false),
UseDotnetIsolatedRuntime: pulumi.Bool(false),
},
Cors: &appservice.WindowsFunctionAppSiteConfigCorsArgs{
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
SupportCredentials: pulumi.Bool(false),
},
DefaultDocuments: pulumi.StringArray{
pulumi.String("string"),
},
DetailedErrorLoggingEnabled: pulumi.Bool(false),
ElasticInstanceMinimum: pulumi.Int(0),
FtpsState: pulumi.String("string"),
HealthCheckEvictionTimeInMin: pulumi.Int(0),
HealthCheckPath: pulumi.String("string"),
Http2Enabled: pulumi.Bool(false),
IpRestrictionDefaultAction: pulumi.String("string"),
IpRestrictions: appservice.WindowsFunctionAppSiteConfigIpRestrictionArray{
&appservice.WindowsFunctionAppSiteConfigIpRestrictionArgs{
Action: pulumi.String("string"),
Description: pulumi.String("string"),
Headers: &appservice.WindowsFunctionAppSiteConfigIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
LoadBalancingMode: pulumi.String("string"),
ManagedPipelineMode: pulumi.String("string"),
MinimumTlsVersion: pulumi.String("string"),
PreWarmedInstanceCount: pulumi.Int(0),
RemoteDebuggingEnabled: pulumi.Bool(false),
RemoteDebuggingVersion: pulumi.String("string"),
RuntimeScaleMonitoringEnabled: pulumi.Bool(false),
ScmIpRestrictionDefaultAction: pulumi.String("string"),
ScmIpRestrictions: appservice.WindowsFunctionAppSiteConfigScmIpRestrictionArray{
&appservice.WindowsFunctionAppSiteConfigScmIpRestrictionArgs{
Action: pulumi.String("string"),
Description: pulumi.String("string"),
Headers: &appservice.WindowsFunctionAppSiteConfigScmIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
ScmMinimumTlsVersion: pulumi.String("string"),
ScmType: pulumi.String("string"),
ScmUseMainIpRestriction: pulumi.Bool(false),
Use32BitWorker: pulumi.Bool(false),
VnetRouteAllEnabled: pulumi.Bool(false),
WebsocketsEnabled: pulumi.Bool(false),
WindowsFxVersion: pulumi.String("string"),
WorkerCount: pulumi.Int(0),
},
ServicePlanId: pulumi.String("string"),
KeyVaultReferenceIdentityId: pulumi.String("string"),
Backup: &appservice.WindowsFunctionAppBackupArgs{
Name: pulumi.String("string"),
Schedule: &appservice.WindowsFunctionAppBackupScheduleArgs{
FrequencyInterval: pulumi.Int(0),
FrequencyUnit: pulumi.String("string"),
KeepAtLeastOneBackup: pulumi.Bool(false),
LastExecutionTime: pulumi.String("string"),
RetentionPeriodDays: pulumi.Int(0),
StartTime: pulumi.String("string"),
},
StorageAccountUrl: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
ClientCertificateEnabled: pulumi.Bool(false),
ClientCertificateExclusionPaths: pulumi.String("string"),
ClientCertificateMode: pulumi.String("string"),
ConnectionStrings: appservice.WindowsFunctionAppConnectionStringArray{
&appservice.WindowsFunctionAppConnectionStringArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ContentShareForceDisabled: pulumi.Bool(false),
DailyMemoryTimeQuota: pulumi.Int(0),
PublicNetworkAccessEnabled: pulumi.Bool(false),
FtpPublishBasicAuthenticationEnabled: pulumi.Bool(false),
FunctionsExtensionVersion: pulumi.String("string"),
HttpsOnly: pulumi.Bool(false),
Identity: &appservice.WindowsFunctionAppIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
AppSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
BuiltinLoggingEnabled: pulumi.Bool(false),
Location: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
AuthSettingsV2: &appservice.WindowsFunctionAppAuthSettingsV2Args{
Login: &appservice.WindowsFunctionAppAuthSettingsV2LoginArgs{
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
CookieExpirationConvention: pulumi.String("string"),
CookieExpirationTime: pulumi.String("string"),
LogoutEndpoint: pulumi.String("string"),
NonceExpirationTime: pulumi.String("string"),
PreserveUrlFragmentsForLogins: pulumi.Bool(false),
TokenRefreshExtensionTime: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
TokenStorePath: pulumi.String("string"),
TokenStoreSasSettingName: pulumi.String("string"),
ValidateNonce: pulumi.Bool(false),
},
CustomOidcV2s: appservice.WindowsFunctionAppAuthSettingsV2CustomOidcV2Array{
&appservice.WindowsFunctionAppAuthSettingsV2CustomOidcV2Args{
ClientId: pulumi.String("string"),
Name: pulumi.String("string"),
OpenidConfigurationEndpoint: pulumi.String("string"),
AuthorisationEndpoint: pulumi.String("string"),
CertificationUri: pulumi.String("string"),
ClientCredentialMethod: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
IssuerEndpoint: pulumi.String("string"),
NameClaimType: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
TokenEndpoint: pulumi.String("string"),
},
},
GithubV2: &appservice.WindowsFunctionAppAuthSettingsV2GithubV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AzureStaticWebAppV2: &appservice.WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2Args{
ClientId: pulumi.String("string"),
},
ConfigFilePath: pulumi.String("string"),
ActiveDirectoryV2: &appservice.WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2Args{
ClientId: pulumi.String("string"),
TenantAuthEndpoint: pulumi.String("string"),
AllowedApplications: pulumi.StringArray{
pulumi.String("string"),
},
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
AllowedGroups: pulumi.StringArray{
pulumi.String("string"),
},
AllowedIdentities: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecretCertificateThumbprint: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
JwtAllowedClientApplications: pulumi.StringArray{
pulumi.String("string"),
},
JwtAllowedGroups: pulumi.StringArray{
pulumi.String("string"),
},
LoginParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
WwwAuthenticationDisabled: pulumi.Bool(false),
},
DefaultProvider: pulumi.String("string"),
ExcludedPaths: pulumi.StringArray{
pulumi.String("string"),
},
FacebookV2: &appservice.WindowsFunctionAppAuthSettingsV2FacebookV2Args{
AppId: pulumi.String("string"),
AppSecretSettingName: pulumi.String("string"),
GraphApiVersion: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ForwardProxyConvention: pulumi.String("string"),
ForwardProxyCustomHostHeaderName: pulumi.String("string"),
AuthEnabled: pulumi.Bool(false),
GoogleV2: &appservice.WindowsFunctionAppAuthSettingsV2GoogleV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ForwardProxyCustomSchemeHeaderName: pulumi.String("string"),
HttpRouteApiPrefix: pulumi.String("string"),
AppleV2: &appservice.WindowsFunctionAppAuthSettingsV2AppleV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
MicrosoftV2: &appservice.WindowsFunctionAppAuthSettingsV2MicrosoftV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RequireAuthentication: pulumi.Bool(false),
RequireHttps: pulumi.Bool(false),
RuntimeVersion: pulumi.String("string"),
TwitterV2: &appservice.WindowsFunctionAppAuthSettingsV2TwitterV2Args{
ConsumerKey: pulumi.String("string"),
ConsumerSecretSettingName: pulumi.String("string"),
},
UnauthenticatedAction: pulumi.String("string"),
},
AuthSettings: &appservice.WindowsFunctionAppAuthSettingsArgs{
Enabled: pulumi.Bool(false),
Github: &appservice.WindowsFunctionAppAuthSettingsGithubArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
Issuer: pulumi.String("string"),
DefaultProvider: pulumi.String("string"),
AdditionalLoginParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Facebook: &appservice.WindowsFunctionAppAuthSettingsFacebookArgs{
AppId: pulumi.String("string"),
AppSecret: pulumi.String("string"),
AppSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ActiveDirectory: &appservice.WindowsFunctionAppAuthSettingsActiveDirectoryArgs{
ClientId: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
},
Google: &appservice.WindowsFunctionAppAuthSettingsGoogleArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
Microsoft: &appservice.WindowsFunctionAppAuthSettingsMicrosoftArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RuntimeVersion: pulumi.String("string"),
TokenRefreshExtensionHours: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
Twitter: &appservice.WindowsFunctionAppAuthSettingsTwitterArgs{
ConsumerKey: pulumi.String("string"),
ConsumerSecret: pulumi.String("string"),
ConsumerSecretSettingName: pulumi.String("string"),
},
UnauthenticatedClientAction: pulumi.String("string"),
},
StickySettings: &appservice.WindowsFunctionAppStickySettingsArgs{
AppSettingNames: pulumi.StringArray{
pulumi.String("string"),
},
ConnectionStringNames: pulumi.StringArray{
pulumi.String("string"),
},
},
StorageAccountAccessKey: pulumi.String("string"),
StorageAccountName: pulumi.String("string"),
StorageAccounts: appservice.WindowsFunctionAppStorageAccountArray{
&appservice.WindowsFunctionAppStorageAccountArgs{
AccessKey: pulumi.String("string"),
AccountName: pulumi.String("string"),
Name: pulumi.String("string"),
ShareName: pulumi.String("string"),
Type: pulumi.String("string"),
MountPath: pulumi.String("string"),
},
},
StorageKeyVaultSecretId: pulumi.String("string"),
StorageUsesManagedIdentity: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VirtualNetworkBackupRestoreEnabled: pulumi.Bool(false),
VirtualNetworkSubnetId: pulumi.String("string"),
VnetImagePullEnabled: pulumi.Bool(false),
WebdeployPublishBasicAuthenticationEnabled: pulumi.Bool(false),
ZipDeployFile: pulumi.String("string"),
})
var windowsFunctionAppResource = new WindowsFunctionApp("windowsFunctionAppResource", WindowsFunctionAppArgs.builder()
.resourceGroupName("string")
.siteConfig(WindowsFunctionAppSiteConfigArgs.builder()
.alwaysOn(false)
.apiDefinitionUrl("string")
.apiManagementApiId("string")
.appCommandLine("string")
.appScaleLimit(0)
.appServiceLogs(WindowsFunctionAppSiteConfigAppServiceLogsArgs.builder()
.diskQuotaMb(0)
.retentionPeriodDays(0)
.build())
.applicationInsightsConnectionString("string")
.applicationInsightsKey("string")
.applicationStack(WindowsFunctionAppSiteConfigApplicationStackArgs.builder()
.dotnetVersion("string")
.javaVersion("string")
.nodeVersion("string")
.powershellCoreVersion("string")
.useCustomRuntime(false)
.useDotnetIsolatedRuntime(false)
.build())
.cors(WindowsFunctionAppSiteConfigCorsArgs.builder()
.allowedOrigins("string")
.supportCredentials(false)
.build())
.defaultDocuments("string")
.detailedErrorLoggingEnabled(false)
.elasticInstanceMinimum(0)
.ftpsState("string")
.healthCheckEvictionTimeInMin(0)
.healthCheckPath("string")
.http2Enabled(false)
.ipRestrictionDefaultAction("string")
.ipRestrictions(WindowsFunctionAppSiteConfigIpRestrictionArgs.builder()
.action("string")
.description("string")
.headers(WindowsFunctionAppSiteConfigIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.loadBalancingMode("string")
.managedPipelineMode("string")
.minimumTlsVersion("string")
.preWarmedInstanceCount(0)
.remoteDebuggingEnabled(false)
.remoteDebuggingVersion("string")
.runtimeScaleMonitoringEnabled(false)
.scmIpRestrictionDefaultAction("string")
.scmIpRestrictions(WindowsFunctionAppSiteConfigScmIpRestrictionArgs.builder()
.action("string")
.description("string")
.headers(WindowsFunctionAppSiteConfigScmIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.scmMinimumTlsVersion("string")
.scmType("string")
.scmUseMainIpRestriction(false)
.use32BitWorker(false)
.vnetRouteAllEnabled(false)
.websocketsEnabled(false)
.windowsFxVersion("string")
.workerCount(0)
.build())
.servicePlanId("string")
.keyVaultReferenceIdentityId("string")
.backup(WindowsFunctionAppBackupArgs.builder()
.name("string")
.schedule(WindowsFunctionAppBackupScheduleArgs.builder()
.frequencyInterval(0)
.frequencyUnit("string")
.keepAtLeastOneBackup(false)
.lastExecutionTime("string")
.retentionPeriodDays(0)
.startTime("string")
.build())
.storageAccountUrl("string")
.enabled(false)
.build())
.clientCertificateEnabled(false)
.clientCertificateExclusionPaths("string")
.clientCertificateMode("string")
.connectionStrings(WindowsFunctionAppConnectionStringArgs.builder()
.name("string")
.type("string")
.value("string")
.build())
.contentShareForceDisabled(false)
.dailyMemoryTimeQuota(0)
.publicNetworkAccessEnabled(false)
.ftpPublishBasicAuthenticationEnabled(false)
.functionsExtensionVersion("string")
.httpsOnly(false)
.identity(WindowsFunctionAppIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.appSettings(Map.of("string", "string"))
.builtinLoggingEnabled(false)
.location("string")
.enabled(false)
.name("string")
.authSettingsV2(WindowsFunctionAppAuthSettingsV2Args.builder()
.login(WindowsFunctionAppAuthSettingsV2LoginArgs.builder()
.allowedExternalRedirectUrls("string")
.cookieExpirationConvention("string")
.cookieExpirationTime("string")
.logoutEndpoint("string")
.nonceExpirationTime("string")
.preserveUrlFragmentsForLogins(false)
.tokenRefreshExtensionTime(0)
.tokenStoreEnabled(false)
.tokenStorePath("string")
.tokenStoreSasSettingName("string")
.validateNonce(false)
.build())
.customOidcV2s(WindowsFunctionAppAuthSettingsV2CustomOidcV2Args.builder()
.clientId("string")
.name("string")
.openidConfigurationEndpoint("string")
.authorisationEndpoint("string")
.certificationUri("string")
.clientCredentialMethod("string")
.clientSecretSettingName("string")
.issuerEndpoint("string")
.nameClaimType("string")
.scopes("string")
.tokenEndpoint("string")
.build())
.githubV2(WindowsFunctionAppAuthSettingsV2GithubV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.loginScopes("string")
.build())
.azureStaticWebAppV2(WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2Args.builder()
.clientId("string")
.build())
.configFilePath("string")
.activeDirectoryV2(WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2Args.builder()
.clientId("string")
.tenantAuthEndpoint("string")
.allowedApplications("string")
.allowedAudiences("string")
.allowedGroups("string")
.allowedIdentities("string")
.clientSecretCertificateThumbprint("string")
.clientSecretSettingName("string")
.jwtAllowedClientApplications("string")
.jwtAllowedGroups("string")
.loginParameters(Map.of("string", "string"))
.wwwAuthenticationDisabled(false)
.build())
.defaultProvider("string")
.excludedPaths("string")
.facebookV2(WindowsFunctionAppAuthSettingsV2FacebookV2Args.builder()
.appId("string")
.appSecretSettingName("string")
.graphApiVersion("string")
.loginScopes("string")
.build())
.forwardProxyConvention("string")
.forwardProxyCustomHostHeaderName("string")
.authEnabled(false)
.googleV2(WindowsFunctionAppAuthSettingsV2GoogleV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.allowedAudiences("string")
.loginScopes("string")
.build())
.forwardProxyCustomSchemeHeaderName("string")
.httpRouteApiPrefix("string")
.appleV2(WindowsFunctionAppAuthSettingsV2AppleV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.loginScopes("string")
.build())
.microsoftV2(WindowsFunctionAppAuthSettingsV2MicrosoftV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.allowedAudiences("string")
.loginScopes("string")
.build())
.requireAuthentication(false)
.requireHttps(false)
.runtimeVersion("string")
.twitterV2(WindowsFunctionAppAuthSettingsV2TwitterV2Args.builder()
.consumerKey("string")
.consumerSecretSettingName("string")
.build())
.unauthenticatedAction("string")
.build())
.authSettings(WindowsFunctionAppAuthSettingsArgs.builder()
.enabled(false)
.github(WindowsFunctionAppAuthSettingsGithubArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.issuer("string")
.defaultProvider("string")
.additionalLoginParameters(Map.of("string", "string"))
.facebook(WindowsFunctionAppAuthSettingsFacebookArgs.builder()
.appId("string")
.appSecret("string")
.appSecretSettingName("string")
.oauthScopes("string")
.build())
.activeDirectory(WindowsFunctionAppAuthSettingsActiveDirectoryArgs.builder()
.clientId("string")
.allowedAudiences("string")
.clientSecret("string")
.clientSecretSettingName("string")
.build())
.google(WindowsFunctionAppAuthSettingsGoogleArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.allowedExternalRedirectUrls("string")
.microsoft(WindowsFunctionAppAuthSettingsMicrosoftArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.runtimeVersion("string")
.tokenRefreshExtensionHours(0)
.tokenStoreEnabled(false)
.twitter(WindowsFunctionAppAuthSettingsTwitterArgs.builder()
.consumerKey("string")
.consumerSecret("string")
.consumerSecretSettingName("string")
.build())
.unauthenticatedClientAction("string")
.build())
.stickySettings(WindowsFunctionAppStickySettingsArgs.builder()
.appSettingNames("string")
.connectionStringNames("string")
.build())
.storageAccountAccessKey("string")
.storageAccountName("string")
.storageAccounts(WindowsFunctionAppStorageAccountArgs.builder()
.accessKey("string")
.accountName("string")
.name("string")
.shareName("string")
.type("string")
.mountPath("string")
.build())
.storageKeyVaultSecretId("string")
.storageUsesManagedIdentity(false)
.tags(Map.of("string", "string"))
.virtualNetworkBackupRestoreEnabled(false)
.virtualNetworkSubnetId("string")
.vnetImagePullEnabled(false)
.webdeployPublishBasicAuthenticationEnabled(false)
.zipDeployFile("string")
.build());
windows_function_app_resource = azure.appservice.WindowsFunctionApp("windowsFunctionAppResource",
resource_group_name="string",
site_config={
"always_on": False,
"api_definition_url": "string",
"api_management_api_id": "string",
"app_command_line": "string",
"app_scale_limit": 0,
"app_service_logs": {
"disk_quota_mb": 0,
"retention_period_days": 0,
},
"application_insights_connection_string": "string",
"application_insights_key": "string",
"application_stack": {
"dotnet_version": "string",
"java_version": "string",
"node_version": "string",
"powershell_core_version": "string",
"use_custom_runtime": False,
"use_dotnet_isolated_runtime": False,
},
"cors": {
"allowed_origins": ["string"],
"support_credentials": False,
},
"default_documents": ["string"],
"detailed_error_logging_enabled": False,
"elastic_instance_minimum": 0,
"ftps_state": "string",
"health_check_eviction_time_in_min": 0,
"health_check_path": "string",
"http2_enabled": False,
"ip_restriction_default_action": "string",
"ip_restrictions": [{
"action": "string",
"description": "string",
"headers": {
"x_azure_fdids": ["string"],
"x_fd_health_probe": "string",
"x_forwarded_fors": ["string"],
"x_forwarded_hosts": ["string"],
},
"ip_address": "string",
"name": "string",
"priority": 0,
"service_tag": "string",
"virtual_network_subnet_id": "string",
}],
"load_balancing_mode": "string",
"managed_pipeline_mode": "string",
"minimum_tls_version": "string",
"pre_warmed_instance_count": 0,
"remote_debugging_enabled": False,
"remote_debugging_version": "string",
"runtime_scale_monitoring_enabled": False,
"scm_ip_restriction_default_action": "string",
"scm_ip_restrictions": [{
"action": "string",
"description": "string",
"headers": {
"x_azure_fdids": ["string"],
"x_fd_health_probe": "string",
"x_forwarded_fors": ["string"],
"x_forwarded_hosts": ["string"],
},
"ip_address": "string",
"name": "string",
"priority": 0,
"service_tag": "string",
"virtual_network_subnet_id": "string",
}],
"scm_minimum_tls_version": "string",
"scm_type": "string",
"scm_use_main_ip_restriction": False,
"use32_bit_worker": False,
"vnet_route_all_enabled": False,
"websockets_enabled": False,
"windows_fx_version": "string",
"worker_count": 0,
},
service_plan_id="string",
key_vault_reference_identity_id="string",
backup={
"name": "string",
"schedule": {
"frequency_interval": 0,
"frequency_unit": "string",
"keep_at_least_one_backup": False,
"last_execution_time": "string",
"retention_period_days": 0,
"start_time": "string",
},
"storage_account_url": "string",
"enabled": False,
},
client_certificate_enabled=False,
client_certificate_exclusion_paths="string",
client_certificate_mode="string",
connection_strings=[{
"name": "string",
"type": "string",
"value": "string",
}],
content_share_force_disabled=False,
daily_memory_time_quota=0,
public_network_access_enabled=False,
ftp_publish_basic_authentication_enabled=False,
functions_extension_version="string",
https_only=False,
identity={
"type": "string",
"identity_ids": ["string"],
"principal_id": "string",
"tenant_id": "string",
},
app_settings={
"string": "string",
},
builtin_logging_enabled=False,
location="string",
enabled=False,
name="string",
auth_settings_v2={
"login": {
"allowed_external_redirect_urls": ["string"],
"cookie_expiration_convention": "string",
"cookie_expiration_time": "string",
"logout_endpoint": "string",
"nonce_expiration_time": "string",
"preserve_url_fragments_for_logins": False,
"token_refresh_extension_time": 0,
"token_store_enabled": False,
"token_store_path": "string",
"token_store_sas_setting_name": "string",
"validate_nonce": False,
},
"custom_oidc_v2s": [{
"client_id": "string",
"name": "string",
"openid_configuration_endpoint": "string",
"authorisation_endpoint": "string",
"certification_uri": "string",
"client_credential_method": "string",
"client_secret_setting_name": "string",
"issuer_endpoint": "string",
"name_claim_type": "string",
"scopes": ["string"],
"token_endpoint": "string",
}],
"github_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"login_scopes": ["string"],
},
"azure_static_web_app_v2": {
"client_id": "string",
},
"config_file_path": "string",
"active_directory_v2": {
"client_id": "string",
"tenant_auth_endpoint": "string",
"allowed_applications": ["string"],
"allowed_audiences": ["string"],
"allowed_groups": ["string"],
"allowed_identities": ["string"],
"client_secret_certificate_thumbprint": "string",
"client_secret_setting_name": "string",
"jwt_allowed_client_applications": ["string"],
"jwt_allowed_groups": ["string"],
"login_parameters": {
"string": "string",
},
"www_authentication_disabled": False,
},
"default_provider": "string",
"excluded_paths": ["string"],
"facebook_v2": {
"app_id": "string",
"app_secret_setting_name": "string",
"graph_api_version": "string",
"login_scopes": ["string"],
},
"forward_proxy_convention": "string",
"forward_proxy_custom_host_header_name": "string",
"auth_enabled": False,
"google_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"allowed_audiences": ["string"],
"login_scopes": ["string"],
},
"forward_proxy_custom_scheme_header_name": "string",
"http_route_api_prefix": "string",
"apple_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"login_scopes": ["string"],
},
"microsoft_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"allowed_audiences": ["string"],
"login_scopes": ["string"],
},
"require_authentication": False,
"require_https": False,
"runtime_version": "string",
"twitter_v2": {
"consumer_key": "string",
"consumer_secret_setting_name": "string",
},
"unauthenticated_action": "string",
},
auth_settings={
"enabled": False,
"github": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"issuer": "string",
"default_provider": "string",
"additional_login_parameters": {
"string": "string",
},
"facebook": {
"app_id": "string",
"app_secret": "string",
"app_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"active_directory": {
"client_id": "string",
"allowed_audiences": ["string"],
"client_secret": "string",
"client_secret_setting_name": "string",
},
"google": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"allowed_external_redirect_urls": ["string"],
"microsoft": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"runtime_version": "string",
"token_refresh_extension_hours": 0,
"token_store_enabled": False,
"twitter": {
"consumer_key": "string",
"consumer_secret": "string",
"consumer_secret_setting_name": "string",
},
"unauthenticated_client_action": "string",
},
sticky_settings={
"app_setting_names": ["string"],
"connection_string_names": ["string"],
},
storage_account_access_key="string",
storage_account_name="string",
storage_accounts=[{
"access_key": "string",
"account_name": "string",
"name": "string",
"share_name": "string",
"type": "string",
"mount_path": "string",
}],
storage_key_vault_secret_id="string",
storage_uses_managed_identity=False,
tags={
"string": "string",
},
virtual_network_backup_restore_enabled=False,
virtual_network_subnet_id="string",
vnet_image_pull_enabled=False,
webdeploy_publish_basic_authentication_enabled=False,
zip_deploy_file="string")
const windowsFunctionAppResource = new azure.appservice.WindowsFunctionApp("windowsFunctionAppResource", {
resourceGroupName: "string",
siteConfig: {
alwaysOn: false,
apiDefinitionUrl: "string",
apiManagementApiId: "string",
appCommandLine: "string",
appScaleLimit: 0,
appServiceLogs: {
diskQuotaMb: 0,
retentionPeriodDays: 0,
},
applicationInsightsConnectionString: "string",
applicationInsightsKey: "string",
applicationStack: {
dotnetVersion: "string",
javaVersion: "string",
nodeVersion: "string",
powershellCoreVersion: "string",
useCustomRuntime: false,
useDotnetIsolatedRuntime: false,
},
cors: {
allowedOrigins: ["string"],
supportCredentials: false,
},
defaultDocuments: ["string"],
detailedErrorLoggingEnabled: false,
elasticInstanceMinimum: 0,
ftpsState: "string",
healthCheckEvictionTimeInMin: 0,
healthCheckPath: "string",
http2Enabled: false,
ipRestrictionDefaultAction: "string",
ipRestrictions: [{
action: "string",
description: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
loadBalancingMode: "string",
managedPipelineMode: "string",
minimumTlsVersion: "string",
preWarmedInstanceCount: 0,
remoteDebuggingEnabled: false,
remoteDebuggingVersion: "string",
runtimeScaleMonitoringEnabled: false,
scmIpRestrictionDefaultAction: "string",
scmIpRestrictions: [{
action: "string",
description: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
scmMinimumTlsVersion: "string",
scmType: "string",
scmUseMainIpRestriction: false,
use32BitWorker: false,
vnetRouteAllEnabled: false,
websocketsEnabled: false,
windowsFxVersion: "string",
workerCount: 0,
},
servicePlanId: "string",
keyVaultReferenceIdentityId: "string",
backup: {
name: "string",
schedule: {
frequencyInterval: 0,
frequencyUnit: "string",
keepAtLeastOneBackup: false,
lastExecutionTime: "string",
retentionPeriodDays: 0,
startTime: "string",
},
storageAccountUrl: "string",
enabled: false,
},
clientCertificateEnabled: false,
clientCertificateExclusionPaths: "string",
clientCertificateMode: "string",
connectionStrings: [{
name: "string",
type: "string",
value: "string",
}],
contentShareForceDisabled: false,
dailyMemoryTimeQuota: 0,
publicNetworkAccessEnabled: false,
ftpPublishBasicAuthenticationEnabled: false,
functionsExtensionVersion: "string",
httpsOnly: false,
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
appSettings: {
string: "string",
},
builtinLoggingEnabled: false,
location: "string",
enabled: false,
name: "string",
authSettingsV2: {
login: {
allowedExternalRedirectUrls: ["string"],
cookieExpirationConvention: "string",
cookieExpirationTime: "string",
logoutEndpoint: "string",
nonceExpirationTime: "string",
preserveUrlFragmentsForLogins: false,
tokenRefreshExtensionTime: 0,
tokenStoreEnabled: false,
tokenStorePath: "string",
tokenStoreSasSettingName: "string",
validateNonce: false,
},
customOidcV2s: [{
clientId: "string",
name: "string",
openidConfigurationEndpoint: "string",
authorisationEndpoint: "string",
certificationUri: "string",
clientCredentialMethod: "string",
clientSecretSettingName: "string",
issuerEndpoint: "string",
nameClaimType: "string",
scopes: ["string"],
tokenEndpoint: "string",
}],
githubV2: {
clientId: "string",
clientSecretSettingName: "string",
loginScopes: ["string"],
},
azureStaticWebAppV2: {
clientId: "string",
},
configFilePath: "string",
activeDirectoryV2: {
clientId: "string",
tenantAuthEndpoint: "string",
allowedApplications: ["string"],
allowedAudiences: ["string"],
allowedGroups: ["string"],
allowedIdentities: ["string"],
clientSecretCertificateThumbprint: "string",
clientSecretSettingName: "string",
jwtAllowedClientApplications: ["string"],
jwtAllowedGroups: ["string"],
loginParameters: {
string: "string",
},
wwwAuthenticationDisabled: false,
},
defaultProvider: "string",
excludedPaths: ["string"],
facebookV2: {
appId: "string",
appSecretSettingName: "string",
graphApiVersion: "string",
loginScopes: ["string"],
},
forwardProxyConvention: "string",
forwardProxyCustomHostHeaderName: "string",
authEnabled: false,
googleV2: {
clientId: "string",
clientSecretSettingName: "string",
allowedAudiences: ["string"],
loginScopes: ["string"],
},
forwardProxyCustomSchemeHeaderName: "string",
httpRouteApiPrefix: "string",
appleV2: {
clientId: "string",
clientSecretSettingName: "string",
loginScopes: ["string"],
},
microsoftV2: {
clientId: "string",
clientSecretSettingName: "string",
allowedAudiences: ["string"],
loginScopes: ["string"],
},
requireAuthentication: false,
requireHttps: false,
runtimeVersion: "string",
twitterV2: {
consumerKey: "string",
consumerSecretSettingName: "string",
},
unauthenticatedAction: "string",
},
authSettings: {
enabled: false,
github: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
issuer: "string",
defaultProvider: "string",
additionalLoginParameters: {
string: "string",
},
facebook: {
appId: "string",
appSecret: "string",
appSecretSettingName: "string",
oauthScopes: ["string"],
},
activeDirectory: {
clientId: "string",
allowedAudiences: ["string"],
clientSecret: "string",
clientSecretSettingName: "string",
},
google: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
allowedExternalRedirectUrls: ["string"],
microsoft: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
runtimeVersion: "string",
tokenRefreshExtensionHours: 0,
tokenStoreEnabled: false,
twitter: {
consumerKey: "string",
consumerSecret: "string",
consumerSecretSettingName: "string",
},
unauthenticatedClientAction: "string",
},
stickySettings: {
appSettingNames: ["string"],
connectionStringNames: ["string"],
},
storageAccountAccessKey: "string",
storageAccountName: "string",
storageAccounts: [{
accessKey: "string",
accountName: "string",
name: "string",
shareName: "string",
type: "string",
mountPath: "string",
}],
storageKeyVaultSecretId: "string",
storageUsesManagedIdentity: false,
tags: {
string: "string",
},
virtualNetworkBackupRestoreEnabled: false,
virtualNetworkSubnetId: "string",
vnetImagePullEnabled: false,
webdeployPublishBasicAuthenticationEnabled: false,
zipDeployFile: "string",
});
type: azure:appservice:WindowsFunctionApp
properties:
appSettings:
string: string
authSettings:
activeDirectory:
allowedAudiences:
- string
clientId: string
clientSecret: string
clientSecretSettingName: string
additionalLoginParameters:
string: string
allowedExternalRedirectUrls:
- string
defaultProvider: string
enabled: false
facebook:
appId: string
appSecret: string
appSecretSettingName: string
oauthScopes:
- string
github:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
google:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
issuer: string
microsoft:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
runtimeVersion: string
tokenRefreshExtensionHours: 0
tokenStoreEnabled: false
twitter:
consumerKey: string
consumerSecret: string
consumerSecretSettingName: string
unauthenticatedClientAction: string
authSettingsV2:
activeDirectoryV2:
allowedApplications:
- string
allowedAudiences:
- string
allowedGroups:
- string
allowedIdentities:
- string
clientId: string
clientSecretCertificateThumbprint: string
clientSecretSettingName: string
jwtAllowedClientApplications:
- string
jwtAllowedGroups:
- string
loginParameters:
string: string
tenantAuthEndpoint: string
wwwAuthenticationDisabled: false
appleV2:
clientId: string
clientSecretSettingName: string
loginScopes:
- string
authEnabled: false
azureStaticWebAppV2:
clientId: string
configFilePath: string
customOidcV2s:
- authorisationEndpoint: string
certificationUri: string
clientCredentialMethod: string
clientId: string
clientSecretSettingName: string
issuerEndpoint: string
name: string
nameClaimType: string
openidConfigurationEndpoint: string
scopes:
- string
tokenEndpoint: string
defaultProvider: string
excludedPaths:
- string
facebookV2:
appId: string
appSecretSettingName: string
graphApiVersion: string
loginScopes:
- string
forwardProxyConvention: string
forwardProxyCustomHostHeaderName: string
forwardProxyCustomSchemeHeaderName: string
githubV2:
clientId: string
clientSecretSettingName: string
loginScopes:
- string
googleV2:
allowedAudiences:
- string
clientId: string
clientSecretSettingName: string
loginScopes:
- string
httpRouteApiPrefix: string
login:
allowedExternalRedirectUrls:
- string
cookieExpirationConvention: string
cookieExpirationTime: string
logoutEndpoint: string
nonceExpirationTime: string
preserveUrlFragmentsForLogins: false
tokenRefreshExtensionTime: 0
tokenStoreEnabled: false
tokenStorePath: string
tokenStoreSasSettingName: string
validateNonce: false
microsoftV2:
allowedAudiences:
- string
clientId: string
clientSecretSettingName: string
loginScopes:
- string
requireAuthentication: false
requireHttps: false
runtimeVersion: string
twitterV2:
consumerKey: string
consumerSecretSettingName: string
unauthenticatedAction: string
backup:
enabled: false
name: string
schedule:
frequencyInterval: 0
frequencyUnit: string
keepAtLeastOneBackup: false
lastExecutionTime: string
retentionPeriodDays: 0
startTime: string
storageAccountUrl: string
builtinLoggingEnabled: false
clientCertificateEnabled: false
clientCertificateExclusionPaths: string
clientCertificateMode: string
connectionStrings:
- name: string
type: string
value: string
contentShareForceDisabled: false
dailyMemoryTimeQuota: 0
enabled: false
ftpPublishBasicAuthenticationEnabled: false
functionsExtensionVersion: string
httpsOnly: false
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
keyVaultReferenceIdentityId: string
location: string
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
servicePlanId: string
siteConfig:
alwaysOn: false
apiDefinitionUrl: string
apiManagementApiId: string
appCommandLine: string
appScaleLimit: 0
appServiceLogs:
diskQuotaMb: 0
retentionPeriodDays: 0
applicationInsightsConnectionString: string
applicationInsightsKey: string
applicationStack:
dotnetVersion: string
javaVersion: string
nodeVersion: string
powershellCoreVersion: string
useCustomRuntime: false
useDotnetIsolatedRuntime: false
cors:
allowedOrigins:
- string
supportCredentials: false
defaultDocuments:
- string
detailedErrorLoggingEnabled: false
elasticInstanceMinimum: 0
ftpsState: string
healthCheckEvictionTimeInMin: 0
healthCheckPath: string
http2Enabled: false
ipRestrictionDefaultAction: string
ipRestrictions:
- action: string
description: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
loadBalancingMode: string
managedPipelineMode: string
minimumTlsVersion: string
preWarmedInstanceCount: 0
remoteDebuggingEnabled: false
remoteDebuggingVersion: string
runtimeScaleMonitoringEnabled: false
scmIpRestrictionDefaultAction: string
scmIpRestrictions:
- action: string
description: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
scmMinimumTlsVersion: string
scmType: string
scmUseMainIpRestriction: false
use32BitWorker: false
vnetRouteAllEnabled: false
websocketsEnabled: false
windowsFxVersion: string
workerCount: 0
stickySettings:
appSettingNames:
- string
connectionStringNames:
- string
storageAccountAccessKey: string
storageAccountName: string
storageAccounts:
- accessKey: string
accountName: string
mountPath: string
name: string
shareName: string
type: string
storageKeyVaultSecretId: string
storageUsesManagedIdentity: false
tags:
string: string
virtualNetworkBackupRestoreEnabled: false
virtualNetworkSubnetId: string
vnetImagePullEnabled: false
webdeployPublishBasicAuthenticationEnabled: false
zipDeployFile: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WindowsFunctionApp resource accepts the following input properties:
- Resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- Site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - App
Settings Dictionary<string, string> - A map of key-value pairs for App Settings and custom values.
- Auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - Backup
Windows
Function App Backup - A
backupblock as defined below. - Builtin
Logging boolEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - Client
Certificate boolEnabled - Should the function app use Client Certificates.
- Client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - Connection
Strings List<WindowsFunction App Connection String> - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - Enabled bool
- Is the Function App enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Functions
Extension stringVersion - 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
Windows
Function App Identity - A
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- Public
Network boolAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - Sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - Storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- Storage
Accounts List<WindowsFunction App Storage Account> - One or more
storage_accountblocks as defined below. - Storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- Storage
Uses boolManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Dictionary<string, string>
- A mapping of tags which should be assigned to the Windows Function App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Vnet
Image boolPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- Resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- Site
Config WindowsFunction App Site Config Args - A
site_configblock as defined below. - App
Settings map[string]string - A map of key-value pairs for App Settings and custom values.
- Auth
Settings WindowsFunction App Auth Settings Args - A
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Function App Auth Settings V2Args - A
auth_settings_v2block as defined below. - Backup
Windows
Function App Backup Args - A
backupblock as defined below. - Builtin
Logging boolEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - Client
Certificate boolEnabled - Should the function app use Client Certificates.
- Client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - Connection
Strings []WindowsFunction App Connection String Args - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - Enabled bool
- Is the Function App enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Functions
Extension stringVersion - 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
Windows
Function App Identity Args - A
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- Public
Network boolAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - Sticky
Settings WindowsFunction App Sticky Settings Args - A
sticky_settingsblock as defined below. - Storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- Storage
Accounts []WindowsFunction App Storage Account Args - One or more
storage_accountblocks as defined below. - Storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- Storage
Uses boolManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- map[string]string
- A mapping of tags which should be assigned to the Windows Function App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Vnet
Image boolPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- resource
Group StringName - 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 StringId - The ID of the App Service Plan within which to create this Function App.
- site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - app
Settings Map<String,String> - A map of key-value pairs for App Settings and custom values.
- auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup - A
backupblock as defined below. - builtin
Logging BooleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate BooleanEnabled - Should the function app use Client Certificates.
- client
Certificate StringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings List<WindowsFunction App Connection String> - One or more
connection_stringblocks as defined below. - Boolean
- Should Content Share Settings be disabled. Defaults to
false. - daily
Memory IntegerTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - enabled Boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension StringVersion - The runtime version associated with the Function App. Defaults to
~4. - https
Only Boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity
Windows
Function App Identity - A
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- public
Network BooleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Account StringAccess Key - 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 StringName - The backend storage account name which will be used by this Function App.
- storage
Accounts List<WindowsFunction App Storage Account> - One or more
storage_accountblocks as defined below. - storage
Key StringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses BooleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Map<String,String>
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - vnet
Image BooleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - app
Settings {[key: string]: string} - A map of key-value pairs for App Settings and custom values.
- auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup - A
backupblock as defined below. - builtin
Logging booleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate booleanEnabled - Should the function app use Client Certificates.
- client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings WindowsFunction App Connection String[] - One or more
connection_stringblocks as defined below. - boolean
- Should Content Share Settings be disabled. Defaults to
false. - daily
Memory numberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - enabled boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish booleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension stringVersion - The runtime version associated with the Function App. Defaults to
~4. - https
Only boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity
Windows
Function App Identity - A
identityblock as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- public
Network booleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- storage
Accounts WindowsFunction App Storage Account[] - One or more
storage_accountblocks as defined below. - storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses booleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- {[key: string]: string}
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network booleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network stringSubnet Id - vnet
Image booleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish booleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- resource_
group_ strname - 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_ strid - The ID of the App Service Plan within which to create this Function App.
- site_
config WindowsFunction App Site Config Args - A
site_configblock as defined below. - app_
settings Mapping[str, str] - A map of key-value pairs for App Settings and custom values.
- auth_
settings WindowsFunction App Auth Settings Args - A
auth_settingsblock as defined below. - auth_
settings_ Windowsv2 Function App Auth Settings V2Args - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup Args - A
backupblock as defined below. - builtin_
logging_ boolenabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client_
certificate_ boolenabled - Should the function app use Client Certificates.
- client_
certificate_ strexclusion_ paths - Paths to exclude when using client certificates, separated by ;
- client_
certificate_ strmode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection_
strings Sequence[WindowsFunction App Connection String Args] - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - daily_
memory_ inttime_ quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - enabled bool
- Is the Function App enabled? Defaults to
true. - ftp_
publish_ boolbasic_ authentication_ enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions_
extension_ strversion - 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
Windows
Function App Identity Args - A
identityblock as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- public_
network_ boolaccess_ enabled - Should public network access be enabled for the Function App. Defaults to
true. - sticky_
settings WindowsFunction App Sticky Settings Args - A
sticky_settingsblock as defined below. - storage_
account_ straccess_ key - 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_ strname - The backend storage account name which will be used by this Function App.
- storage_
accounts Sequence[WindowsFunction App Storage Account Args] - One or more
storage_accountblocks as defined below. - storage_
key_ strvault_ secret_ id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage_
uses_ boolmanaged_ identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Mapping[str, str]
- A mapping of tags which should be assigned to the Windows Function App.
- virtual_
network_ boolbackup_ restore_ enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual_
network_ strsubnet_ id - vnet_
image_ boolpull_ enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy_
publish_ boolbasic_ authentication_ enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- resource
Group StringName - 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 StringId - The ID of the App Service Plan within which to create this Function App.
- site
Config Property Map - A
site_configblock as defined below. - app
Settings Map<String> - A map of key-value pairs for App Settings and custom values.
- auth
Settings Property Map - A
auth_settingsblock as defined below. - auth
Settings Property MapV2 - A
auth_settings_v2block as defined below. - backup Property Map
- A
backupblock as defined below. - builtin
Logging BooleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate BooleanEnabled - Should the function app use Client Certificates.
- client
Certificate StringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings List<Property Map> - One or more
connection_stringblocks as defined below. - Boolean
- Should Content Share Settings be disabled. Defaults to
false. - daily
Memory NumberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - enabled Boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension StringVersion - The runtime version associated with the Function App. Defaults to
~4. - https
Only Boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity Property Map
- A
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- public
Network BooleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - sticky
Settings Property Map - A
sticky_settingsblock as defined below. - storage
Account StringAccess Key - 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 StringName - The backend storage account name which will be used by this Function App.
- storage
Accounts List<Property Map> - One or more
storage_accountblocks as defined below. - storage
Key StringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses BooleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Map<String>
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - vnet
Image BooleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
Outputs
All input properties are implicitly available as output properties. Additionally, the WindowsFunctionApp resource produces the following output properties:
- Custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string - The default hostname of the Windows Function App.
- Hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- The Kind value for this Windows Function App.
- Outbound
Ip List<string>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - Possible
Outbound List<string>Ip Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - Site
Credentials List<WindowsFunction App Site Credential> - A
site_credentialblock as defined below.
- Custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string - The default hostname of the Windows Function App.
- Hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- The Kind value for this Windows Function App.
- Outbound
Ip []stringAddress Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - Possible
Outbound []stringIp Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - Site
Credentials []WindowsFunction App Site Credential - A
site_credentialblock as defined below.
- custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname of the Windows Function App.
- hosting
Environment StringId - The ID of the App Service Environment used by Function App.
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- The Kind value for this Windows Function App.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip StringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound List<String>Ip Address Lists - 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 StringIp Addresses - 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 ofoutbound_ip_addresses. - site
Credentials List<WindowsFunction App Site Credential> - A
site_credentialblock as defined below.
- custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname string - The default hostname of the Windows Function App.
- hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- id string
- The provider-assigned unique ID for this managed resource.
- kind string
- The Kind value for this Windows Function App.
- outbound
Ip string[]Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound string[]Ip Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - site
Credentials WindowsFunction App Site Credential[] - A
site_credentialblock as defined below.
- custom_
domain_ strverification_ id - 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.
- hosting_
environment_ strid - The ID of the App Service Environment used by 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_ Sequence[str]address_ lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound_
ip_ straddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible_
outbound_ Sequence[str]ip_ address_ lists - 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_ strip_ addresses - 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 ofoutbound_ip_addresses. - site_
credentials Sequence[WindowsFunction App Site Credential] - A
site_credentialblock as defined below.
- custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname of the Windows Function App.
- hosting
Environment StringId - The ID of the App Service Environment used by Function App.
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- The Kind value for this Windows Function App.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip StringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound List<String>Ip Address Lists - 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 StringIp Addresses - 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 ofoutbound_ip_addresses. - site
Credentials List<Property Map> - A
site_credentialblock 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,
ftp_publish_basic_authentication_enabled: Optional[bool] = None,
functions_extension_version: Optional[str] = None,
hosting_environment_id: 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,
public_network_access_enabled: Optional[bool] = 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_backup_restore_enabled: Optional[bool] = None,
virtual_network_subnet_id: Optional[str] = None,
vnet_image_pull_enabled: Optional[bool] = None,
webdeploy_publish_basic_authentication_enabled: Optional[bool] = None,
zip_deploy_file: Optional[str] = None) -> WindowsFunctionAppfunc 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)resources: _: type: azure:appservice:WindowsFunctionApp get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- App
Settings Dictionary<string, string> - A map of key-value pairs for App Settings and custom values.
- Auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - Backup
Windows
Function App Backup - A
backupblock as defined below. - Builtin
Logging boolEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - Client
Certificate boolEnabled - Should the function app use Client Certificates.
- Client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - Connection
Strings List<WindowsFunction App Connection String> - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - Custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - Default
Hostname string - The default hostname of the Windows Function App.
- Enabled bool
- Is the Function App enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Functions
Extension stringVersion - The runtime version associated with the Function App. Defaults to
~4. - Hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- Https
Only bool - Can the Function App only be accessed via HTTPS?. Defaults to
false. - Identity
Windows
Function App Identity - A
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- Outbound
Ip List<string>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - Possible
Outbound List<string>Ip Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - Public
Network boolAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - Resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- Site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - Site
Credentials List<WindowsFunction App Site Credential> - A
site_credentialblock as defined below. - Sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - Storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- Storage
Accounts List<WindowsFunction App Storage Account> - One or more
storage_accountblocks as defined below. - Storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- Storage
Uses boolManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Dictionary<string, string>
- A mapping of tags which should be assigned to the Windows Function App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Vnet
Image boolPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- App
Settings map[string]string - A map of key-value pairs for App Settings and custom values.
- Auth
Settings WindowsFunction App Auth Settings Args - A
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Function App Auth Settings V2Args - A
auth_settings_v2block as defined below. - Backup
Windows
Function App Backup Args - A
backupblock as defined below. - Builtin
Logging boolEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - Client
Certificate boolEnabled - Should the function app use Client Certificates.
- Client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - Connection
Strings []WindowsFunction App Connection String Args - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - Custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Daily
Memory intTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - Default
Hostname string - The default hostname of the Windows Function App.
- Enabled bool
- Is the Function App enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Functions
Extension stringVersion - The runtime version associated with the Function App. Defaults to
~4. - Hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- Https
Only bool - Can the Function App only be accessed via HTTPS?. Defaults to
false. - Identity
Windows
Function App Identity Args - A
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- Outbound
Ip []stringAddress Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - Possible
Outbound []stringIp Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - Public
Network boolAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - Resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- Site
Config WindowsFunction App Site Config Args - A
site_configblock as defined below. - Site
Credentials []WindowsFunction App Site Credential Args - A
site_credentialblock as defined below. - Sticky
Settings WindowsFunction App Sticky Settings Args - A
sticky_settingsblock as defined below. - Storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- Storage
Accounts []WindowsFunction App Storage Account Args - One or more
storage_accountblocks as defined below. - Storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- Storage
Uses boolManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- map[string]string
- A mapping of tags which should be assigned to the Windows Function App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Vnet
Image boolPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- app
Settings Map<String,String> - A map of key-value pairs for App Settings and custom values.
- auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup - A
backupblock as defined below. - builtin
Logging BooleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate BooleanEnabled - Should the function app use Client Certificates.
- client
Certificate StringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings List<WindowsFunction App Connection String> - One or more
connection_stringblocks as defined below. - Boolean
- Should Content Share Settings be disabled. Defaults to
false. - custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory IntegerTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - default
Hostname String - The default hostname of the Windows Function App.
- enabled Boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension StringVersion - The runtime version associated with the Function App. Defaults to
~4. - hosting
Environment StringId - The ID of the App Service Environment used by Function App.
- https
Only Boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity
Windows
Function App Identity - A
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip StringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound List<String>Ip Address Lists - 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 StringIp Addresses - 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 ofoutbound_ip_addresses. - public
Network BooleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - resource
Group StringName - 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 StringId - The ID of the App Service Plan within which to create this Function App.
- site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - site
Credentials List<WindowsFunction App Site Credential> - A
site_credentialblock as defined below. - sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Account StringAccess Key - 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 StringName - The backend storage account name which will be used by this Function App.
- storage
Accounts List<WindowsFunction App Storage Account> - One or more
storage_accountblocks as defined below. - storage
Key StringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses BooleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Map<String,String>
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - vnet
Image BooleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- app
Settings {[key: string]: string} - A map of key-value pairs for App Settings and custom values.
- auth
Settings WindowsFunction App Auth Settings - A
auth_settingsblock as defined below. - auth
Settings WindowsV2 Function App Auth Settings V2 - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup - A
backupblock as defined below. - builtin
Logging booleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate booleanEnabled - Should the function app use Client Certificates.
- client
Certificate stringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate stringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings WindowsFunction App Connection String[] - One or more
connection_stringblocks as defined below. - boolean
- Should Content Share Settings be disabled. Defaults to
false. - custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory numberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - default
Hostname string - The default hostname of the Windows Function App.
- enabled boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish booleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension stringVersion - The runtime version associated with the Function App. Defaults to
~4. - hosting
Environment stringId - The ID of the App Service Environment used by Function App.
- https
Only boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity
Windows
Function App Identity - A
identityblock as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- outbound
Ip string[]Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip stringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound string[]Ip Address Lists - 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 stringIp Addresses - 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 ofoutbound_ip_addresses. - public
Network booleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - resource
Group stringName - 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 stringId - The ID of the App Service Plan within which to create this Function App.
- site
Config WindowsFunction App Site Config - A
site_configblock as defined below. - site
Credentials WindowsFunction App Site Credential[] - A
site_credentialblock as defined below. - sticky
Settings WindowsFunction App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Account stringAccess Key - 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 stringName - The backend storage account name which will be used by this Function App.
- storage
Accounts WindowsFunction App Storage Account[] - One or more
storage_accountblocks as defined below. - storage
Key stringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses booleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- {[key: string]: string}
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network booleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network stringSubnet Id - vnet
Image booleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish booleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- app_
settings Mapping[str, str] - A map of key-value pairs for App Settings and custom values.
- auth_
settings WindowsFunction App Auth Settings Args - A
auth_settingsblock as defined below. - auth_
settings_ Windowsv2 Function App Auth Settings V2Args - A
auth_settings_v2block as defined below. - backup
Windows
Function App Backup Args - A
backupblock as defined below. - builtin_
logging_ boolenabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client_
certificate_ boolenabled - Should the function app use Client Certificates.
- client_
certificate_ strexclusion_ paths - Paths to exclude when using client certificates, separated by ;
- client_
certificate_ strmode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection_
strings Sequence[WindowsFunction App Connection String Args] - One or more
connection_stringblocks as defined below. - bool
- Should Content Share Settings be disabled. Defaults to
false. - custom_
domain_ strverification_ id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily_
memory_ inttime_ quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - default_
hostname str - The default hostname of the Windows Function App.
- enabled bool
- Is the Function App enabled? Defaults to
true. - ftp_
publish_ boolbasic_ authentication_ enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions_
extension_ strversion - The runtime version associated with the Function App. Defaults to
~4. - hosting_
environment_ strid - The ID of the App Service Environment used by Function App.
- https_
only bool - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity
Windows
Function App Identity Args - A
identityblock as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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_ Sequence[str]address_ lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound_
ip_ straddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible_
outbound_ Sequence[str]ip_ address_ lists - 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_ strip_ addresses - 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 ofoutbound_ip_addresses. - public_
network_ boolaccess_ enabled - Should public network access be enabled for the Function App. Defaults to
true. - resource_
group_ strname - 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_ strid - The ID of the App Service Plan within which to create this Function App.
- site_
config WindowsFunction App Site Config Args - A
site_configblock as defined below. - site_
credentials Sequence[WindowsFunction App Site Credential Args] - A
site_credentialblock as defined below. - sticky_
settings WindowsFunction App Sticky Settings Args - A
sticky_settingsblock as defined below. - storage_
account_ straccess_ key - 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_ strname - The backend storage account name which will be used by this Function App.
- storage_
accounts Sequence[WindowsFunction App Storage Account Args] - One or more
storage_accountblocks as defined below. - storage_
key_ strvault_ secret_ id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage_
uses_ boolmanaged_ identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Mapping[str, str]
- A mapping of tags which should be assigned to the Windows Function App.
- virtual_
network_ boolbackup_ restore_ enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual_
network_ strsubnet_ id - vnet_
image_ boolpull_ enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy_
publish_ boolbasic_ authentication_ enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
- app
Settings Map<String> - A map of key-value pairs for App Settings and custom values.
- auth
Settings Property Map - A
auth_settingsblock as defined below. - auth
Settings Property MapV2 - A
auth_settings_v2block as defined below. - backup Property Map
- A
backupblock as defined below. - builtin
Logging BooleanEnabled - Should built in logging be enabled. Configures
AzureWebJobsDashboardapp setting based on the configured storage setting. Defaults totrue. - client
Certificate BooleanEnabled - Should the function app use Client Certificates.
- client
Certificate StringExclusion Paths - Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode - The mode of the Function App's client certificates requirement for incoming requests. Possible values are
Required,Optional, andOptionalInteractiveUser. Defaults toOptional. - connection
Strings List<Property Map> - One or more
connection_stringblocks as defined below. - Boolean
- Should Content Share Settings be disabled. Defaults to
false. - custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- daily
Memory NumberTime Quota - The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to
0. - default
Hostname String - The default hostname of the Windows Function App.
- enabled Boolean
- Is the Function App enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - functions
Extension StringVersion - The runtime version associated with the Function App. Defaults to
~4. - hosting
Environment StringId - The ID of the App Service Environment used by Function App.
- https
Only Boolean - Can the Function App only be accessed via HTTPS?. Defaults to
false. - identity Property Map
- A
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. 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
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses. For example
["52.23.25.3", "52.143.43.12"] - outbound
Ip StringAddresses - A comma separated list of outbound IP addresses as a string. For example
52.23.25.3,52.143.43.12. - possible
Outbound List<String>Ip Address Lists - 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 StringIp Addresses - 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 ofoutbound_ip_addresses. - public
Network BooleanAccess Enabled - Should public network access be enabled for the Function App. Defaults to
true. - resource
Group StringName - 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 StringId - The ID of the App Service Plan within which to create this Function App.
- site
Config Property Map - A
site_configblock as defined below. - site
Credentials List<Property Map> - A
site_credentialblock as defined below. - sticky
Settings Property Map - A
sticky_settingsblock as defined below. - storage
Account StringAccess Key - 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 StringName - The backend storage account name which will be used by this Function App.
- storage
Accounts List<Property Map> - One or more
storage_accountblocks as defined below. - storage
Key StringVault Secret Id The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App.
NOTE:
storage_key_vault_secret_idcannot be used withstorage_account_name.NOTE:
storage_key_vault_secret_idused without a version will use the latest version of the secret, however, the service can take up to 24h to pick up a rotation of the latest version. See the official docs for more information.- storage
Uses BooleanManaged Identity Should the Function App use Managed Identity to access the storage account. Conflicts with
storage_account_access_key.NOTE: One of
storage_account_access_keyorstorage_uses_managed_identitymust be specified when usingstorage_account_name.- Map<String>
- A mapping of tags which should be assigned to the Windows Function App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - vnet
Image BooleanPull Enabled Specifies whether traffic for the image pull should be routed over virtual network. Defaults to
false.Note: The feature can also be enabled via the app setting
WEBSITE_PULL_IMAGE_OVER_VNET. The Setting is enabled by default for app running in the App Service Environment.- webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Function App.
Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.
Supporting Types
WindowsFunctionAppAuthSettings, WindowsFunctionAppAuthSettingsArgs
- Enabled bool
- Should the Authentication / Authorization feature be enabled for the Windows Function App?
- Active
Directory WindowsFunction App Auth Settings Active Directory - An
active_directoryblock as defined above. - Additional
Login Dictionary<string, string>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External List<string>Redirect Urls - 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 string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- Facebook
Windows
Function App Auth Settings Facebook - A
facebookblock as defined below. - Github
Windows
Function App Auth Settings Github - A
githubblock as defined below. - Google
Windows
Function App Auth Settings Google - A
googleblock as defined below. - Issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Windows
Function App Auth Settings Microsoft - A
microsoftblock as defined below. - Runtime
Version string - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- Token
Refresh doubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - Twitter
Windows
Function App Auth Settings Twitter - A
twitterblock as defined below. - Unauthenticated
Client stringAction - 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 WindowsFunction App Auth Settings Active Directory - An
active_directoryblock as defined above. - Additional
Login map[string]stringParameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External []stringRedirect Urls - 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 string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- Facebook
Windows
Function App Auth Settings Facebook - A
facebookblock as defined below. - Github
Windows
Function App Auth Settings Github - A
githubblock as defined below. - Google
Windows
Function App Auth Settings Google - A
googleblock as defined below. - Issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Windows
Function App Auth Settings Microsoft - A
microsoftblock as defined below. - Runtime
Version string - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- Token
Refresh float64Extension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - Twitter
Windows
Function App Auth Settings Twitter - A
twitterblock as defined below. - Unauthenticated
Client stringAction - 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?
- active
Directory WindowsFunction App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional
Login Map<String,String>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls - 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 String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Function App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Function App Auth Settings Github - A
githubblock as defined below. - google
Windows
Function App Auth Settings Google - A
googleblock as defined below. - issuer String
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Function App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime
Version String - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- token
Refresh DoubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - twitter
Windows
Function App Auth Settings Twitter - A
twitterblock as defined below. - unauthenticated
Client StringAction - 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?
- active
Directory WindowsFunction App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional
Login {[key: string]: string}Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External string[]Redirect Urls - 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 string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Function App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Function App Auth Settings Github - A
githubblock as defined below. - google
Windows
Function App Auth Settings Google - A
googleblock as defined below. - issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Function App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime
Version string - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- token
Refresh numberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store booleanEnabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - twitter
Windows
Function App Auth Settings Twitter - A
twitterblock as defined below. - unauthenticated
Client stringAction - 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 WindowsFunction App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional_
login_ Mapping[str, str]parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed_
external_ Sequence[str]redirect_ urls - 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 multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Function App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Function App Auth Settings Github - A
githubblock as defined below. - google
Windows
Function App Auth Settings Google - A
googleblock as defined below. - issuer str
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Function App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime_
version str - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- token_
refresh_ floatextension_ hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token_
store_ boolenabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - twitter
Windows
Function App Auth Settings Twitter - A
twitterblock as defined below. - unauthenticated_
client_ straction - 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?
- active
Directory Property Map - An
active_directoryblock as defined above. - additional
Login Map<String>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls - 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 String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook Property Map
- A
facebookblock as defined below. - github Property Map
- A
githubblock as defined below. - google Property Map
- A
googleblock as defined below. - issuer String
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Function App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft Property Map
- A
microsoftblock as defined below. - runtime
Version String - The Runtime Version of the Authentication / Authorization feature in use for the Windows Function App.
- token
Refresh NumberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Windows Function App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - twitter Property Map
- A
twitterblock as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
WindowsFunctionAppAuthSettingsActiveDirectory, WindowsFunctionAppAuthSettingsActiveDirectoryArgs
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- Client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - Client
Secret stringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- Client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - Client
Secret stringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret String - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret StringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret stringSetting Name - 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.
Note: The
client_idvalue is always considered an allowed audience.- client_
secret str - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client_
secret_ strsetting_ name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret String - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret StringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
WindowsFunctionAppAuthSettingsFacebook, WindowsFunctionAppAuthSettingsFacebookArgs
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - App
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - Oauth
Scopes List<string> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - App
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - Oauth
Scopes []string - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret String - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret StringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id string - The App ID of the Facebook app used for login.
- app
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes 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_ strsetting_ name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth_
scopes Sequence[str] - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret String - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret StringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
WindowsFunctionAppAuthSettingsGithub, WindowsFunctionAppAuthSettingsGithubArgs
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - Oauth
Scopes List<string> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - Oauth
Scopes []string - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret String - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id string - The ID of the GitHub app used for login.
- client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes 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_ strsetting_ name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth_
scopes Sequence[str] - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret String - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
WindowsFunctionAppAuthSettingsGoogle, WindowsFunctionAppAuthSettingsGoogleArgs
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - Oauth
Scopes 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, andemailare used as default scopes.
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - Oauth
Scopes []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, andemailare used as default scopes.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes 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, andemailare used as default scopes.
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes 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, andemailare 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_ strsetting_ name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_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, andemailare used as default scopes.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes 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, andemailare used as default scopes.
WindowsFunctionAppAuthSettingsMicrosoft, WindowsFunctionAppAuthSettingsMicrosoftArgs
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - 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 List<string> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified,
wl.basicis used as the default scope.
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - 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 []string - Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified,
wl.basicis used as the default scope.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - 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 List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified,
wl.basicis used as the default scope.
- client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name. - client
Secret stringSetting Name - 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 string[] - Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified,
wl.basicis 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_ strsetting_ name - 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.basicis used as the default scope.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - 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 List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified,
wl.basicis used as the default scope.
WindowsFunctionAppAuthSettingsTwitter, WindowsFunctionAppAuthSettingsTwitterArgs
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name. - Consumer
Secret stringSetting Name - 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 string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name. - Consumer
Secret stringSetting Name - 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 String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name. - consumer
Secret StringSetting Name - 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 string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret string - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name. - consumer
Secret stringSetting Name - 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_ strsetting_ name - 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 String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name. - consumer
Secret StringSetting Name - 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, WindowsFunctionAppAuthSettingsV2Args
- Login
Windows
Function App Auth Settings V2Login - A
loginblock as defined below. - Active
Directory WindowsV2 Function App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - Apple
V2 WindowsFunction App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - Auth
Enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - Azure
Static WindowsWeb App V2 Function App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - Config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- Custom
Oidc List<WindowsV2s Function App Auth Settings V2Custom Oidc V2> - Zero or more
custom_oidc_v2blocks as defined below. - Default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- Excluded
Paths List<string> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- Facebook
V2 WindowsFunction App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - Forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - Forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- Github
V2 WindowsFunction App Auth Settings V2Github V2 - A
github_v2block as defined below. - Google
V2 WindowsFunction App Auth Settings V2Google V2 - A
google_v2block as defined below. - Http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - Microsoft
V2 WindowsFunction App Auth Settings V2Microsoft V2 - A
microsoft_v2block 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 string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - Twitter
V2 WindowsFunction App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - Unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- Login
Windows
Function App Auth Settings V2Login - A
loginblock as defined below. - Active
Directory WindowsV2 Function App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - Apple
V2 WindowsFunction App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - Auth
Enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - Azure
Static WindowsWeb App V2 Function App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - Config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- Custom
Oidc []WindowsV2s Function App Auth Settings V2Custom Oidc V2 - Zero or more
custom_oidc_v2blocks as defined below. - Default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- Excluded
Paths []string The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- Facebook
V2 WindowsFunction App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - Forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - Forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- Github
V2 WindowsFunction App Auth Settings V2Github V2 - A
github_v2block as defined below. - Google
V2 WindowsFunction App Auth Settings V2Google V2 - A
google_v2block as defined below. - Http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - Microsoft
V2 WindowsFunction App Auth Settings V2Microsoft V2 - A
microsoft_v2block 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 string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - Twitter
V2 WindowsFunction App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - Unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Function App Auth Settings V2Login - A
loginblock as defined below. - active
Directory WindowsV2 Function App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple
V2 WindowsFunction App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth
Enabled Boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static WindowsWeb App V2 Function App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config
File StringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc List<WindowsV2s Function App Auth Settings V2Custom Oidc V2> - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider String The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 WindowsFunction App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward
Proxy StringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy StringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 WindowsFunction App Auth Settings V2Github V2 - A
github_v2block as defined below. - google
V2 WindowsFunction App Auth Settings V2Google V2 - A
google_v2block as defined below. - http
Route StringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 WindowsFunction App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - require
Authentication Boolean - Should the authentication flow be used for all requests.
- require
Https Boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version String - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 WindowsFunction App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated
Action String - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Function App Auth Settings V2Login - A
loginblock as defined below. - active
Directory WindowsV2 Function App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple
V2 WindowsFunction App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth
Enabled boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static WindowsWeb App V2 Function App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc WindowsV2s Function App Auth Settings V2Custom Oidc V2[] - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths string[] The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 WindowsFunction App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 WindowsFunction App Auth Settings V2Github V2 - A
github_v2block as defined below. - google
V2 WindowsFunction App Auth Settings V2Google V2 - A
google_v2block as defined below. - http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 WindowsFunction App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - require
Authentication boolean - Should the authentication flow be used for all requests.
- require
Https boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 WindowsFunction App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Function App Auth Settings V2Login - A
loginblock as defined below. - active_
directory_ Windowsv2 Function App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple_
v2 WindowsFunction App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth_
enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - azure_
static_ Windowsweb_ app_ v2 Function App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config_
file_ strpath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom_
oidc_ Sequence[Windowsv2s Function App Auth Settings V2Custom Oidc V2] - Zero or more
custom_oidc_v2blocks as defined below. - default_
provider str The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded_
paths Sequence[str] The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook_
v2 WindowsFunction App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward_
proxy_ strconvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward_
proxy_ strcustom_ host_ header_ name - The name of the custom header containing the host of the request.
- forward_
proxy_ strcustom_ scheme_ header_ name - The name of the custom header containing the scheme of the request.
- github_
v2 WindowsFunction App Auth Settings V2Github V2 - A
github_v2block as defined below. - google_
v2 WindowsFunction App Auth Settings V2Google V2 - A
google_v2block as defined below. - http_
route_ strapi_ prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft_
v2 WindowsFunction App Auth Settings V2Microsoft V2 - A
microsoft_v2block 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 and Authorisation feature of this App. Defaults to
~1. - twitter_
v2 WindowsFunction App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated_
action str - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login Property Map
- A
loginblock as defined below. - active
Directory Property MapV2 - An
active_directory_v2block as defined below. - apple
V2 Property Map - An
apple_v2block as defined below. - auth
Enabled Boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static Property MapWeb App V2 - An
azure_static_web_app_v2block as defined below. - config
File StringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc List<Property Map>V2s - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider String The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 Property Map - A
facebook_v2block as defined below. - forward
Proxy StringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy StringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 Property Map - A
github_v2block as defined below. - google
V2 Property Map - A
google_v2block as defined below. - http
Route StringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 Property Map - A
microsoft_v2block as defined below. - require
Authentication Boolean - Should the authentication flow be used for all requests.
- require
Https Boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version String - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 Property Map - A
twitter_v2block as defined below. - unauthenticated
Action String - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2, WindowsFunctionAppAuthSettingsV2ActiveDirectoryV2Args
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- Allowed
Applications List<string> - The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Allowed
Groups List<string> - The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities List<string> - The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Jwt
Allowed List<string>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed List<string>Groups - A list of Allowed Groups in the JWT Claim.
- Login
Parameters Dictionary<string, string> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- Allowed
Applications []string - The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Allowed
Groups []string - The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities []string - The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Jwt
Allowed []stringClient Applications - A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed []stringGroups - A list of Allowed Groups in the JWT Claim.
- Login
Parameters map[string]string - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications List<String> - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups List<String> - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed List<String>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String,String> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications string[] - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups string[] - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities string[] - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed string[]Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed string[]Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters {[key: string]: string} - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication booleanDisabled - 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_ strendpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- 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.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- 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_ strcertificate_ thumbprint - The thumbprint of the certificate used for signing purposes.
- client_
secret_ strsetting_ name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt_
allowed_ Sequence[str]client_ applications - A list of Allowed Client Applications in the JWT Claim.
- jwt_
allowed_ Sequence[str]groups - 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_ booldisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications List<String> - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups List<String> - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed List<String>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
WindowsFunctionAppAuthSettingsV2AppleV2, WindowsFunctionAppAuthSettingsV2AppleV2Args
- Client
Id string - The OpenID Connect Client ID for the Apple web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Client
Id string - The OpenID Connect Client ID for the Apple web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id String - The OpenID Connect Client ID for the Apple web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id string - The OpenID Connect Client ID for the Apple web application.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes string[] A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client_
id str - The OpenID Connect Client ID for the Apple web application.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login_
scopes Sequence[str] A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id String - The OpenID Connect Client ID for the Apple web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2, WindowsFunctionAppAuthSettingsV2AzureStaticWebAppV2Args
- Client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- Client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id String - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client_
id str - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id String - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
WindowsFunctionAppAuthSettingsV2CustomOidcV2, WindowsFunctionAppAuthSettingsV2CustomOidcV2Args
- Client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- Name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- Openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - Certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - Client
Credential stringMethod - The Client Credential Method used.
- Client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - Issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - Name
Claim stringType - The name of the claim that contains the users name.
- Scopes List<string>
- The list of the scopes that should be requested while authenticating.
- Token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- Client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- Name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- Openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - Certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - Client
Credential stringMethod - The Client Credential Method used.
- Client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - Issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - Name
Claim stringType - The name of the claim that contains the users name.
- Scopes []string
- The list of the scopes that should be requested while authenticating.
- Token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client
Id String - The ID of the Client to use to authenticate with the Custom OIDC.
- name String
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration StringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - String
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri String - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential StringMethod - The Client Credential Method used.
- client
Secret StringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint String - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim StringType - The name of the claim that contains the users name.
- scopes List<String>
- The list of the scopes that should be requested while authenticating.
- token
Endpoint String - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential stringMethod - The Client Credential Method used.
- client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim stringType - The name of the claim that contains the users name.
- scopes string[]
- The list of the scopes that should be requested while authenticating.
- token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client_
id str - The ID of the Client to use to authenticate with the Custom OIDC.
- name str
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid_
configuration_ strendpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - str
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification_
uri str - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client_
credential_ strmethod - The Client Credential Method used.
- client_
secret_ strsetting_ name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer_
endpoint str - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name_
claim_ strtype - 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_endpointresponse.
- client
Id String - The ID of the Client to use to authenticate with the Custom OIDC.
- name String
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration StringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - String
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri String - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential StringMethod - The Client Credential Method used.
- client
Secret StringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint String - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim StringType - The name of the claim that contains the users name.
- scopes List<String>
- The list of the scopes that should be requested while authenticating.
- token
Endpoint String - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
WindowsFunctionAppAuthSettingsV2FacebookV2, WindowsFunctionAppAuthSettingsV2FacebookV2Args
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- Login
Scopes List<string> - The list of scopes that should be requested as part of Facebook Login authentication.
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- Login
Scopes []string - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api StringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes List<String> - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id string - The App ID of the Facebook app used for login.
- app
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes string[] - The list of scopes that should be requested as part of Facebook Login authentication.
- app_
id str - The App ID of the Facebook app used for login.
- app_
secret_ strsetting_ name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph_
api_ strversion - The version of the Facebook API to be used while logging in.
- login_
scopes Sequence[str] - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api StringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes List<String> - The list of scopes that should be requested as part of Facebook Login authentication.
WindowsFunctionAppAuthSettingsV2GithubV2, WindowsFunctionAppAuthSettingsV2GithubV2Args
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes List<string> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes []string - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id string - The ID of the GitHub app used for login.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes string[] - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client_
id str - The ID of the GitHub app used for login.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login_
scopes Sequence[str] - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
WindowsFunctionAppAuthSettingsV2GoogleV2, WindowsFunctionAppAuthSettingsV2GoogleV2Args
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences List<string> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- Login
Scopes List<string> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences []string - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- Login
Scopes []string - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences string[] - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes string[] - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client_
id str - The OpenID Connect Client ID for the Google web application.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed_
audiences Sequence[str] - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login_
scopes Sequence[str] - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
WindowsFunctionAppAuthSettingsV2Login, WindowsFunctionAppAuthSettingsV2LoginArgs
- Allowed
External List<string>Redirect Urls 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.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - Logout
Endpoint string - The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - Preserve
Url boolFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - Token
Refresh doubleExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Token Store configuration Enabled. Defaults to
false - Token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name - 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.
- Allowed
External []stringRedirect Urls 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.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - Logout
Endpoint string - The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - Preserve
Url boolFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - Token
Refresh float64Extension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Token Store configuration Enabled. Defaults to
false - Token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name - 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.
- allowed
External List<String>Redirect Urls 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.
Note: URLs within the current domain are always implicitly allowed.
- String
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - String
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint String - The endpoint to which logout requests should be made.
- nonce
Expiration StringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url BooleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh DoubleExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store StringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed
External string[]Redirect Urls 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.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint string - The endpoint to which logout requests should be made.
- nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url booleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh numberExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store booleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store stringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed_
external_ Sequence[str]redirect_ urls 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.
Note: URLs within the current domain are always implicitly allowed.
- str
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - 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_ strtime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve_
url_ boolfragments_ for_ logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token_
refresh_ floatextension_ time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token_
store_ boolenabled - Should the Token Store configuration Enabled. Defaults to
false - token_
store_ strpath - The directory path in the App Filesystem in which the tokens will be stored.
- token_
store_ strsas_ setting_ name - 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.
- allowed
External List<String>Redirect Urls 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.
Note: URLs within the current domain are always implicitly allowed.
- String
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - String
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint String - The endpoint to which logout requests should be made.
- nonce
Expiration StringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url BooleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh NumberExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store StringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
WindowsFunctionAppAuthSettingsV2MicrosoftV2, WindowsFunctionAppAuthSettingsV2MicrosoftV2Args
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences List<string> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- Login
Scopes List<string> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences []string - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- Login
Scopes []string - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes List<String> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences string[] - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes string[] - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client_
id str - The OAuth 2.0 client ID that was created for the app used for authentication.
- client_
secret_ strsetting_ name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed_
audiences Sequence[str] - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login_
scopes Sequence[str] - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes List<String> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
WindowsFunctionAppAuthSettingsV2TwitterV2, WindowsFunctionAppAuthSettingsV2TwitterV2Args
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer_
key str - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer_
secret_ strsetting_ name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
WindowsFunctionAppBackup, WindowsFunctionAppBackupArgs
- Name string
- The name which should be used for this Backup.
- Schedule
Windows
Function App Backup Schedule - A
scheduleblock as defined below. - Storage
Account stringUrl - 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
Windows
Function App Backup Schedule - A
scheduleblock as defined below. - Storage
Account stringUrl - 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
Windows
Function App Backup Schedule - A
scheduleblock as defined below. - storage
Account StringUrl - 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
Windows
Function App Backup Schedule - A
scheduleblock as defined below. - storage
Account stringUrl - 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
Windows
Function App Backup Schedule - A
scheduleblock as defined below. - storage_
account_ strurl - 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
scheduleblock as defined below. - storage
Account StringUrl - The SAS URL to the container.
- enabled Boolean
- Should this backup job be enabled? Defaults to
true.
WindowsFunctionAppBackupSchedule, WindowsFunctionAppBackupScheduleArgs
- Frequency
Interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- Frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - Keep
At boolLeast One Backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - Last
Execution stringTime - The time the backup was last attempted.
- Retention
Period intDays - After how many days backups should be deleted. Defaults to
30. - Start
Time 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
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- Frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - Keep
At boolLeast One Backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - Last
Execution stringTime - The time the backup was last attempted.
- Retention
Period intDays - After how many days backups should be deleted. Defaults to
30. - Start
Time string - When the schedule should start working in RFC-3339 format.
- frequency
Interval Integer How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit String - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - keep
At BooleanLeast One Backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - last
Execution StringTime - The time the backup was last attempted.
- retention
Period IntegerDays - After how many days backups should be deleted. Defaults to
30. - start
Time String - When the schedule should start working in RFC-3339 format.
- frequency
Interval number How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - keep
At booleanLeast One Backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - last
Execution stringTime - The time the backup was last attempted.
- retention
Period numberDays - After how many days backups should be deleted. Defaults to
30. - start
Time 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
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- frequency_
unit str - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - keep_
at_ boolleast_ one_ backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - last_
execution_ strtime - The time the backup was last attempted.
- retention_
period_ intdays - After how many days backups should be deleted. Defaults to
30. - start_
time str - When the schedule should start working in RFC-3339 format.
- frequency
Interval Number How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Function App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit String - The unit of time for how often the backup should take place. Possible values include:
DayandHour. - keep
At BooleanLeast One Backup - Should the service keep at least one backup, regardless of age of backup. Defaults to
false. - last
Execution StringTime - The time the backup was last attempted.
- retention
Period NumberDays - After how many days backups should be deleted. Defaults to
30. - start
Time String - When the schedule should start working in RFC-3339 format.
WindowsFunctionAppConnectionString, WindowsFunctionAppConnectionStringArgs
WindowsFunctionAppIdentity, WindowsFunctionAppIdentityArgs
- 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). - Identity
Ids List<string> A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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). - Identity
Ids []string A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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). - identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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). - identity
Ids string[] A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- 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). - identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Windows Function App.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
WindowsFunctionAppSiteConfig, WindowsFunctionAppSiteConfigArgs
- Always
On bool If this Windows Function App is Always On enabled. Defaults to
false.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- Api
Definition stringUrl - The URL of the API definition that describes this Windows Function App.
- Api
Management stringApi Id - The ID of the API Management API for this Windows Function App.
- App
Command stringLine - The App command line to launch.
- App
Scale intLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- App
Service WindowsLogs Function App Site Config App Service Logs - An
app_service_logsblock as defined above. - Application
Insights stringConnection String - The Connection String for linking the Windows Function App to Application Insights.
- Application
Insights stringKey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- Application
Stack WindowsFunction App Site Config Application Stack An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- Cors
Windows
Function App Site Config Cors - A
corsblock as defined above. - Default
Documents List<string> - Specifies a list of Default Documents for the Windows Function App.
- Detailed
Error boolLogging Enabled - Is detailed error logging enabled
- Elastic
Instance intMinimum - The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.
- Ftps
State string - State of FTP / FTPS service for this Windows Function App. Possible values include:
AllAllowed,FtpsOnlyandDisabled. Defaults toDisabled. - Health
Check intEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - Health
Check stringPath - The path to be checked for this Windows Function App health.
- Http2Enabled bool
- Specifies if the HTTP2 protocol should be enabled. Defaults to
false. - Ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Ip
Restrictions List<WindowsFunction App Site Config Ip Restriction> - One or more
ip_restrictionblocks as defined above. - Load
Balancing stringMode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - Managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - Minimum
Tls stringVersion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Pre
Warmed intInstance Count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- Remote
Debugging boolEnabled - Should Remote Debugging be enabled. Defaults to
false. - Remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - Runtime
Scale boolMonitoring Enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- Scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Scm
Ip List<WindowsRestrictions Function App Site Config Scm Ip Restriction> - One or more
scm_ip_restrictionblocks as defined above. - Scm
Minimum stringTls Version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Scm
Type string - The SCM Type in use by the Windows Function App.
- Scm
Use boolMain Ip Restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - Use32Bit
Worker bool - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - Vnet
Route boolAll Enabled - 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 stringVersion - The Windows FX Version string.
- Worker
Count int - The number of Workers for this Windows Function App.
- Always
On bool If this Windows Function App is Always On enabled. Defaults to
false.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- Api
Definition stringUrl - The URL of the API definition that describes this Windows Function App.
- Api
Management stringApi Id - The ID of the API Management API for this Windows Function App.
- App
Command stringLine - The App command line to launch.
- App
Scale intLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- App
Service WindowsLogs Function App Site Config App Service Logs - An
app_service_logsblock as defined above. - Application
Insights stringConnection String - The Connection String for linking the Windows Function App to Application Insights.
- Application
Insights stringKey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- Application
Stack WindowsFunction App Site Config Application Stack An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- Cors
Windows
Function App Site Config Cors - A
corsblock as defined above. - Default
Documents []string - Specifies a list of Default Documents for the Windows Function App.
- Detailed
Error boolLogging Enabled - Is detailed error logging enabled
- Elastic
Instance intMinimum - The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.
- Ftps
State string - State of FTP / FTPS service for this Windows Function App. Possible values include:
AllAllowed,FtpsOnlyandDisabled. Defaults toDisabled. - Health
Check intEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - Health
Check stringPath - The path to be checked for this Windows Function App health.
- Http2Enabled bool
- Specifies if the HTTP2 protocol should be enabled. Defaults to
false. - Ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Ip
Restrictions []WindowsFunction App Site Config Ip Restriction - One or more
ip_restrictionblocks as defined above. - Load
Balancing stringMode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - Managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - Minimum
Tls stringVersion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Pre
Warmed intInstance Count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- Remote
Debugging boolEnabled - Should Remote Debugging be enabled. Defaults to
false. - Remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - Runtime
Scale boolMonitoring Enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- Scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Scm
Ip []WindowsRestrictions Function App Site Config Scm Ip Restriction - One or more
scm_ip_restrictionblocks as defined above. - Scm
Minimum stringTls Version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Scm
Type string - The SCM Type in use by the Windows Function App.
- Scm
Use boolMain Ip Restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - Use32Bit
Worker bool - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - Vnet
Route boolAll Enabled - 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 stringVersion - The Windows FX Version string.
- Worker
Count int - The number of Workers for this Windows Function App.
- always
On Boolean If this Windows Function App is Always On enabled. Defaults to
false.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- api
Definition StringUrl - The URL of the API definition that describes this Windows Function App.
- api
Management StringApi Id - The ID of the API Management API for this Windows Function App.
- app
Command StringLine - The App command line to launch.
- app
Scale IntegerLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- app
Service WindowsLogs Function App Site Config App Service Logs - An
app_service_logsblock as defined above. - application
Insights StringConnection String - The Connection String for linking the Windows Function App to Application Insights.
- application
Insights StringKey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- application
Stack WindowsFunction App Site Config Application Stack An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- cors
Windows
Function App Site Config Cors - A
corsblock as defined above. - default
Documents List<String> - Specifies a list of Default Documents for the Windows Function App.
- detailed
Error BooleanLogging Enabled - Is detailed error logging enabled
- elastic
Instance IntegerMinimum - The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.
- ftps
State String - State of FTP / FTPS service for this Windows Function App. Possible values include:
AllAllowed,FtpsOnlyandDisabled. Defaults toDisabled. - health
Check IntegerEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check StringPath - The path to be checked for this Windows Function App health.
- http2Enabled Boolean
- Specifies if the HTTP2 protocol should be enabled. Defaults to
false. - ip
Restriction StringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions List<WindowsFunction App Site Config Ip Restriction> - One or more
ip_restrictionblocks as defined above. - load
Balancing StringMode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - managed
Pipeline StringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls StringVersion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - pre
Warmed IntegerInstance Count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- remote
Debugging BooleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging StringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - runtime
Scale BooleanMonitoring Enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- scm
Ip StringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip List<WindowsRestrictions Function App Site Config Scm Ip Restriction> - One or more
scm_ip_restrictionblocks as defined above. - scm
Minimum StringTls Version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - scm
Type String - The SCM Type in use by the Windows Function App.
- scm
Use BooleanMain Ip Restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - use32Bit
Worker Boolean - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - vnet
Route BooleanAll Enabled - Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false. - websockets
Enabled Boolean - Should Web Sockets be enabled. Defaults to
false. - windows
Fx StringVersion - The Windows FX Version string.
- worker
Count Integer - The number of Workers for this Windows Function App.
- always
On boolean If this Windows Function App is Always On enabled. Defaults to
false.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- api
Definition stringUrl - The URL of the API definition that describes this Windows Function App.
- api
Management stringApi Id - The ID of the API Management API for this Windows Function App.
- app
Command stringLine - The App command line to launch.
- app
Scale numberLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- app
Service WindowsLogs Function App Site Config App Service Logs - An
app_service_logsblock as defined above. - application
Insights stringConnection String - The Connection String for linking the Windows Function App to Application Insights.
- application
Insights stringKey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- application
Stack WindowsFunction App Site Config Application Stack An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- cors
Windows
Function App Site Config Cors - A
corsblock as defined above. - default
Documents string[] - Specifies a list of Default Documents for the Windows Function App.
- detailed
Error booleanLogging Enabled - Is detailed error logging enabled
- elastic
Instance numberMinimum - The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.
- ftps
State string - State of FTP / FTPS service for this Windows Function App. Possible values include:
AllAllowed,FtpsOnlyandDisabled. Defaults toDisabled. - health
Check numberEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check stringPath - The path to be checked for this Windows Function App health.
- http2Enabled boolean
- Specifies if the HTTP2 protocol should be enabled. Defaults to
false. - ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions WindowsFunction App Site Config Ip Restriction[] - One or more
ip_restrictionblocks as defined above. - load
Balancing stringMode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls stringVersion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - pre
Warmed numberInstance Count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- remote
Debugging booleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - runtime
Scale booleanMonitoring Enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip WindowsRestrictions Function App Site Config Scm Ip Restriction[] - One or more
scm_ip_restrictionblocks as defined above. - scm
Minimum stringTls Version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - scm
Type string - The SCM Type in use by the Windows Function App.
- scm
Use booleanMain Ip Restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - use32Bit
Worker boolean - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - vnet
Route booleanAll Enabled - Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false. - websockets
Enabled boolean - Should Web Sockets be enabled. Defaults to
false. - windows
Fx stringVersion - The Windows FX Version string.
- worker
Count 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.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- api_
definition_ strurl - The URL of the API definition that describes this Windows Function App.
- api_
management_ strapi_ id - The ID of the API Management API for this Windows Function App.
- app_
command_ strline - The App command line to launch.
- app_
scale_ intlimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- app_
service_ Windowslogs Function App Site Config App Service Logs - An
app_service_logsblock as defined above. - application_
insights_ strconnection_ string - The Connection String for linking the Windows Function App to Application Insights.
- application_
insights_ strkey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- application_
stack WindowsFunction App Site Config Application Stack An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- cors
Windows
Function App Site Config Cors - A
corsblock as defined above. - default_
documents Sequence[str] - Specifies a list of Default Documents for the Windows Function App.
- detailed_
error_ boollogging_ enabled - Is detailed error logging enabled
- elastic_
instance_ intminimum - 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,FtpsOnlyandDisabled. Defaults toDisabled. - health_
check_ inteviction_ time_ in_ min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health_
check_ strpath - 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_
restriction_ strdefault_ action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip_
restrictions Sequence[WindowsFunction App Site Config Ip Restriction] - One or more
ip_restrictionblocks as defined above. - load_
balancing_ strmode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - managed_
pipeline_ strmode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum_
tls_ strversion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - pre_
warmed_ intinstance_ count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- remote_
debugging_ boolenabled - Should Remote Debugging be enabled. Defaults to
false. - remote_
debugging_ strversion - The Remote Debugging Version. Currently only
VS2022is supported. - runtime_
scale_ boolmonitoring_ enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- scm_
ip_ strrestriction_ default_ action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm_
ip_ Sequence[Windowsrestrictions Function App Site Config Scm Ip Restriction] - One or more
scm_ip_restrictionblocks as defined above. - scm_
minimum_ strtls_ version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - scm_
type str - The SCM Type in use by the Windows Function App.
- scm_
use_ boolmain_ ip_ restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - use32_
bit_ boolworker - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - vnet_
route_ boolall_ enabled - 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_ strversion - The Windows FX Version string.
- worker_
count int - The number of Workers for this Windows Function App.
- always
On Boolean If this Windows Function App is Always On enabled. Defaults to
false.NOTE: when running in a Consumption or Premium Plan,
always_onfeature should be turned off. Please turn it off before upgrading the service plan from standard to premium.- api
Definition StringUrl - The URL of the API definition that describes this Windows Function App.
- api
Management StringApi Id - The ID of the API Management API for this Windows Function App.
- app
Command StringLine - The App command line to launch.
- app
Scale NumberLimit - The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
- app
Service Property MapLogs - An
app_service_logsblock as defined above. - application
Insights StringConnection String - The Connection String for linking the Windows Function App to Application Insights.
- application
Insights StringKey - The Instrumentation Key for connecting the Windows Function App to Application Insights.
- application
Stack Property Map An
application_stackblock as defined above.Note: If this is set, there must not be an application setting
FUNCTIONS_WORKER_RUNTIME.- cors Property Map
- A
corsblock as defined above. - default
Documents List<String> - Specifies a list of Default Documents for the Windows Function App.
- detailed
Error BooleanLogging Enabled - Is detailed error logging enabled
- elastic
Instance NumberMinimum - The number of minimum instances for this Windows Function App. Only affects apps on Elastic Premium plans.
- ftps
State String - State of FTP / FTPS service for this Windows Function App. Possible values include:
AllAllowed,FtpsOnlyandDisabled. Defaults toDisabled. - health
Check NumberEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check StringPath - The path to be checked for this Windows Function App health.
- http2Enabled Boolean
- Specifies if the HTTP2 protocol should be enabled. Defaults to
false. - ip
Restriction StringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions List<Property Map> - One or more
ip_restrictionblocks as defined above. - load
Balancing StringMode - The Site load balancing mode. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - managed
Pipeline StringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls StringVersion - Configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - pre
Warmed NumberInstance Count - The number of pre-warmed instances for this Windows Function App. Only affects apps on an Elastic Premium plan.
- remote
Debugging BooleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging StringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - runtime
Scale BooleanMonitoring Enabled Should Scale Monitoring of the Functions Runtime be enabled?
NOTE: Functions runtime scale monitoring can only be enabled for Elastic Premium Function Apps or Workflow Standard Logic Apps and requires a minimum prewarmed instance count of 1.
- scm
Ip StringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip List<Property Map>Restrictions - One or more
scm_ip_restrictionblocks as defined above. - scm
Minimum StringTls Version - Configures the minimum version of TLS required for SSL requests to the SCM site. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - scm
Type String - The SCM Type in use by the Windows Function App.
- scm
Use BooleanMain Ip Restriction - Should the Windows Function App
ip_restrictionconfiguration be used for the SCM also. - use32Bit
Worker Boolean - Should the Windows Function App use a 32-bit worker process. Defaults to
true. - vnet
Route BooleanAll Enabled - Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false. - websockets
Enabled Boolean - Should Web Sockets be enabled. Defaults to
false. - windows
Fx StringVersion - The Windows FX Version string.
- worker
Count Number - The number of Workers for this Windows Function App.
WindowsFunctionAppSiteConfigAppServiceLogs, WindowsFunctionAppSiteConfigAppServiceLogsArgs
- Disk
Quota intMb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - Retention
Period intDays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
- Disk
Quota intMb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - Retention
Period intDays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
- disk
Quota IntegerMb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - retention
Period IntegerDays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
- disk
Quota numberMb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - retention
Period numberDays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
- disk_
quota_ intmb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - retention_
period_ intdays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
- disk
Quota NumberMb - The amount of disk space to use for logs. Valid values are between
25and100. Defaults to35. - retention
Period NumberDays The retention period for logs in days. Valid values are between
0and99999.(never delete).NOTE: This block is not supported on Consumption plans.
WindowsFunctionAppSiteConfigApplicationStack, WindowsFunctionAppSiteConfigApplicationStackArgs
- Dotnet
Version string - The version of .NET to use. Possible values include
v3.0,v4.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - Java
Version string - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - Node
Version string - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - Powershell
Core stringVersion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- Use
Custom boolRuntime - Should the Windows Function App use a custom runtime?
- Use
Dotnet boolIsolated Runtime - Should the DotNet process use an isolated runtime. Defaults to
false.
- Dotnet
Version string - The version of .NET to use. Possible values include
v3.0,v4.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - Java
Version string - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - Node
Version string - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - Powershell
Core stringVersion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- Use
Custom boolRuntime - Should the Windows Function App use a custom runtime?
- Use
Dotnet boolIsolated Runtime - Should the DotNet process use an isolated runtime. Defaults to
false.
- dotnet
Version String - The version of .NET to use. Possible values include
v3.0,v4.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - java
Version String - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - node
Version String - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - powershell
Core StringVersion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- use
Custom BooleanRuntime - Should the Windows Function App use a custom runtime?
- use
Dotnet BooleanIsolated Runtime - Should the DotNet process use an isolated runtime. Defaults to
false.
- dotnet
Version string - The version of .NET to use. Possible values include
v3.0,v4.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - java
Version string - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - node
Version string - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - powershell
Core stringVersion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- use
Custom booleanRuntime - Should the Windows Function App use a custom runtime?
- use
Dotnet booleanIsolated Runtime - 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.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - java_
version str - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - node_
version str - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - powershell_
core_ strversion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- use_
custom_ boolruntime - Should the Windows Function App use a custom runtime?
- use_
dotnet_ boolisolated_ runtime - Should the DotNet process use an isolated runtime. Defaults to
false.
- dotnet
Version String - The version of .NET to use. Possible values include
v3.0,v4.0v6.0,v7.0,v8.0andv9.0. Defaults tov4.0. - java
Version String - The Version of Java to use. Supported versions include
1.8,11,17,21(In-Preview). - node
Version String - The version of Node to run. Possible values include
~12,~14,~16,~18~20and~22. - powershell
Core StringVersion The version of PowerShell Core to run. Possible values are
7,7.2, and7.4.NOTE: A value of
7will provide the latest stable version.7.2is in preview at the time of writing.- use
Custom BooleanRuntime - Should the Windows Function App use a custom runtime?
- use
Dotnet BooleanIsolated Runtime - Should the DotNet process use an isolated runtime. Defaults to
false.
WindowsFunctionAppSiteConfigCors, WindowsFunctionAppSiteConfigCorsArgs
- Allowed
Origins List<string> - 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.
- Allowed
Origins []string - 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.
- allowed
Origins List<String> - Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials Boolean - Are credentials allowed in CORS requests? Defaults to
false.
- allowed
Origins string[] - Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials 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.
- allowed
Origins List<String> - Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials Boolean - Are credentials allowed in CORS requests? Defaults to
false.
WindowsFunctionAppSiteConfigIpRestriction, WindowsFunctionAppSiteConfigIpRestrictionArgs
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Function App Site Config Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Function App Site Config Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description string
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action str
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description str
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip_
address str - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers Property Map
- A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
WindowsFunctionAppSiteConfigIpRestrictionHeaders, WindowsFunctionAppSiteConfigIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - XForwarded
Fors List<string> - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts List<string> - Specifies a list of Hosts for which matching should be applied.
- XAzure
Fdids []string - Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - XForwarded
Fors []string - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts []string - Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded List<String>Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts - Specifies a list of Hosts for which matching should be applied.
- x
Azure string[]Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd stringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded string[]Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded string[]Hosts - Specifies a list of Hosts for which matching should be applied.
- x_
azure_ Sequence[str]fdids - Specifies a list of Azure Front Door IDs.
- x_
fd_ strhealth_ probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x_
forwarded_ Sequence[str]fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x_
forwarded_ Sequence[str]hosts - Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded List<String>Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts - Specifies a list of Hosts for which matching should be applied.
WindowsFunctionAppSiteConfigScmIpRestriction, WindowsFunctionAppSiteConfigScmIpRestrictionArgs
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Function App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Function App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description string
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action str
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description str
- The Description of this IP Restriction.
- headers
Windows
Function App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip_
address str - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers Property Map
- A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.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 to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
WindowsFunctionAppSiteConfigScmIpRestrictionHeaders, WindowsFunctionAppSiteConfigScmIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - XForwarded
Fors List<string> - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts List<string> - Specifies a list of Hosts for which matching should be applied.
- XAzure
Fdids []string - Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - XForwarded
Fors []string - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts []string - Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded List<String>Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts - Specifies a list of Hosts for which matching should be applied.
- x
Azure string[]Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd stringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded string[]Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded string[]Hosts - Specifies a list of Hosts for which matching should be applied.
- x_
azure_ Sequence[str]fdids - Specifies a list of Azure Front Door IDs.
- x_
fd_ strhealth_ probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x_
forwarded_ Sequence[str]fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x_
forwarded_ Sequence[str]hosts - Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids - Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe - Specifies if a Front Door Health Probe should be expected. The only possible value is
1. - x
Forwarded List<String>Fors - Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts - Specifies a list of Hosts for which matching should be applied.
WindowsFunctionAppSiteCredential, WindowsFunctionAppSiteCredentialArgs
- 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, WindowsFunctionAppStickySettingsArgs
- App
Setting List<string>Names - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - Connection
String List<string>Names - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
- App
Setting []stringNames - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - Connection
String []stringNames - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
- app
Setting List<String>Names - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - connection
String List<String>Names - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
- app
Setting string[]Names - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - connection
String string[]Names - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
- app_
setting_ Sequence[str]names - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - connection_
string_ Sequence[str]names - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
- app
Setting List<String>Names - A list of
app_settingnames that the Windows Function App will not swap between Slots when a swap operation is triggered. - connection
String List<String>Names - A list of
connection_stringnames that the Windows Function App will not swap between Slots when a swap operation is triggered.
WindowsFunctionAppStorageAccount, WindowsFunctionAppStorageAccountArgs
- Access
Key string - The Access key for the storage account.
- Account
Name string - The Name of the Storage Account.
- Name string
- The name which should be used for this Storage Account.
- string
- The Name of the File Share or Container Name for Blob storage.
- Type string
- The Azure Storage Type. Possible values include
AzureFiles. - Mount
Path string - The path at which to mount the storage share.
- Access
Key string - The Access key for the storage account.
- Account
Name string - The Name of the Storage Account.
- Name string
- The name which should be used for this Storage Account.
- string
- The Name of the File Share or Container Name for Blob storage.
- Type string
- The Azure Storage Type. Possible values include
AzureFiles. - Mount
Path string - The path at which to mount the storage share.
- access
Key String - The Access key for the storage account.
- account
Name String - The Name of the Storage Account.
- name String
- The name which should be used for this Storage Account.
- String
- The Name of the File Share or Container Name for Blob storage.
- type String
- The Azure Storage Type. Possible values include
AzureFiles. - mount
Path String - The path at which to mount the storage share.
- access
Key string - The Access key for the storage account.
- account
Name string - The Name of the Storage Account.
- name string
- The name which should be used for this Storage Account.
- string
- The Name of the File Share or Container Name for Blob storage.
- type string
- The Azure Storage Type. Possible values include
AzureFiles. - mount
Path 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.
- 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.
- access
Key String - The Access key for the storage account.
- account
Name String - The Name of the Storage Account.
- name String
- The name which should be used for this Storage Account.
- String
- The Name of the File Share or Container Name for Blob storage.
- type String
- The Azure Storage Type. Possible values include
AzureFiles. - mount
Path 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.